pyvista.plotting.volume_property.VolumeProperty

class VolumeProperty(lookup_table=None, interpolation_type=None, ambient=None, diffuse=None, specular=None, specular_power=None, shade=None, opacity_unit_distance=None)

VTK クラス vtkVolumeProperty をラッピングします．

このクラスは，ボリュームレンダリングに関連する一般的なプロパティを表現するために使用されます．これには，ボリュームのサンプリング時に使用する補間の種類，ボリュームの色，ボリュームのスカラー不透明度，ボリュームのグラデーション不透明度，ボリュームのシェーディングパラメータを決定するためのプロパティが含まれます．

パラメータ:

lookup_tablepyvista.LookupTable, optional

色と不透明度の伝達関数を設定するためのルックアップテーブル．

interpolation_typestr, optional

値は 'linear' または 'nearest' のどちらかでなければなりません．

ambientfloat, optional

照明が有効な場合，これは，ビューアから放射された光源に向けられていないときにアクターに到達する0から1の範囲（デフォルトは0.0）の光の量です．

diffusefloat, optional

拡散照明係数．

specularfloat, optional

鏡面反射光の係数．

specular_powerfloat, optional

鏡面パワー．0.0から128.0．

shadebool, optional

ボリュームのシェーディングを有効または無効にします． シェーディングがオフの場合，ボリュームのマッパーはシェーディングの計算を行いません．シェーディングがオンの場合，マッパーはシェーディングの計算を行うかもしれません - いくつかのケースではシェーディングが適用されないので（例えば，最大輝度投影の場合），このフラグがオンでも，シェーディングは実行されません．コンポジットタイプのマッパーでは，シェーディングをオフにすることは，一般的に ambient=1, diffuse=0, specular=0 を設定するのと同じです．シェーディングはコンポーネントごとに独立してON/OFFすることができます．

opacity_unit_distancefloat, optional

これは，スカラー不透明度伝達関数が定義される単位距離です．デフォルトではこれは 1.0 で，1.0 単位の距離にわたって，（伝達関数から）与えられた不透明度が蓄積されることを意味します．これはレンダリング時に実際のサンプリング距離に合わせて調整されます．

例

perlin noiseからサンプルデータセットを作成し， VolumeProperty にルックアップテーブルを適用します．

>>> import pyvista as pv
>>> noise = pv.perlin_noise(1, (1, 3, 5), (0, 0, 0))
>>> grid = pv.sample_function(
...     noise, [0, 3.0, -0, 1.0, 0, 1.0], dim=(40, 40, 40)
... )
>>> grid['scalars'] -= grid['scalars'].min()
>>> grid['scalars'] *= 255 / grid['scalars'].max()
>>> pl = pv.Plotter()
>>> actor = pl.add_volume(grid, show_scalar_bar=False)
>>> lut = pv.LookupTable(cmap='bwr')
>>> lut.apply_opacity([1.0, 0.0, 0.0, 0.3, 0.0, 0.0, 0.0, 0.3])
>>> actor.prop.apply_lookup_table(lut)
>>> pl.show()

メソッド

VolumeProperty.apply_lookup_table(lookup_table)	ボリュームプロパティにルックアップテーブルを適用します．
VolumeProperty.copy()	このプロパティのディープコピーを作成します．

アトリビュート

VolumeProperty.ambient	環境照明係数を返す，または設定します．
VolumeProperty.diffuse	拡散照明係数を返すか設定します．
VolumeProperty.independent_components	独立成分を返すか設定します．
VolumeProperty.interpolation_type	補間の種類を返すか設定します．
VolumeProperty.opacity_unit_distance	不透明度の単位距離を返す，または設定します．
VolumeProperty.shade	ボリュームのシェーディングを返す，または設定します．
VolumeProperty.specular	鏡面を返すか設定します．
VolumeProperty.specular_power	スペキュラパワーを返すか設定します．