pyvista.CompositeFilters.elevation

CompositeFilters.elevation(low_point=None, high_point=None, scalar_range=None, preference='point', set_active=True, progress_bar=False)

データセットにスカラー値を生成します．

スカラー値は，ユーザが指定した範囲内にあり，各データセット点の線への投影を計算することによって生成されます．線の方向は任意です．典型的な例は，平面上の高度または高さに基づいてスカラーを生成することです．

警告

これは，入力データセットの点データに 'Elevation' という名前のスカラー配列を作成し， 'Elevation' という名前の配列があればそれを上書きします．

パラメータ:

low_pointsequence[float], optional

3 D空間での投影線の低点．デフォルトはデータセットの下部中央です．それ以外の場合は，長さ3のシーケンスを渡します．

high_pointsequence[float], optional

3 D空間での投影線の高点．デフォルトはデータセットの上部中央です．それ以外の場合は，長さ3のシーケンスを渡します．

scalar_rangestr | sequence[float], optional

データ・セットにマップされる線上のロー・ポイントとハイ・ポイントに投影するスカラー範囲．なしを指定すると，高点と低点の間の標高(Z成分)の範囲から値が計算されます．範囲の最小値と最大値は，長さ2のシーケンスとして与えることができます．与えられたデータセットにscalara配列の str 名が存在する場合，その配列の有効範囲が使用される．

preferencestr, default: "point"

scalar_range のために配列名が指定されるとき，これはデータセットで検索するために好ましい配列型である． 'point' または 'cell' のいずれかである必要があります．

set_activebool, default: True

新しい 'Elevation' スカラーを出力データセットのアクティブなスカラー配列として設定するかどうかのbooleanフラグ．

progress_barbool, default: False

進行状況を示す進行状況バーを表示します．

戻り値:

pyvista.DataSet

point_data の "Elevation" 配列に標高スカラーを含みますデータセットです．

例

球体メッシュの "仰角" スカラーを生成します． これは単純にXY平面からのZ方向の高さを表します．

>>> import pyvista as pv
>>> sphere = pv.Sphere()
>>> sphere_elv = sphere.elevation()
>>> sphere_elv.plot(smooth_shading=True)

最初の4つの仰角スカラーにアクセスします． これは，各ポイントの "標高" を含みますポイント単位の配列です．

>>> sphere_elv['Elevation'][:4]  
array([-0.5       ,  0.5       , -0.49706897, -0.48831028], dtype=float32)

このフィルターを使用したその他の例については， 共通フィルタの使用 を参照してください．