Skip to article

 

Clip

Clip with an implicit function (an implicit description). Clipping does not reduce the dimensionality of the data set. The output data type of this filter is always an unstructured grid.

The Clip filter cuts away a portion of the input data set using an implicit function (an implicit description). This filter operates on all types of data sets, and it returns unstructured grid data on output.

Property Description Default(s) Restrictions
Input This property specifies the dataset on which the Clip filter will operate.  

Accepts input of following types:

  • vtkDataSet
  • vtkHyperTreeGrid

The dataset must contain a field array () with 1 component(s).

Clip Type This property specifies the parameters of the clip function (an implicit description) used to clip the dataset.  

The value can be one of the following:

  • Plane (implicit_functions)
  • Box (implicit_functions)
  • Sphere (implicit_functions)
  • Cylinder (implicit_functions)
  • Scalar (implicit_functions)
Hyper Tree Grid Clipper This property specifies the parameters of the clip function (an implicit description) used to clip the hyper tree grid.  

The value can be one of the following:

  • Plane (implicit_functions)
  • Axis Aligned Box (implicit_functions)
  • Sphere (implicit_functions)
  • Cylinder (implicit_functions)
  • Quadric (implicit_functions)
  • Scalar (implicit_functions)
InputBounds      
Scalars If clipping with scalars, this property specifies the name of the scalar array on which to perform the clip operation.  

An array of scalars is required.

Value If clipping with scalars, this property sets the scalar value about which to clip the dataset based on the scalar array chosen. (See SelectInputScalars.) If clipping with a clip function, this property specifies an offset from the clip function to use in the clipping operation. Neither functionality is currently available in FidesysViewer's user interface. 0.0

The value must lie within the range of the selected data array.

Invert Invert which part of the geometry is clipped. 1

Accepts boolean values (0 or 1).

UseValueAsOffset If UseValueAsOffset is true, Value is used as an offset parameter to the implicit function. Otherwise, Value is used only when clipping using a scalar array. 0

Accepts boolean values (0 or 1).

Crinkle clip This parameter controls whether to extract entire cells in the given region or clip those cells so all of the output will stay only on that side of region. 0

Accepts boolean values (0 or 1).

Exact If this property is set to 1 it will clip to the exact specifications for the Box option only, otherwise the clip will only approximate the box geometry. The exact clip is very expensive as it requires generating 6 plane clips. Additionally, Invert must be checked and Crinkle clip must be unchecked. 0

Accepts boolean values (0 or 1).