pyvista_validation.validate.validate_transform3x3

pyvista_validation.validate.validate_transform3x3(transform: TransformLike, /, *, must_be_finite: bool = True, name: str = 'Transform')

Validate transform-like input as a 3x3 ndarray.

Parameters:

transformRotationLike

Transformation matrix as a 3x3 array, vtk matrix, or a SciPy Rotation instance.

Note

Although RotationLike inputs are accepted, no checks are done to verify that the transformation is actually a rotation. Therefore, any 3x3 transformation is acceptable.

must_be_finitebool, default: True

Check if all elements of the array are finite, that is, not infinity and not Not a Number (NaN).

namestr, default: “Transform”

Variable name to use in the error messages if any of the validation checks fail.

Returns:

np.ndarray

Validated 3x3 transformation matrix.

See also

validate_transform4x4

Similar function for 4x4 transforms.

validate_array

Generic array validation function.