pyvista.CompositePolyDataMapper.set_scalars

pyvista.CompositePolyDataMapper.set_scalars#

CompositePolyDataMapper.set_scalars(
scalars_name,
preference,
component,
annotations,
rgb,
scalar_bar_args,
n_colors,
nan_color,
above_color,
below_color,
clim,
cmap,
flip_scalars,
log_scale,
)[ソース]#

マッパーのスカラーを設定します．

パラメータ:
scalars_namestr

データセットに含まれるスカラーの名前．少なくともブロックの中にすでに存在していなければならない．

preferencestr

各ブロックに， block.n_points == block.n_cells でスカラを設定した場合，このパラメータはスカラがどのようにメッシュにマッピングされるかを設定します． デフォルトの 'point' では，スカラーはメッシュのポイントに関連付けられます． これは 'point' または 'cell' のいずれかです．

componentint

プロットするベクトル値スカラーのコンポーネントを設定します．指定されている場合は負でない必要があります． None の場合，ベクトルの大きさがプロットされます．

annotationsdict

注釈の辞書を渡します．キーはスカラー範囲のfloat値で，スカラーバーに注釈を付けます．値は文字列注釈です．

rgbbool

もし scalars_name が2次元配列に対応する場合，それらの値をRGB(A)カラーでプロットします．

scalar_bar_argsdict

スカラーバーをシーンに追加するときに渡すキーワード引数のディクショナリ．オプションについては pyvista.Plotter.add_scalar_bar() を参照してください．

n_colorsint

スカラーを表示する際に使用する色数．

nan_colorColorLike

プロットされたスカラー配列のすべての NaN 値に使用する色．

above_colorColorLike

スカラー範囲 ( clim ) 未満の値の単色．これにより，スカラーバー above_label が自動的に 'above' に設定されます．

below_colorColorLike

スカラー範囲 ( clim ) 未満の値の単色．これにより，スカラーバー below_label が自動的に 'below' に設定されます．

climSequence

スカラーのカラーバーの範囲．デフォルトはスカラー配列の最小値と最大値です．例: [-1, 2] ．rng もこの別名として認められています．

cmapstr | list | pyvista.LookupTable

scalars をマップする際のMatplotlibカラーマップの名前．利用可能なMatplotlibカラーマップを参照してください． scalars を表示する場合にのみ適用されます． colormap は，このエイリアスとしても使用できます． colorcet または cmocean がインストールされている場合は，それらのカラーマップを名前で指定できます．

また，色のリストを指定して，既存のカラーマップをカスタムカラーマップで上書きすることもできます．例えば，3色のカラーマップを作成するには， ['green', 'red', 'blue'] ．

このパラメータには pyvista.LookupTable を指定することもできます．このパラメータが設定されている場合， n_colors のようなカラーマップを制御するすべてのパラメータは無視されます．

flip_scalarsbool

cmapの方向を反転します．ほとんどのカラーマップでは， *_r サフィックスも同様にこれを行うことができます．

log_scalebool

データを色にマッピングするときは，ログスケールを使用します．0未満のスカラーは，表現可能な最小の正のfloatにマップされます．

戻り値:
dict

スカラーバー引数の辞書．

目次