モジュールとフィルタ

Mayaviモジュールまたはフィルタごとに,対応する mlab.pipeline があります.新しいモジュールまたはフィルタが追加されるソースを入力引数として取り,作成されたモジュールオブジェクトを返すパイプラインのファクトリ関数.関数の名前はモジュールの名前に対応しますが,大文字と小文字が交互に使用されるのではなく,単語がアンダースコア _ で区切られます.

入力オブジェクトは,データソース(MayaviデータソースまたはVTKデータセット)である場合,図に存在している必要はなく,必要に応じて自動的に追加されます.

ファクトリ関数は,パイプラインに追加されたオブジェクトの一部のプロパティを制御するキーワード引数を取ります.

たとえば, ScalarCutPlane モジュールは次の関数で追加できます.

mayavi.tools.modules.scalar_cut_plane(*args, **kwargs)

ScalarCutPlane mayaviモジュールを指定のデータソース(Mayaviソース,またはVTKデータセット)に適用します.

キーワード引数:

color:vtkオブジェクトの色.カラーマップを指定した場合,カラーマップを上書きします.これは0から1の範囲のfloatの例えば (1, 1, 1) として指定されます.
colormap:使用するカラーマップのタイプ.
extent:[xmin, xmax, ymin, ymax, zmin, zmax] デフォルトはx,y,z配列範囲です.作成したオブジェクトの範囲を変更します.
figure:SceneまたはNoneでなければなりません.
line_width:使用されている場合,線の幅.floatでなければなりません.デフォルトは2.0
name:作成されたvtkオブジェクトの名前.
opacity:vtkオブジェクトの全体的な不透明度.floatでなければなりません.デフォルトは1.0
plane_orientation:
 平面の方向は有効な値でなければなりません.デフォルトは x_axes
reset_zoom:シーンに新しく追加されたデータに合わせてズームをリセットします.既定値はTrueです.
transparent:アクターの不透明度をスカラーに依存させます.
view_controls:切断面のコントロールを表示するかどうかを指定します.ブール値でなければなりません.デフォルトはTrue
vmax:vmaxを使用してカラーマップをスケールします.なしの場合,データの最大値が使用されます.
vmin:vminを使用してカラーマップをスケールします.なしの場合,データの最小値が使用されます.

リストが長いので,ここではモジュールやフィルタを追加するためのファクトリ関数を列挙しません.使用できるキーワード引数については,docstringを参照してください.