pyvista.Plotter.add_composite

Plotter.add_composite(dataset, color=None, style=None, scalars=None, clim=None, show_edges=None, edge_color=None, point_size=None, line_width=None, opacity=1.0, flip_scalars=False, lighting=None, n_colors=256, interpolate_before_map=True, cmap=None, label=None, reset_camera=None, scalar_bar_args=None, show_scalar_bar=None, multi_colors=False, name=None, render_points_as_spheres=None, render_lines_as_tubes=None, smooth_shading=None, split_sharp_edges=None, ambient=None, diffuse=None, specular=None, specular_power=None, nan_color=None, nan_opacity=1.0, culling=None, rgb=None, below_color=None, above_color=None, annotations=None, pickable=True, preference='point', log_scale=False, pbr=None, metallic=None, roughness=None, render=True, component=None, color_missing_with_nan=False, copy_mesh=False, show_vertices=None, edge_opacity=None, **kwargs)

プロッターにコンポジットデータセットを追加します．

パラメータ:

datasetpyvista.MultiBlock

pyvista.MultiBlock データセットです．

colorColorLike, default: pyvista.plotting.themes.Theme.color

メッシュ全体を単一のソリッドカラーにします．文字列，RGBリスト，または16進カラー文字列．例: color='white' ， color='w' ， color=[1.0, 1.0, 1.0] ， color='#FFFFFF' ．スカラーが指定されている場合，色は上書きされます．合成データセットの各要素を個別に着色するには，各サブデータセットに対して add_mesh を繰り返し呼び出す必要があります．

stylestr, default: 'wireframe'

メッシュの表示スタイル． style='surface' ，style='wireframe' ， style='points' のいずれかです．デフォルトは 'surface' です． 'wireframe' は外部ジオメトリのワイヤフレームのみを表示することに注意してください．

scalarsstr, optional

データセットのポイントやセルに "色をつける" ために使用するスカラー．コンポジットデータセットに存在する配列の文字列名のみを受け付けます．

climsequence[float], optional

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

show_edgesbool, default: pyvista.global_theme.show_edges

メッシュのエッジを表示します．ワイヤフレーム表示には適用されません．

edge_colorColorLike, default: pyvista.global_theme.edge_color

show_edges=True の場合にエッジに適用される単色です．文字列，RGBリスト，または16進カラー文字列．

デフォルトは pyvista.global_theme.edge_color です．

point_sizefloat, default: 5.0

プロットされたデータセット内の任意のポイントのポイントサイズ． style='points' の場合にも適用できます．デフォルト 5.0 ．

line_widthfloat, optional

線の太さ．ワイヤフレーム表示とサーフェス表示にのみ有効です．

opacityfloat, default: 1.0

メッシュの不透明度．メッシュの不透明度をグローバルに適用し，どこでも一様に適用される単一の浮動小数点値です． - 0と1の間でなければなりません．

flip_scalarsbool, default: False

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

lightingbool, default: True

ビュー方向の照明を有効または無効にします．

n_colorsint, default: 256

スカラーを表示するときに使用するカラーの数．スカラーバーにもこの数の色があります．

interpolate_before_mapbool, default: True

有効にすると，より滑らかなスカラー表示になります． False の場合，OpenGLはマップされたカラーを補間し，カラーマップに存在しないカラーを表示することがあります．

cmapstr | list, | pyvista.LookupTable, default: pyvista.plotting.themes.Theme.cmap

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

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

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

labelstr, optional

pyvista.Plotter.add_legend() でシーンに凡例を追加するときに使用する文字列ラベル．

reset_camerabool, optional

このメッシュをシーンに追加した後，カメラをリセットします．デフォルトの設定は None で，このプロッタがすでに表示されている場合のみ，カメラがリセットされます． False の場合は，プロッターの状態に関係なく，カメラはリセットされません． True の場合，カメラは常にリセットされます．

scalar_bar_argsdict, optional

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

show_scalar_barbool

False の場合，スカラーバーはシーンに追加されません． rgba=True を指定しない場合，デフォルトは True です．

multi_colorsbool | str | cycler.Cycler | sequence[ColorLike], default: False

カスタム cycler を使って，各ブロックを無地で着色します．

もし True なら，デフォルトの 'matplotlib' カラーサイクラーが使用されます．

カスタムカラーサイクラーの使用法については set_color_cycler を参照．

namestr, optional

簡単に更新できるように，追加したメッシュ/アクターの名前．この名前のアクターがレンダリングウィンドウに既に存在する場合は，新しいアクターに置き換えられます．

render_points_as_spheresbool, default: False

点をドットではなく球としてレンダリングします．

render_lines_as_tubesbool, default: False

線分をフラットな線分ではなく太いチューブとして表示します． line_width で幅を制御します．

smooth_shadingbool, default: :attr`pyvista.plotting.themes.Theme.smooth_shading`

Phongシェーディングアルゴリズムを使用した True 時にスムーズシェーディングを有効にします． False 時にはフラットシェーディングを使用します． pbr=True 時に自動的に有効になります． シェーディングのタイプ を参照してください．

split_sharp_edgesbool, default: False

スムーズシェーディングでプロットする際に，30度を超えるシャープエッジを分割します． オプションのキーワード引数 feature_angle で角度を制御します． グローバルテーマやプロッタテーマで上書きされない限りはデフォルトではこれは False です． これを有効にすると，プロッタ内に入力メッシュのコピーが作成されることに注意してください． シェーディングのタイプ を参照してください．

ambientfloat, default: 0.0

照明が有効な場合，これは，ビューアから放射された光源に向けられていないときにアクターに到達する0から1の範囲（デフォルトは0.0）の光の量です．

diffusefloat, default: 1.0

拡散照明係数．

specularfloat, default: 0.0

鏡面反射光の係数．

specular_powerfloat, default: 1.0

鏡面パワー．0.0から128.0．

nan_colorColorLike, default: pyvista.plotting.themes.Theme.nan_color

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

nan_opacityfloat, default: 1.0

NaN 値の不透明度．0から1の間でなければなりません．

cullingstr, bool, default: False

選択された面はレンダリングされません．これは，高密度のサーフェイスメッシュ，特にエッジが表示されている場合に便利ですが，フラットメッシュが部分的に表示されることがあります．以下のいずれか1つです:

• True - バックフェイスカリングを有効にします．

• "b" - バックフェースカリングを有効にします．

• "back" - バックフェースカリングを有効にします．

• "backface" - バックフェースカリングを有効にします．

• "f" - フロントフェイスカリングを有効にします．

• "front" - フロントフェイスカリングを有効にします．

• "frontface" - フロントフェイスカリングを有効にします．

• False - バックフェイスおよびフロントフェイスのカリングを無効にします．

rgbbool, default: False

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

below_colorColorLike, optional

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

above_colorColorLike, optional

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

annotationsdict, optional

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

pickablebool, default: True

このアクターを選択可能にするかどうかを設定します．

preferencestr, default: 'point'

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

log_scalebool, default: False

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

pbrbool, default: False

メッシュが PolyData の場合，Physics Based Rendering(PBR)を有効にします． color 引数を使用してベースカラーを設定します．

metallicfloat, default: 0.0

通常，この値は実際のマテリアルでは0または1ですが，中間の値は有効です．このパラメータはPBR補間でのみ使用されます．

roughnessfloat, default: 0.5

この値は，0(光沢)と1(粗さ)の間である必要があります．光沢のあるマテリアルには，反射と高い鏡面反射部分があります．このパラメータは，PBR補間でのみ使用されます．

renderbool, default: True

True のときに強制的にレンダーします．

componentint, optional

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

color_missing_with_nanbool, default: False

欠損値には nan_color で色をつけます．これは，合成データセットのすべてのブロックが，指定した scalars を持つわけではない場合に有効です．

copy_meshbool, default: False

True の場合，プロッタに追加する前にメッシュのコピーが作成されます．これは例えば，同じメッシュを複数回プロッタに追加して，異なるスカラーを表示させたい場合に便利です． copy_mesh を False に設定すると，プロッタに追加した後にメッシュを更新し，例えばアクティブなスカラーを変更したり，インタラクティブウィジェットを介してレンダリングさせたい場合に必要とされます．

show_verticesbool, optional

style が 'points' でない場合，表面の外側の頂点をレンダリングします．以下のオプションのキーワード引数を使用すると，頂点のスタイルを制御することができます．

• vertex_color - 頂点の色

• vertex_style - スタイルを 'points_gaussian' に変更します．

• vertex_opacity - 頂点の不透明度を制御します．

edge_opacityfloat, optional

メッシュのエッジの不透明度．メッシュのエッジの不透明度をグローバルに適用し，どこでも一様に適用される単一の浮動小数点値です． - 0と1の間でなければなりません．

注釈

edge_opacity は SetEdgeOpacity を基礎メソッドとして使用し，VTKバージョン9.3以降を必要とします．もし SetEdgeOpacity が利用できない場合， edge_opacity` は 1 に設定されます．

**kwargsdict, optional

オプションのキーワード引数．

戻り値:

pyvista.Actor

合成されたデータセットのアクター．

pyvista.CompositePolyDataMapper

複合 PolyData マッパー．

例

球体と立方体をマルチブロックデータセットとしてプロッターに追加し，ブロックの表示と色を変更します．

インデックス 1 と 2 は，複合データセットの個々のブロックにアクセスするために使用されることに注意してください．これは， pyvista.MultiBlock が "tree" のルートノードであり，インデックス 0 になっているためです．これにより，個々のブロックや，ネストした複数のコンポジットデータセットの場合には，コンポジットデータセットそのものにアクセスすることができます．

>>> import pyvista as pv
>>> dataset = pv.MultiBlock(
...     [pv.Cube(), pv.Sphere(center=(0, 0, 1))]
... )
>>> pl = pv.Plotter()
>>> actor, mapper = pl.add_composite(dataset)
>>> mapper.block_attr[1].color = 'b'
>>> mapper.block_attr[1].opacity = 0.5
>>> mapper.block_attr[2].color = 'r'
>>> pl.show()