pyvista.Plotter.add_volume_clip_plane#

Plotter.add_volume_clip_plane(volume, normal='x', invert=False, widget_color=None, value=0.0, assign_to_axis=None, tubing=False, origin_translation=True, outline_translation=False, implicit=True, normal_rotation=True, interaction_event='end', origin=None, **kwargs)[ソース]#

プレインウィジェットを使用してボリュームをクリップします.

パラメータ:
volumepyvista.plotting.volume.Volume or pyvista.ImageData or pyvista.RectilinearGrid

pyvista.ImageData または pyvista.RectilinearGrid 型の新しいデータセット,または Plotter.add_volume()pyvista.plotting.volume.Volume からの戻り値です.

normalstr or tuple(float), optional

平面の開始法線ベクトル.

invertbool, optional

クリップをフリップ/反転するかどうかを示すフラグ.

widget_colorColorLike, optional

文字列,RGBリスト,または16進カラー文字列.

valuefloat, optional

法線方向に沿ってクリップ値を設定します.デフォルト値は0.0です.

assign_to_axispython:str または python:int, optional

平面の法線を指定された軸と平行になるように割り当てます.オプションは (0, 'x'), (1, 'y'),または (2, 'z') です.

tubingbool, optional

インプリシット平面ウィジェットを使用する場合,平面の境界の周囲にチューブを表示するかどうかを制御します.

origin_translationbool, optional

False の場合,プレーンウィジェットは原点によって移動できず,指定された原点に厳密に配置される.インプリシット平面を使用する場合にのみ有効です.

outline_translationbool, optional

False の場合,ボックスウィジェットは変換できず,与えられた境界に厳密に配置されます.

implicitbool, optional

True の場合は vtkImplicitPlaneWidget が使用され, False の場合は vtkPlaneWidget が使用されます.

normal_rotationbool, optional

法線ベクトル矢印の不透明度を0に設定して,実質的に無効にします.これにより,ユーザは法線を回転できなくなります. assign_to_axis が設定されている場合,これは強制的に False になります.

interaction_eventvtk.vtkCommand.EventIds, optional

コールバックのトリガーに使用するVTKインタラクションイベントです.

origintuple(float), optional

平面の中心の開始座標.

**kwargsdict, optional

すべての追加キーワード引数は Plotter.add_volume() に渡され,ボリュームの表示方法を制御します. volumepyvista.ImageDatapyvista.RectilinearGrid のどちらかの場合のみ適用できます.

戻り値:
vtk.vtkPlaneWidget or vtk.vtkImplicitPlaneWidget

implicit の値に依存するVTK平面ウィジェット.