pyvista.DataSetFilters

class DataSetFilters(*args, **kwargs)

A set of common filters that can be applied to any vtkDataSet.

Methods

DataSetFilters.align(target[, ...])	Align a dataset to another.
DataSetFilters.align_xyz(*[, centered, ...])	Align a dataset to the x-y-z axes.
DataSetFilters.bounding_box([box_style, ...])	Return a bounding box for this dataset.
DataSetFilters.cell_centers([vertex, ...])	Generate points at the center of the cells in this dataset.
DataSetFilters.cell_data_to_point_data([...])	Transform cell data into point data.
DataSetFilters.clip([normal, origin, ...])	Clip a dataset by a plane by specifying the origin and normal.
DataSetFilters.clip_box([bounds, invert, ...])	Clip a dataset by a bounding box defined by the bounds.
DataSetFilters.clip_scalar([scalars, ...])	Clip a dataset by a scalar.
DataSetFilters.clip_surface(surface[, ...])	Clip any mesh type using a pyvista.PolyData surface mesh.
DataSetFilters.compute_boundary_mesh_quality(*)	Compute metrics on the boundary faces of a mesh.
DataSetFilters.compute_cell_quality([...])	Compute a function of (geometric) quality for each cell of a mesh.
DataSetFilters.compute_cell_sizes([length, ...])	Compute sizes for 0D (vertex count), 1D (length), 2D (area) and 3D (volume) cells.
DataSetFilters.compute_derivative([scalars, ...])	Compute derivative-based quantities of point/cell scalar field.
DataSetFilters.compute_implicit_distance(surface)	Compute the implicit distance from the points to a surface.
DataSetFilters.connectivity([...])	Find and label connected regions.
DataSetFilters.contour([isosurfaces, ...])	Contour an input self by an array.
DataSetFilters.ctp([pass_cell_data, ...])	Transform cell data into point data.
DataSetFilters.decimate_boundary([...])	Return a decimated version of a triangulation of the boundary.
DataSetFilters.delaunay_3d([alpha, tol, ...])	Construct a 3D Delaunay triangulation of the mesh.
DataSetFilters.elevation([low_point, ...])	Generate scalar values on a dataset.
DataSetFilters.explode([factor])	Push each individual cell away from the center of the dataset.
DataSetFilters.extract_all_edges([...])	Extract all the internal/external edges of the dataset as PolyData.
DataSetFilters.extract_cells(ind[, invert, ...])	Return a subset of the grid.
DataSetFilters.extract_cells_by_type(cell_types)	Extract cells of a specified type.
DataSetFilters.extract_feature_edges([...])	Extract edges from the surface of the mesh.
DataSetFilters.extract_geometry([extent, ...])	Extract the outer surface of a volume or structured grid dataset.
DataSetFilters.extract_largest([inplace, ...])	Extract largest connected set in mesh.
DataSetFilters.extract_points(ind[, ...])	Return a subset of the grid (with cells) that contains any of the given point indices.
DataSetFilters.extract_surface([...])	Extract surface mesh of the grid.
DataSetFilters.extract_values([values, ...])	Return a subset of the mesh based on the value(s) of point or cell data.
DataSetFilters.flip_normal(normal[, point, ...])	Flip mesh about the normal.
DataSetFilters.flip_x([point, ...])	Flip mesh about the x-axis.
DataSetFilters.flip_y([point, ...])	Flip mesh about the y-axis.
DataSetFilters.flip_z([point, ...])	Flip mesh about the z-axis.
DataSetFilters.glyph([orient, scale, ...])	Copy a geometric representation (called a glyph) to the input dataset.
DataSetFilters.integrate_data([progress_bar])	Integrate point and cell data.
DataSetFilters.interpolate(target[, ...])	Interpolate values onto this mesh from a given dataset.
DataSetFilters.merge([grid, merge_points, ...])	Join one or many other grids to this grid.
DataSetFilters.merge_points([tolerance, ...])	Merge duplicate points in this mesh.
DataSetFilters.oriented_bounding_box([...])	Return an oriented bounding box (OBB) for this dataset.
DataSetFilters.outline([generate_faces, ...])	Produce an outline of the full extent for the input dataset.
DataSetFilters.outline_corners([factor, ...])	Produce an outline of the corners for the input dataset.
DataSetFilters.pack_labels([sort, scalars, ...])	Renumber labeled data such that labels are contiguous.
DataSetFilters.partition(n_partitions[, ...])	Break down input dataset into a requested number of partitions.
DataSetFilters.plot_over_circular_arc(...[, ...])	Sample a dataset along a circular arc and plot it.
DataSetFilters.plot_over_circular_arc_normal(center)	Sample a dataset along a resolution circular arc defined by a normal and polar vector and plot it.
DataSetFilters.plot_over_line(pointa, pointb)	Sample a dataset along a high resolution line and plot.
DataSetFilters.point_data_to_cell_data([...])	Transform point data into cell data.
DataSetFilters.ptc([pass_point_data, ...])	Transform point data into cell data.
DataSetFilters.reflect(normal[, point, ...])	Reflect a dataset across a plane.
DataSetFilters.rotate(rotation[, point, ...])	Rotate mesh about a point with a rotation matrix or Rotation object.
DataSetFilters.rotate_vector(vector, angle)	Rotate mesh about a vector.
DataSetFilters.rotate_x(angle[, point, ...])	Rotate mesh about the x-axis.
DataSetFilters.rotate_y(angle[, point, ...])	Rotate mesh about the y-axis.
DataSetFilters.rotate_z(angle[, point, ...])	Rotate mesh about the z-axis.
DataSetFilters.sample(target[, tolerance, ...])	Resample array data from a passed mesh onto this mesh.
DataSetFilters.sample_over_circular_arc(...)	Sample a dataset over a circular arc.
DataSetFilters.sample_over_circular_arc_normal(center)	Sample a dataset over a circular arc defined by a normal and polar vector and plot it.
DataSetFilters.sample_over_line(pointa, pointb)	Sample a dataset onto a line.
DataSetFilters.sample_over_multiple_lines(points)	Sample a dataset onto a multiple lines.
DataSetFilters.scale(xyz[, ...])	Scale the mesh.
DataSetFilters.select_enclosed_points(surface)	Mark points as to whether they are inside a closed surface.
DataSetFilters.separate_cells()	Return a copy of the dataset with separated cells with no shared points.
DataSetFilters.shrink([shrink_factor, ...])	Shrink the individual faces of a mesh.
DataSetFilters.slice([normal, origin, ...])	Slice a dataset by a plane at the specified origin and normal vector orientation.
DataSetFilters.slice_along_axis([n, axis, ...])	Create many slices of the input dataset along a specified axis.
DataSetFilters.slice_along_line(line[, ...])	Slice a dataset using a polyline/spline as the path.
DataSetFilters.slice_implicit(implicit_function)	Slice a dataset by a VTK implicit function.
DataSetFilters.slice_orthogonal([x, y, z, ...])	Create three orthogonal slices through the dataset on the three cartesian planes.
DataSetFilters.sort_labels([scalars, ...])	Sort labeled data by number of points or cells.
DataSetFilters.split_bodies([label, ...])	Find, label, and split connected bodies/volumes.
DataSetFilters.split_values([values, ...])	Split mesh into separate sub-meshes using point or cell data.
DataSetFilters.streamlines([vectors, ...])	Integrate a vector field to generate streamlines.
DataSetFilters.streamlines_evenly_spaced_2D([...])	Generate evenly spaced streamlines on a 2D dataset.
DataSetFilters.streamlines_from_source(source)	Generate streamlines of vectors from the points of a source mesh.
DataSetFilters.surface_indices([progress_bar])	Return the surface indices of a grid.
DataSetFilters.tessellate([max_n_subdivide, ...])	Tessellate a mesh.
DataSetFilters.texture_map_to_plane([...])	Texture map this dataset to a user defined plane.
DataSetFilters.texture_map_to_sphere([...])	Texture map this dataset to a user defined sphere.
DataSetFilters.threshold([value, scalars, ...])	Apply a vtkThreshold filter to the input dataset.
DataSetFilters.threshold_percent([percent, ...])	Threshold the dataset by a percentage of its range on the active scalars array.
DataSetFilters.transform(trans[, ...])	Transform this mesh with a 4x4 transform.
DataSetFilters.translate(xyz[, ...])	Translate the mesh.
DataSetFilters.triangulate([inplace, ...])	Return an all triangle mesh.
DataSetFilters.warp_by_scalar([scalars, ...])	Warp the dataset's points by a point data scalars array's values.
DataSetFilters.warp_by_vector([vectors, ...])	Warp the dataset's points by a point data vectors array's values.