pyvista.Transform.apply_to_points

pyvista.Transform.apply_to_points#

Transform.apply_to_points(
points: VectorLike[float] | MatrixLike[float],
/,
inverse: bool = False,
copy: bool = True,
) NumpyArray[float][source]#

Apply the current transformation matrix to a point or points.

This is equivalent to apply(points, 'points'). See apply() for details and examples.

Parameters:
pointsVectorLike[float] | MatrixLike[float]

Single point or Nx3 points array to apply the transformation to.

inversebool, default: False

Apply the transformation using the inverse_matrix instead of the matrix.

copybool, default: True

Return a copy of the input with the transformation applied. Set this to False to transform the input directly and return it. Only applies to NumPy arrays. A copy is always returned for tuple and list inputs or point arrays with integers.

Returns:
np.ndarray

Transformed points.

See also

apply

Apply this transformation to any input.

apply_to_vectors

Apply this transformation to vectors.

apply_to_dataset

Apply this transformation to a dataset.