pyvista_validation.validate.validate_dimensionality

pyvista_validation.validate.validate_dimensionality#

pyvista_validation.validate.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 scalar or is an array which can be reshaped as a scalar

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

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

Parameters:
dimensionalityLiteral[0, 1, 2, 3, ‘0D’, ‘1D’, ‘2D’, ‘3D’] | ArrayLike

Number to validate.

reshapebool, default: True

If True, 1D arrays with 1 element are considered valid input and are reshaped to be 0-dimensional.

**kwargsdict, optional

Additional keyword arguments passed to validate_array().

Returns:
int

Validated dimensionality.

Examples

Validate a dimensionality.

>>> from pyvista_validation import validate_dimensionality
>>> validate_dimensionality('1D')
1

1D arrays are automatically reshaped.

>>> validate_dimensionality([3])
3
Contents