pyvista.core._validation.validate.validate_dimensionality

pyvista.core._validation.validate.validate_dimensionality#

validate_dimensionality(
dimensionality: Literal[0, 1, 2, 3, '0D', '1D', '2D', '3D'] | VectorLike[int],
/,
*,
reshape: bool = True,
**kwargs,
) → int[ソース]#

Validate a dimensionality.

By default, the dimensionality is checked to ensure it:

  • スカラーであるか，スカラーとして整形できる配列

  • is an integer in the inclusive range [0, 3]

  • or is a valid alias among '0D', '1D', '2D', or '3D'

パラメータ:
dimensionalityLiteral[0, 1, 2, 3, '0D', '1D', '2D', '3D'] | ArrayLike

検証する数字．

reshapebool, default: True

もし True ならば，1つの要素を持つ1次元配列は有効な入力とみなされ，0次元に整形される．

**kwargsdict, optional

validate_array() に渡す追加のキーワード引数です．

戻り値:
int

Validated dimensionality.

例

Validate a dimensionality.

>>> from pyvista import _validation
>>> _validation.validate_dimensionality('1D')
1

1D配列は自動的に変形されます．

>>> _validation.validate_dimensionality([3])
3
目次