注釈

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

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

Sources

array2d_source

mayavi.tools.pipeline.array2d_source(*args, **kwargs)

2D配列から構造化2Dデータを作成します.

関数シグネチャ

array2d_source(s, ...)
array2d_source(x, y, s, ...)
array2d_source(x, y, f, ...)

3つの位置引数が渡された場合,最後の位置引数は配列s,または配列を返す呼び出し可能なfである必要があります.xとyはsの値に対応する位置の座標を与えます.

xとyは1Dまたは2D配列( numpy.ogrid や numpy.mgrid から返されるような)ですが,ポイントは直交グリッド上(おそらく不均一)に配置する必要があります.つまり,s配列内で同じインデックスを共有するすべてのポイントは,同じxまたはy値を持つ必要があります.

1つの配列sだけが渡された場合,xおよびy配列は配列のインデックスから作成されると仮定され,均一な間隔のデータセットが作成されます.

キーワード引数:

name:作成されたvtkオブジェクトの名前.
figure:オプションで,データ・ソースを追加する数値です.Noneの場合,ソースは図に追加されず,モジュールまたはフィルタによって自動的に追加されます.Falseの場合,ソースに適用されたモジュールまたはフィルタによって図形は作成されません.ソースはテストまたは数値アルゴリズムにのみ使用でき,視覚化には使用できません.
mask:ブーリアンマスク配列で指定されたマスクポイント.

builtin_image

mayavi.tools.pipeline.builtin_image(metadata=<mayavi.core.metadata.SourceMetadata object at 0x13b8a1888>)

vtkイメージデータソースを作成します

builtin_surface

mayavi.tools.pipeline.builtin_surface(metadata=<mayavi.core.metadata.SourceMetadata object at 0x13b8a17d8>)

vtkポリゴンデータソースを作成します

chaco_file

mayavi.tools.pipeline.chaco_file(metadata=<mayavi.core.metadata.SourceMetadata object at 0x13b8a1a40>)

Chacoファイルを開きます

grid_source

mayavi.tools.pipeline.grid_source(x, y, z, **kwargs)

2Dグリッドデータを作成します.

x,y,zはサーフェスの頂点の位置を示す2D配列です.これらのポイント間の接続性は,配列上の接続性によって示されます.

単純な構造(直交グリッドなど)の場合は,より効率的なデータ構造を作成できるarray2dsource関数の方が適しています.

キーワード引数:

name:作成されたvtkオブジェクトの名前.
scalars:オプションのスカラーデータ.
figure:オプションで,データ・ソースを追加する数値です.Noneの場合,ソースは図に追加されず,モジュールまたはフィルタによって自動的に追加されます.Falseの場合,ソースに適用されたモジュールまたはフィルタによって図形は作成されません.ソースはテストまたは数値アルゴリズムにのみ使用でき,視覚化には使用できません.
mask:ブーリアンマスク配列で指定されたマスクポイント.

line_source

mayavi.tools.pipeline.line_source(*args, **kwargs)

線分データを作成します.

関数シグネチャ

line_source(x, y, z, ...)
line_source(x, y, z, s, ...)
line_source(x, y, z, f, ...)

If 4 positional arguments are passed the last one must be an array s,
or a callable, f, that returns an array.

キーワード引数:

name:作成されたvtkオブジェクトの名前.
figure:オプションで,データ・ソースを追加する数値です.Noneの場合,ソースは図に追加されず,モジュールまたはフィルタによって自動的に追加されます.Falseの場合,ソースに適用されたモジュールまたはフィルタによって図形は作成されません.ソースはテストまたは数値アルゴリズムにのみ使用でき,視覚化には使用できません.

open

mayavi.tools.pipeline.open(filename, figure=None)

ファイル名を指定して,サポートされているデータファイルを開きます.ファイルに適したリーダーが見つかった場合は,ソースオブジェクトを返します.

'figure' がFalseの場合,ビューは開かれず,コードはGUIやopenGLコンテキストを必要としません.

parametric_surface

mayavi.tools.pipeline.parametric_surface(metadata=<mayavi.core.metadata.SourceMetadata object at 0x13b8a1620>)

パラメトリックサーフェスソースを作成します

point_load

mayavi.tools.pipeline.point_load(metadata=<mayavi.core.metadata.SourceMetadata object at 0x13b8a1728>)

データの立方体に対する点荷重をシミュレートします(テンソル用)

scalar_field

mayavi.tools.pipeline.scalar_field(*args, **kwargs)

スカラフィールドデータを作成します.

関数シグネチャ

scalar_field(s, ...)
scalar_field(x, y, z, s, ...)
scalar_field(x, y, z, f, ...)

配列sが1つだけ渡された場合,x,y,zの各配列は配列のインデックスから作成されたものとみなされます.

x,y,z配列が渡された場合, numpy.mgrid によって生成されたものとみなされます.この関数は,点が規則的に間隔を置いて配置されていると仮定してスカラーフィールドを構築します.

4つの位置引数が渡された場合,最後の位置引数は配列s,または配列を返す呼び出し可能なfである必要があります.

キーワード引数:

name:作成されたvtkオブジェクトの名前.
figure:オプションで,データ・ソースを追加する数値です.Noneの場合,ソースは図に追加されず,モジュールまたはフィルタによって自動的に追加されます.Falseの場合,ソースに適用されたモジュールまたはフィルタによって図形は作成されません.ソースはテストまたは数値アルゴリズムにのみ使用でき,視覚化には使用できません.

scalar_scatter

mayavi.tools.pipeline.scalar_scatter(*args, **kwargs)

分散スカラーデータを作成します.

関数シグネチャ

scalar_scatter(s, ...)
scalar_scatter(x, y, z, s, ...)
scalar_scatter(x, y, z, s, ...)
scalar_scatter(x, y, z, f, ...)

配列sが1つだけ渡された場合,x,y,zの各配列はベクトルのインデックスから作成されたものとみなされます.

4つの位置引数が渡された場合,最後の位置引数は配列s,または配列を返す呼び出し可能なfである必要があります.

キーワード引数:

name:作成されたvtkオブジェクトの名前.
figure:オプションで,データ・ソースを追加する数値です.Noneの場合,ソースは図に追加されず,モジュールまたはフィルタによって自動的に追加されます.Falseの場合,ソースに適用されたモジュールまたはフィルタによって図形は作成されません.ソースはテストまたは数値アルゴリズムにのみ使用でき,視覚化には使用できません.

triangular_mesh_source

mayavi.tools.pipeline.triangular_mesh_source(x, y, z, triangles, **kwargs)

点と三角形の接続を指定して2Dメッシュを作成します.

x,y,zは,サーフェスの頂点の位置を示す2D配列です.これらのポイント間の接続性は,相互接続された頂点のトリプレットをリストすることによって得られます.これらの頂点は位置インデックスによって設計されます.

キーワード引数:

name:作成されたvtkオブジェクトの名前.
scalars:オプションのスカラーデータ.
figure:オプションで,データ・ソースを追加する数値です.Noneの場合,ソースは図に追加されず,モジュールまたはフィルタによって自動的に追加されます.Falseの場合,ソースに適用されたモジュールまたはフィルタによって図形は作成されません.ソースはテストまたは数値アルゴリズムにのみ使用でき,視覚化には使用できません.

vector_field

mayavi.tools.pipeline.vector_field(*args, **kwargs)

ベクトルフィールドデータを作成します.

関数シグネチャ

vector_field(u, v, w, ...)
vector_field(x, y, z, u, v, w, ...)
vector_field(x, y, z, f, ...)

3つの配列u,v,wだけが渡された場合,x,y,zの各配列はベクトルのインデックスから作成されたものとみなされます.

x,y,z配列が渡された場合,これらは numpy.mgrid または numpy.ogrid によって生成されたはずです.この関数は,点が直交グリッド上に規則的に配置されていると仮定してスカラーフィールドを構築します.

4つの位置引数が渡された場合,最後の位置引数はベクトルを返す呼び出し可能なfでなければなりません.

キーワード引数:

name:作成されたvtkオブジェクトの名前.
scalars:オプションのスカラーデータ.
figure:オプションで,データ・ソースを追加する数値です.Noneの場合,ソースは図に追加されず,モジュールまたはフィルタによって自動的に追加されます.Falseの場合,ソースに適用されたモジュールまたはフィルタによって図形は作成されません.ソースはテストまたは数値アルゴリズムにのみ使用でき,視覚化には使用できません.

vector_scatter

mayavi.tools.pipeline.vector_scatter(*args, **kwargs)

分散ベクトルデータを作成します.

関数シグネチャ

vector_scatter(u, v, w, ...)
vector_scatter(x, y, z, u, v, w, ...)
vector_scatter(x, y, z, f, ...)

3つの配列u,v,wだけが渡された場合,x,y,zの各配列はベクトルのインデックスから作成されたものとみなされます.

4つの位置引数が渡された場合,最後の位置引数はベクトルを返す呼び出し可能なfでなければなりません.

キーワード引数:

name:作成されたvtkオブジェクトの名前.
scalars:オプションのスカラーデータ.
figure:オプションで,データ・ソースを追加する数値です.Noneの場合,ソースは図に追加されず,モジュールまたはフィルタによって自動的に追加されます.Falseの場合,ソースに適用されたモジュールまたはフィルタによって図形は作成されません.ソースはテストまたは数値アルゴリズムにのみ使用でき,視覚化には使用できません.

vertical_vectors_source

mayavi.tools.pipeline.vertical_vectors_source(*args, **kwargs)

上向きのベクトルのセットを作成します.棒グラフなどに役立ちます.

関数シグネチャ

vertical_vectors_source(s, ...)
vertical_vectors_source(x, y, s, ...)
vertical_vectors_source(x, y, f, ...)
vertical_vectors_source(x, y, z, s, ...)
vertical_vectors_source(x, y, z, f, ...)

1つの位置引数のみが渡される場合,ベクトルの長さを示す1D,2D,または3D配列を指定できます.データ点の位置が配列のインデックスから差し引かれ,等間隔のデータセットが作成されます.

3つの位置引数(x,y,s)が渡された場合,最後の位置引数は配列s,または配列を返す呼び出し可能なfである必要があります.xとyは,sの値に対応する位置の2D座標です.垂直位置は0と見なされます.

4つの位置引数 (x, y, z, s) が渡された場合,最初の3つはデータポイントの3D座標を与える配列で,最後のものはデータ値を与える配列を返す配列sまたは呼び出し可能なfです.

キーワード引数:

name:作成されたvtkオブジェクトの名前.
figure:オプションで,データ・ソースを追加する数値です.Noneの場合,ソースは図に追加されず,モジュールまたはフィルタによって自動的に追加されます.Falseの場合,ソースに適用されたモジュールまたはフィルタによって図形は作成されません.ソースはテストまたは数値アルゴリズムにのみ使用でき,視覚化には使用できません.

volume_file

mayavi.tools.pipeline.volume_file(metadata=<mayavi.core.metadata.SourceMetadata object at 0x13b8a1938>)

ボリュームファイルを開きます