注釈

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

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

その他の関数

animate

mayavi.mlab.animate(func=None, delay=500, ui=True, support_movie=True)

アニメーションを実行するジェネレータをアニメートする便利なデコレータ.

delay パラメータは,デコレートされた関数の呼び出し間の遅延(ミリ秒単位)を指定します.uiがTrueの場合は,アニメータ用の単純なUIも表示されます.decoration関数は使用されているAnimatorインスタンスを返し,ユーザーは Stop メソッドを呼び出してアニメーションを停止できます. support_movie パラメータは既定でTrueに設定されているため,デコレータを使用して簡単にムービーを記録できます.オフにすると,アニメーションのムービーを記録できません.

通常の関数をデコレートすると, TypeError が発生します.

パラメータ

delay:int 関数の呼び出し間隔をミリ秒単位で指定します.
ui:アニメーションを制御するUIを提供するかどうかを指定します.
support_movie:アニメーションがムービーの記録をサポートするかどうかを指定します.

戻り値

デコレート関数は Animator インスタンスを返します.

Animatorクラスのドキュメントで提供されている例を次に示します.

>>> from mayavi import mlab
>>> @mlab.animate
... def anim():
...     f = mlab.gcf()
...     while 1:
...         f.scene.camera.azimuth(10)
...         f.scene.render()
...         yield
...
>>> a = anim() # Starts the animation.

より専門的に使用するために,引数をデコレータに渡すことができます.

>>> from mayavi import mlab
>>> @mlab.animate(delay=500, ui=False)
... def anim():
...     f = mlab.gcf()
...     while 1:
...         f.scene.camera.azimuth(10)
...         f.scene.render()
...         yield
...
>>> a = anim() # Starts the animation without a UI.

注記

mlab 関数呼び出しによってプロットされたデータを変更したい場合は,セクション : データのアニメート を参照してください.

axes

mayavi.mlab.axes(*args, **kwargs)

現在の(または与えられた)オブジェクトの軸を作成します.

キーワード引数:

color:vtkオブジェクトの色.カラーマップを指定した場合,カラーマップを上書きします.これは0から1の範囲のfloatのトリプレット (1, 1, 1) として指定されます.
extent:[xmin, xmax, ymin, ymax, zmin, zmax] 既定値はオブジェクトの範囲です.
figure:SceneまたはNoneでなければなりません.
line_width:使用されている場合,線の幅.floatでなければなりません.デフォルトは2.0
name:作成されたvtkオブジェクトの名前.
nb_labels:各方向に沿ったラベルの数有効な値でなければなりません.デフォルトは2
opacity:vtkオブジェクトの全体的な不透明度.floatでなければなりません.デフォルトは1.0
ranges:[xmin, xmax, ymin, ymax, zmin, zmax] 軸に表示されるラベルの範囲.既定値はオブジェクトの範囲です.
x_axis_visibility:
 x軸が表示されているかどうか(ブーリアン)
xlabel:x軸のラベル
y_axis_visibility:
 y軸が表示されているかどうか(ブーリアン)
ylabel:y軸のラベル
z_axis_visibility:
 Z軸が表示されているかどうか(ブーリアン)
zlabel:Z軸のラベル

get_engine

mayavi.mlab.get_engine(self)

オプションに従ってエンジンを返します.

init_notebook

mayavi.mlab.init_notebook(backend='ipy', width=None, height=None, local=True)

Jupyterノートブックに適したバックエンドを初期化します.

パラメータ

backend :str: ('png', 'x3d', 'ipy') のうちの1つ width :int: 要素の高さの推奨デフォルト幅 height :int: 要素部分の推奨デフォルト高さ.オンラインバージョンではなく :bool: x3domのローカルコピーを使用します.

orientation_axes

mayavi.mlab.orientation_axes(*args, **kwargs)

OrientationAxes mayaviモジュールを指定のVTKデータオブジェクトに適用します.

キーワード引数:

color:vtkオブジェクトの色.カラーマップを指定した場合,カラーマップを上書きします.これは0から1の範囲のfloatのトリプレット (1, 1, 1) として指定されます.
figure:SceneまたはNoneでなければなりません.
line_width:使用されている場合,線の幅.floatでなければなりません.デフォルトは2.0
name:作成されたvtkオブジェクトの名前.
opacity:vtkオブジェクトの全体的な不透明度.floatでなければなりません.デフォルトは1.0
xlabel:x軸のラベル
ylabel:y軸のラベル
zlabel:Z軸のラベル

outline

mayavi.mlab.outline(*args, **kwargs)

現在の(または与えられた)オブジェクトのアウトラインを作成します.

キーワード引数:

color:vtkオブジェクトの色.カラーマップを指定した場合,カラーマップを上書きします.これは0から1の範囲のfloatのトリプレット (1, 1, 1) として指定されます.
extent:[xmin, xmax, ymin, ymax, zmin, zmax] 既定値はオブジェクトの範囲です.
figure:SceneまたはNoneでなければなりません.
line_width:使用されている場合,線の幅.floatでなければなりません.デフォルトは2.0
name:作成されたvtkオブジェクトの名前.
opacity:vtkオブジェクトの全体的な不透明度.floatでなければなりません.デフォルトは1.0

process_ui_events

mayavi.mlab.process_ui_events()

GUIイベントを処理します.

この関数は関数を抽象化するだけなので,UIが実行されていないときは何も行われません.

set_engine

mayavi.mlab.set_engine(self, engine)

mlabエンジンを設定します.

show

mayavi.mlab.show(func=None, stop=False)

図との対話を開始します.

デフォルトでは,この関数は単にGUIを作成し,必要に応じてイベントループを開始します.

デコレータとして使用する場合は,UIを必要とする関数のデコレートに使用できます.GUIイベントループがすでに実行されている場合は,関数が実行されます.そうでない場合は,イベントループが開始され,ツールキットのイベントループで関数が実行されます.UIの選択は ETSConfig.toolkit で行います.

引数stopをTrueに設定すると,イベントループを停止できるUIがポップアップ表示されます.その後, show を呼び出すと,イベントループが再開されます.

パラメータ

stop:イベントループを停止できるUIダイアログボックスを表示するかどうかを指定するブール値.

showの使用例を簡単に示します.

>>> from mayavi import mlab
>>> mlab.test_contour3d()
>>> mlab.show()

次のような簡単なポップアップUIを使用して,対話を停止できます.

>>> mlab.test_contour3d()
>>> mlab.show(stop=True)

デコレータは次のように使用できます.

>>> @mlab.show
... def do():
...    mlab.test_contour3d()
...
>>> do()

デコレータにはstop引数を渡すこともできます.

>>> @mlab.show(stop=True)
... def do():
...    mlab.test_contour3d()
...
>>> do()

show_engine

mayavi.mlab.show_engine()

この関数は推奨されていません.show_pipelineを使用してください.

show_pipeline

mayavi.mlab.show_pipeline(self, engine=None, rich_view=True)

mayaviパイプラインのダイアログを表示します.このダイアログボックスでは,シーン上のさまざまなオブジェクトのプロパティをグラフィック編集できます.

start_recording

mayavi.mlab.start_recording(ui=True)

スクリプトの自動記録を開始します. ui パラメータが True であれば,ユーザインタフェースを備えたレコーダが作成され,そうでなければ,UIを備えないvanillaレコーダが作成されます.

戻り値
Recorder インスタンスが作成されました.

stop_recording

mayavi.mlab.stop_recording(file=None)

スクリプトの自動記録を停止します.

パラメータ

file:開いているファイル,ファイル名または NoneNone の場合,何も保存されません.

text

mayavi.mlab.text(*args, **kwargs)

図にテキストを追加します.

関数シグネチャ

text(x, y, text, ...)

x,yはテキストの原点の位置です.zキーワード引数を指定しない場合,xとyは図形の2次元投影であり,[0,1]に属します.zキーワード引数を指定した場合,テキストは3次元内の図形座標に配置されます.

キーワード引数:

color:vtkオブジェクトの色.カラーマップを指定した場合,カラーマップを上書きします.これは0から1の範囲のfloatのトリプレット (1, 1, 1) として指定されます.
figure:SceneまたはNoneでなければなりません.
line_width:使用されている場合,線の幅.floatでなければなりません.デフォルトは2.0
name:作成されたvtkオブジェクトの名前.
opacity:テキストの不透明度.
width:テキストの幅.
z:オプションのz位置.指定すると,テキストは3D内に配置されます.

text3d

mayavi.mlab.text3d(*args, **kwargs)

シーン内の3D位置にテキストを配置します.

関数シグネチャ

text3d(x, y, z, text, ...)

x,y,zはテキストの原点の位置です.テキストは,3次元で図形座標に配置されます.

キーワード引数:

color:vtkオブジェクトの色.カラーマップを指定した場合,カラーマップを上書きします.これは0から1の範囲のfloatのトリプレット (1, 1, 1) として指定されます.
figure:SceneまたはNoneでなければなりません.
line_width:使用されている場合,線の幅.floatでなければなりません.デフォルトは2.0
name:作成されたvtkオブジェクトの名前.
opacity:vtkオブジェクトの全体的な不透明度.floatでなければなりません.デフォルトは1.0
orient_to_camera:
 カメラの位置に関係なく,テキストがカメラの方向を維持しているか,特定の方向を指している場合.ブール値でなければなりません.デフォルトはTrueです.
orientation:テキストの向きを示す角度.テキストがカメラの方向を向いている場合,これらの角度はカメラの軸を基準にします.そうでない場合,これらの角度はz軸を基準にします.(3,)の形を持つ配列でなければなりません.
scale:図単位での文字の尺度.float,または3つのfloatの組.

title

mayavi.mlab.title(*args, **kwargs)

図のタイトルを作成します.

関数シグネチャ

title(text, ...)

キーワード引数:

color:vtkオブジェクトの色.カラーマップを指定した場合,カラーマップを上書きします.これは0から1の範囲のfloatのトリプレット (1, 1, 1) として指定されます.
figure:SceneまたはNoneでなければなりません.
height:図の高さの一部にあるタイトルの高さ
line_width:使用されている場合,線の幅.floatでなければなりません.デフォルトは2.0
name:作成されたvtkオブジェクトの名前.
opacity:vtkオブジェクトの全体的な不透明度.floatでなければなりません.デフォルトは1.0
size:タイトルのサイズ