texture_map_to_plane

UniformGrid.texture_map_to_plane(origin=None, point_u=None, point_v=None, inplace=False, name='Texture Coordinates', use_bounds=False, progress_bar=False)

Texture map this dataset to a user defined plane.

This is often used to define a plane to texture map an image to this dataset. The plane defines the spatial reference and extent of that image.

Parameters
origintuple(float), optional

Length 3 iterable of floats defining the XYZ coordinates of the bottom left corner of the plane.

point_utuple(float), optional

Length 3 iterable of floats defining the XYZ coordinates of the bottom right corner of the plane.

point_vtuple(float), optional

Length 3 iterable of floats defining the XYZ coordinates of the top left corner of the plane.

inplacebool, optional

If True, the new texture coordinates will be added to this dataset. If False (default), a new dataset is returned with the texture coordinates.

namestr, optional

The string name to give the new texture coordinates if applying the filter inplace.

use_boundsbool, optional

Use the bounds to set the mapping plane by default (bottom plane of the bounding box).

progress_barbool, optional

Display a progress bar to indicate progress.

Returns
pyvista.DataSet

Original dataset with texture coordinates if inplace=True, otherwise a copied dataset.

Examples

See Topographic Map