pyvista.DataSetMapper.set_scalars

DataSetMapper.set_scalars(scalars, scalars_name, n_colors=256, scalar_bar_args=None, rgb=None, component=None, preference='point', custom_opac=False, annotations=None, log_scale=False, nan_color=None, above_color=None, below_color=None, cmap=None, flip_scalars=False, opacity=None, categories=False, clim=None)

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

パラメータ:

scalarsnumpy.ndarray

マッパーに割り当てるスカラーの配列．

scalars_namestr

この配列の名前が存在する場合は，scalars は無視されます．そうでない場合は，既存のデータセットにスカラーが追加され， このパラメータがスカラーを割り当てる名前となります．

n_colorsint, default: 256

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

scalar_bar_argsdict, optional

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

rgbbool, default: False

スカラーとして2次元の配列が渡された場合には，それらの値をRGB(A)カラーとしてプロットします． rgba という別名もあります． Opacity (A) はオプションです． もしも "_rgba" で終わるスカラー配列が渡された場合，デフォルトでは True になります． これは，このパラメータに False を設定することで上書きすることができます．

componentint, optional

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

preferencestr, default: 'Point'

dataset.n_points == dataset.n_cells でスカラを設定した場合，このパラメータはスカラがどのようにメッシュにマッピングされるかを設定します．これは 'point' または 'cell' のいずれかです．

custom_opacbool, default: False

カスタム不透明度を使用します．

annotationsdict, optional

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

log_scalebool, default: False

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

nan_colorpyvista.ColorLike, optional

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

above_colorpyvista.ColorLike, optional

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

below_colorpyvista.ColorLike, optional

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

cmapstr, list, or pyvista.LookupTable

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

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

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

flip_scalarsbool, default: False

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

opacitystr or numpy.ndarray, optional

スカラー配列の不透明度マッピング．文字列を指定して，スカラー範囲を定義済みの不透明度転送関数(オプションには， 'linear' ， 'linear_r'， 'geom' ， 'geom_r' があります．)にマッピングすることもできます．あるいは，長さが n_colors 以下の配列であるカスタムメイドの伝達関数を渡すこともできます．

categoriesbool, default: False

True に設定すると，スカラー配列内の一意の値の数が n_colors 引数として使用されます．

climSequence, optional

スカラーのカラーバーの範囲．デフォルトはスカラー配列の最小値と最大値です． (-1, 2) ．