注釈

この章は機能を説明している参考文献に過ぎません．mlabの紹介と mlab の機能との対話して組み立て方法については mlab: 3Dプロット用のPythonスクリプト の章を参照してください．

サンプルの実行方法については， mlabスクリプトの実行 のセクションを参照してください．

Tools

add_dataset

mayavi.tools.pipeline.add_dataset(dataset, name='', **kwargs)

データセットオブジェクトをMayaviパイプラインに追加します．

パラメータ

Dataset:

tvtk/vtk dataset/tvtk/VTK Algorithm，またはMayaviソース．Mayaviパイプラインに追加されたデータセット

Figure:

図形ID番号または文字列，NoneまたはFalse，オプション．

figure キーワード引数を指定しない場合，データは現在の図形に追加されます(必要に応じて新しい図形を作成します)．

figure キーワード引数を指定する場合，データセットを追加する図形の番号を指定するか，Noneを指定します．この場合，データはパイプラインに追加されません．

figureがFalseの場合，NULLエンジンが作成されます．このヌル・エンジンは図形を作成せず，主にテンスティングやVTKアルゴリズムを視覚化せずに使用する場合に便利です．

戻り値

対応するMayaviソースが返されます．

add_module_manager

mayavi.tools.pipeline.add_module_manager(object)

特定のオブジェクトの色と凡例バーを制御するモジュールマネージャを追加します．

get_vtk_src

mayavi.tools.pipeline.get_vtk_src(mayavi_object, stop_at_filter=True)

Mayaviパイプラインをアップして，指定したオブジェクトのデータソースを検索します．

パラメータ

Object:

任意のMayaviビジュアル化オブジェクト

Stop_at_filter:

オプションのbooleanフラグ:Trueの場合，パイプラインで検出されたデータを公開する最初のオブジェクトが返されます．Falseの場合は，リンク元のみが返されます．

戻り値

Sources:

vtkデータソースのリスト(Mayaviソースオブジェクトではなく，vtkデータソース)．

注記

この関数は，Mayaviパイプラインをトラバースします．したがって，入力オブジェクト 'mayavi_object' は既にパイプラインに追加されるべきです．

set_extent

mayavi.tools.pipeline.set_extent(module, extents)

指定されたモジュールの物理エクステントの設定を試行します．

エクステントは(xmin，xmax，ymin，ymax，zmin，zmax)として指定されます．このモジュールにはアクターがないため，これはイメージプレーンウィジェットでは機能しません．

モジュールでこの関数を使用すると，同じデータ・ソースに適用される他のモジュールは同じスケールを共有しないことに注意してください．したがって，たとえば，アウトライン・モジュールでは，エクステントを変更したアクターのアウトラインは考慮されません．これを機能させるには，同じ "extents" パラメータを渡す必要があります．ウィナーをご覧ください．これは，この機能を頻繁に使用するための例です．

注記

この関数は，Outline，Axes，ImagePlaneWidgetなどの特定のモジュールでは機能しません．OutlineとAxesには， mlab.pipeline.outline および mlab.pipeline.axes のextentキーワード引数を使用します．

traverse

mayavi.tools.pipeline.traverse(node)

ノードの子属性にアクセスするツリーをトラバースするジェネレータ．

例

パイプライン内のすべてのオブジェクトの名前を出力する簡単な例を次に示します．

for obj in mlab.pipeline.traverse(mlab.gcf()):
    print(obj.name)