pyvista.MultiBlock.set_active_scalars

pyvista.MultiBlock.set_active_scalars#

MultiBlock.set_active_scalars(
name: str | None,
preference: PointLiteral | CellLiteral = 'cell',
allow_missing: bool = False,
) tuple[FieldAssociation, NumpyArray[float]][ソース]#

スカラーを名前で検索し,適切にアクティブとして設定します.

アクティブなスカラーを非アクティブにするには, Nonename として渡します.

パラメータ:
namepython:str または python:None

アクティブにするスカラー配列の名前です. None であれば,ポイントデータとセルデータの両方で,アクティブなスカラーを無効にします.

preferencestr, default: "cell"

同じ名前の配列がポイントやセルに関連付けられている場合,このタイプに一致する配列が優先されます. これには 'cell' または 'point' を指定します.

allow_missingbool, default: False

合成データセットの一部でスカラーの欠損を許容します.すべてのブロックで配列が欠落している場合, KeyError を発生させます.

戻り値:
pyvista.core.utilities.arrays.FieldAssociation

有効化されたスカラーのフィールドの関連付け.

numpy.ndarray

name にマッチするデータセットからの配列.

備考

データの構成要素数が一致しなければなりません.