ParaView/Users Guide/List of filters: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
No edit summary
No edit summary
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[ParaViewUsersGuide]]
==AMR Contour==


==AMR Connectivity==


Fragment Identification


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 13: Line 10:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Capping'''<br>''(Capping)''
|'''Input''' (Input)
|
|
If this property is on, the the boundary of the data set is capped.
This property specifies the volume input of the
 
filter.
| 1
|
|
Only the values 0 and 1 are accepted.


|-
| '''Isosurface'''<br>''(ContourValue)''
|
This property specifies the values at which to compute the isosurface.
| 1
|
|
The value must lie within the range of the selected data array.
Accepts input of following types:
* vtkNonOverlappingAMR
The dataset must contain a field array (cell)


with 1 component(s).


|-
|-
| '''Degenerate Cells'''<br>''(DegenerateCells)''
|'''SelectMaterialArrays''' (SelectMaterialArrays)
|
|
If this property is on, a transition mesh between levels is created.
This property specifies the cell arrays from which the
 
analysis will determine fragments
| 1
|
|
Only the values 0 and 1 are accepted.


|-
| '''Input'''<br>''(Input)''
|
|
|
An array of scalars is required.
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a cell array with 1 components.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkCompositeDataSet.
 
 
|-
|-
| '''Merge Points'''<br>''(MergePoints)''
|'''Volume Fraction Value''' (VolumeFractionSurfaceValue)
|
Use more memory to merge points on the boundaries of blocks.
 
| 1
|
|
Only the values 0 and 1 are accepted.
This property specifies the values at which to compute
 
the isosurface.
 
|-
| '''Multiprocess Communication'''<br>''(MultiprocessCommunication)''
|
|
If this property is off, each process executes independantly.
0.1
 
| 1
|
|
Only the values 0 and 1 are accepted.


|-
|-
| '''Contour By'''<br>''(SelectInputScalars)''
|'''Resolve Blocks''' (Resolve Blocks)
|
|
This property specifies the name of the cell scalar array from which the contour filter will compute isolines and/or isosurfaces.
Resolve the fragments between blocks.
 
|
|
1
|
|
An array of scalars is required.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Skip Ghost Copy'''<br>''(SkipGhostCopy)''
|'''Propagate Ghosts''' (Propagate Ghosts)
|
|
A simple test to see if ghost values are already set properly.
Propagate regionIds into the ghosts.
 
| 1
|
|
Only the values 0 and 1 are accepted.
0
 
 
|-
| '''Triangulate'''<br>''(Triangulate)''
|
|
Use triangles instead of quads on capping surfaces.
Accepts boolean values (0 or 1).
 
| 1
|
Only the values 0 and 1 are accepted.
 


|}
|}


==AMR Contour==


==AMR Dual Clip==
Iso surface cell array.
 
 
Clip with scalars. Tetrahedra.
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 122: Line 72:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Degenerate Cells'''<br>''(DegenerateCells)''
|'''Input''' (Input)
|
This property specifies the input of the
filter.
|
|
If this property is on, a transition mesh between levels is created.


| 1
|
|
Only the values 0 and 1 are accepted.
Accepts input of following types:
* vtkCompositeDataSet
The dataset must contain a field array (cell)


with 1 component(s).


|-
|-
| '''Input'''<br>''(Input)''
|'''SelectMaterialArrays''' (SelectMaterialArrays)
|
|
This property specifies the cell arrays from which the
contour filter will compute contour cells.
|
|
|
An array of scalars is required.
|-
|'''Volume Fraction Value''' (VolumeFractionSurfaceValue)
|
This property specifies the values at which to compute
the isosurface.
|
0.1
|
|
The selected object must be the result of the following: sources (includes readers), filters.
The dataset must contain a cell array with 1 components.
The selected dataset must be one of the following types (or a subclass of one of them): vtkCompositeDataSet.


|-
|-
| '''Merge Points'''<br>''(MergePoints)''
|'''Capping''' (Capping)
|
If this property is on, the the boundary of the data set
is capped.
|
1
|
Accepts boolean values (0 or 1).
|-
|'''DegenerateCells''' (DegenerateCells)
|
If this property is on, a transition mesh between levels
is created.
|
1
|
Accepts boolean values (0 or 1).
|-
|'''MultiprocessCommunication''' (MultiprocessCommunication)
|
|
Use more memory to merge points on the boundaries of blocks.
If this property is off, each process executes
 
independantly.
| 1
|
1
|
|
Only the values 0 and 1 are accepted.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Multiprocess Communication'''<br>''(MultiprocessCommunication)''
|'''SkipGhostCopy''' (SkipGhostCopy)
|
A simple test to see if ghost values are already set
properly.
|
|
If this property is off, each process executes independantly.
1
 
| 1
|
|
Only the values 0 and 1 are accepted.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Select Material Arrays'''<br>''(SelectMaterialArrays)''
|'''Triangulate''' (Triangulate)
|
|
This property specifies the cell arrays from which the clip filter will
Use triangles instead of quads on capping
compute clipped cells.
surfaces.
 
|
|
1
|
|
An array of scalars is required.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Volume Fraction Value'''<br>''(VolumeFractionSurfaceValue)''
|'''MergePoints''' (MergePoints)
|
|
This property specifies the values at which to compute the isosurface.
Use more memory to merge points on the boundaries of
 
blocks.
| 0.1
|
1
|
|
The value must be greater than or equal to 0 and less than or equal to 1.
Accepts boolean values (0 or 1).
 


|}
|}


==AMR CutPlane==


==Annotate Time Filter==
Planar Cut of an AMR grid datasetThis filter
 
creates a cut-plane of the
 
Shows input data time as text annnotation in the view.
 
The Annotate Time filter can be used to show the data time in a text annotation.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 203: Line 173:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Format'''<br>''(Format)''
|'''Input''' (Input)
|
This property specifies the input for this
filter.
|
|
The value of this property is a format string used to display the input time. The format string is specified using printf style.


| Time: %f
|
|
Accepts input of following types:
* vtkOverlappingAMR
|-
|-
| '''Input'''<br>''(Input)''
|'''UseNativeCutter''' (UseNativeCutter)
|
|
This property specifies the input dataset for which to display the time.
This property specifies whether the ParaView's generic
 
dataset cutter is used instead of the specialized AMR
cutter.
|
0
|
Accepts boolean values (0 or 1).
|-
|'''LevelOfResolution''' (LevelOfResolution)
|
Set maximum slice resolution.
|
|
0
|
|
The selected object must be the result of the following: sources (includes readers), filters.


|-
|-
| '''Scale'''<br>''(Scale)''
|'''Center''' (Center)
|
|
The factor by which the input time is scaled.


| 1
|
|
0.5 0.5 0.5
|
|-
|-
| '''Shift'''<br>''(Shift)''
|'''Normal''' (Normal)
|
|
The amount of time the input is shifted (after scaling).


| 0
|
|
0 0 1
|
|}
|}


==AMR Dual Clip==


==Append Attributes==
Clip with scalars. Tetrahedra.
 
 
Copies geometry from first input.  Puts all of the arrays into the output.
 
The Append Attributes filter takes multiple input data sets with the same geometry and merges their point and cell attributes to produce a single output containing all the point and cell attributes of the inputs. Any inputs without the same number of points and cells as the first input are ignored. The input data sets must already be collected together, either as a result of a reader that loads multiple parts (e.g., EnSight reader) or because the Group Parts filter has been run to form a collection of data sets.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 250: Line 231:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Input'''<br>''(Input)''
|'''Input''' (Input)
|
This property specifies the input of the
filter.
|
|
This property specifies the input to the Append Attributes filter.


|
|
|
Accepts input of following types:
The selected object must be the result of the following: sources (includes readers), filters.
* vtkCompositeDataSet
The dataset must contain a field array (cell)


with 1 component(s).


The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
|-
|'''SelectMaterialArrays''' (SelectMaterialArrays)
|
This property specifies the cell arrays from which the
clip filter will compute clipped cells.
|


|
An array of scalars is required.
|-
|'''Volume Fraction Value''' (VolumeFractionSurfaceValue)
|
This property specifies the values at which to compute
the isosurface.
|
0.1
|


|}
==Append Datasets==
Takes an input of multiple datasets and output has only one unstructured grid.
The Append Datasets filter operates on multiple data sets of any type (polygonal, structured, etc.). It merges their geometry into a single data set. Only the point and cell attributes that all of the input data sets have in common will appear in the output. The input data sets must already be collected together, either as a result of a reader that loads multiple parts (e.g., EnSight reader) or because the Group Parts filter has been run to form a collection of data sets.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''InternalDecimation''' (InternalDecimation)
| '''Description'''
|
| '''Default Value(s)'''
If this property is on, internal tetrahedra are
| '''Restrictions'''
decimation
|
1
|
Accepts boolean values (0 or 1).
|-
|'''MultiprocessCommunication''' (MultiprocessCommunication)
|
If this property is off, each process executes
independantly.
|
1
|
Accepts boolean values (0 or 1).
|-
|-
| '''Input'''<br>''(Input)''
|'''MergePoints''' (MergePoints)
|
|
This property specifies the datasets to be merged into a single dataset by the Append Datasets filter.
Use more memory to merge points on the boundaries of
 
blocks.
|
|
1
|
|
The selected object must be the result of the following: sources (includes readers), filters.
Accepts boolean values (0 or 1).
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 


|}
|}


==AMR Fragment Integration==


==Append Geometry==
Fragment Integration
 
 
Takes an input of multiple poly data parts and output has only one part.
 
The Append Geometry filter operates on multiple polygonal data sets. It merges their geometry into a single data set. Only the point and cell attributes that all of the input data sets have in common will appear in the output.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 308: Line 304:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Input'''<br>''(Input)''
|'''Input''' (Input)
|
This property specifies the volume input of the
filter.
|
|
Set the input to the Append Geometry filter.


|
|
|
Accepts input of following types:
The selected object must be the result of the following: sources (includes readers), filters.
* vtkNonOverlappingAMR
The dataset must contain a field array (cell)


with 1 component(s).


The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
|-
|'''SelectMaterialArrays''' (SelectMaterialArrays)
|
This property specifies the cell arrays from which the
analysis will determine fragments
|


|
An array of scalars is required.
|-
|'''SelectMassArrays''' (SelectMassArrays)
|
This property specifies the cell arrays from which the
analysis will determine fragment mass
|


|}
|
 
An array of scalars is required.
 
==Block Scalars==
 
 
The Level Scalars filter uses colors to show levels of a multiblock dataset.
 
The Level Scalars filter uses colors to show levels of a multiblock dataset.<br>
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''SelectVolumeWeightedArrays''' (SelectVolumeWeightedArrays)
| '''Description'''
|
| '''Default Value(s)'''
This property specifies the cell arrays from which the
| '''Restrictions'''
analysis will determine volume weighted average values
|-
| '''Input'''<br>''(Input)''
|
|
This property specifies the input to the Level Scalars filter.


|
|
An array of scalars is required.
|-
|'''SelectMassWeightedArrays''' (SelectMassWeightedArrays)
|
This property specifies the cell arrays from which the
analysis will determine mass weighted average values
|
|
The selected object must be the result of the following: sources (includes readers), filters.
The selected dataset must be one of the following types (or a subclass of one of them): vtkMultiBlockDataSet.


|
An array of scalars is required.


|}
|}


==AMR Fragments Filter==


==Calculator==
Meta Fragment filterCombines the running of
 
AMRContour, AMRFragmentIntegration, AMRDualContour and ExtractCTHParts
 
Compute new attribute arrays as function of existing arrays.
 
The Calculator filter computes a new data array or new point coordinates as a function of existing scalar or vector arrays. If point-centered arrays are used in the computation of a new data array, the resulting array will also be point-centered. Similarly, computations using cell-centered arrays will produce a new cell-centered array. If the function is computing point coordinates, the result of the function must be a three-component vector. The Calculator interface operates similarly to a scientific calculator. In creating the function to evaluate, the standard order of operations applies.<br>
Each of the calculator functions is described below. Unless otherwise noted, enclose the operand in parentheses using the ( and ) buttons.<br>
Clear: Erase the current function (displayed in the read-only text box above the calculator buttons).<br>
/: Divide one scalar by another. The operands for this function are not required to be enclosed in parentheses.<br>
*: Multiply two scalars, or multiply a vector by a scalar (scalar multiple). The operands for this function are not required to be enclosed in parentheses.<br>
-: Negate a scalar or vector (unary minus), or subtract one scalar or vector from another. The operands for this function are not required to be enclosed in parentheses.<br>
+: Add two scalars or two vectors. The operands for this function are not required to be enclosed in parentheses.<br>
sin: Compute the sine of a scalar.<br>
cos: Compute the cosine of a scalar.<br>
tan: Compute the tangent of a scalar.<br>
asin: Compute the arcsine of a scalar.<br>
acos: Compute the arccosine of a scalar.<br>
atan: Compute the arctangent of a scalar.<br>
sinh: Compute the hyperbolic sine of a scalar.<br>
cosh: Compute the hyperbolic cosine of a scalar.<br>
tanh: Compute the hyperbolic tangent of a scalar.<br>
min: Compute minimum of two scalars.<br>
max: Compute maximum of two scalars.<br>
x^y: Raise one scalar to the power of another scalar. The operands for this function are not required to be enclosed in parentheses.<br>
sqrt: Compute the square root of a scalar.<br>
e^x: Raise e to the power of a scalar.<br>
log: Compute the logarithm of a scalar (deprecated. same as log10).<br>
log10: Compute the logarithm of a scalar to the base 10.<br>
ln: Compute the logarithm of a scalar to the base 'e'.<br>
ceil: Compute the ceiling of a scalar.<br>
floor: Compute the floor of a scalar.<br>
abs: Compute the absolute value of a scalar.<br>
v1.v2: Compute the dot product of two vectors. The operands for this function are not required to be enclosed in parentheses.<br>
cross: Compute cross product of two vectors.<br>
mag: Compute the magnitude of a vector.<br>
norm: Normalize a vector.<br>
The operands are described below.<br>
The digits 0 - 9 and the decimal point are used to enter constant scalar values.<br>
iHat, jHat, and kHat are vector constants representing unit vectors in the X, Y, and Z directions, respectively.<br>
The scalars menu lists the names of the scalar arrays and the components of the vector arrays of either the point-centered or cell-centered data. The vectors menu lists the names of the point-centered or cell-centered vector arrays. The function will be computed for each point (or cell) using the scalar or vector value of the array at that point (or cell).<br>
The filter operates on any type of data set, but the input data set must have at least one scalar or vector array. The arrays can be either point-centered or cell-centered. The Calculator filter's output is of the same data set type as the input.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 401: Line 369:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Attribute Mode'''<br>''(AttributeMode)''
|'''Input''' (Input)
|
This property specifies the volume input of the
filter.
|
|
This property determines whether the computation is to be performed on point-centered or cell-centered data.


| 0
|
|
The value must be one of the following: point_data (1), cell_data (2), field_data (5).
Accepts input of following types:
* vtkNonOverlappingAMR
The dataset must contain a field array (cell)


with 1 component(s).


|-
|-
| '''Coordinate Results'''<br>''(CoordinateResults)''
|'''SelectMaterialArrays''' (SelectMaterialArrays)
|
This property specifies the cell arrays from which the
analysis will determine fragments
|
|
The value of this property determines whether the results of this computation should be used as point coordinates or as a new array.


| 0
|
|
Only the values 0 and 1 are accepted.
An array of scalars is required.
 
 
|-
|-
| '''Function'''<br>''(Function)''
|'''SelectMassArrays''' (SelectMassArrays)
|
This property specifies the cell arrays from which the
analysis will determine fragment mass
|
|
This property contains the equation for computing the new array.


|
|
An array of scalars is required.
|-
|'''SelectVolumeWeightedArrays''' (SelectVolumeWeightedArrays)
|
|
|-
This property specifies the cell arrays from which the
| '''Input'''<br>''(Input)''
analysis will determine volume weighted average values
|
|
This property specifies the input dataset to the Calculator filter. The scalar and vector variables may be chosen from this dataset's arrays.


|
|
An array of scalars is required.
|-
|'''SelectMassWeightedArrays''' (SelectMassWeightedArrays)
|
This property specifies the cell arrays from which the
analysis will determine mass weighted average values
|
|
The selected object must be the result of the following: sources (includes readers), filters.
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.


|
An array of scalars is required.
|-
|'''Volume Fraction Value''' (VolumeFractionSurfaceValue)
|
This property specifies the values at which to compute
the isosurface.
|
0.1
|


|-
|-
| '''Replace Invalid Results'''<br>''(ReplaceInvalidValues)''
|'''Extract Surface''' (Extract Surface)
|
|
This property determines whether invalid values in the computation will be replaced with a specific value. (See the ReplacementValue property.)
Whether or not to extract a surface from this data
 
|
| 1
0
|
|
Only the values 0 and 1 are accepted.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Replacement Value'''<br>''(ReplacementValue)''
|'''Use Watertight Surface''' (Use Watertight Surface)
|
Whether the extracted surface should be watertight or not
|
|
If invalid values in the computation are to be replaced with another value, this property contains that value.
0
 
| 0
|
|
Accepts boolean values (0 or 1).
|-
|-
| '''Result Array Name'''<br>''(ResultArrayName)''
|'''Integrate Fragments''' (Integrate Fragments)
|
|
This property contains the name for the output array containing the result of this computation.
Whether or not to integrate fragments in this data
|
1
|
Accepts boolean values (0 or 1).


| Result
|
|}
|}


==Add Field Arrays==


==Cell Centers==
Reads arrays from a file and adds them to the input data object.
 
Takes in an input data object and a filename. Opens the file
 
and adds any arrays it sees there to the input data.
Create a point (no geometry) at the center of each input cell.


The Cell Centers filter places a point at the center of each cell in the input data set. The center computed is the parametric center of the cell, not necessarily the geometric or bounding box center. The cell attributes of the input will be associated with these newly created points of the output. You have the option of creating a vertex cell per point in the outpuut. This is useful because vertex cells are rendered, but points are not. The points themselves could be used for placing glyphs (using the Glyph filter). The Cell Centers filter takes any type of data set as input and produces a polygonal data set as output.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 481: Line 469:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Input'''<br>''(Input)''
|'''Input''' (Input)
|
The input.
|
|
This property specifies the input to the Cell Centers filter.


|
|
|-
|'''FileName''' (FileName)
|
|
The selected object must be the result of the following: sources (includes readers), filters.


The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
This property specifies the file to read to get arrays


|-
| '''Vertex Cells'''<br>''(VertexCells)''
|
|
If set to 1, a vertex cell will be generated per point in the output. Otherwise only points will be generated.


| 0
|
|
Only the values 0 and 1 are accepted.
The value(s) must be a filename (or filenames).
 


|}
|}


==Angular Periodic Filter==


==Cell Data to Point Data==
This filter generate a periodic multiblock dataset.This filter generate a periodic
 
multiblock dataset
 
Create point attributes by averaging cell attributes.
 
The Cell Data to Point Data filter averages the values of the cell attributes of the cells surrounding a point to compute point attributes. The Cell Data to Point Data filter operates on any type of data set, and the output data set is of the same type as the input.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 520: Line 502:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Input'''<br>''(Input)''
|'''Input''' (Input)
|
|
This property specifies the input to the Cell Data to Point Data filter.
This property specifies the input to the Periodic filter.


|
|
|
Accepts input of following types:
* vtkDataSet
|-
|'''BlockIndices''' (BlockIndices)
|
This property lists the ids of the blocks to make periodic
from the input multiblock dataset.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
The dataset must contain a cell array.
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.


|


|-
|-
| '''Pass Cell Data'''<br>''(PassCellData)''
|'''IterationMode''' (IterationMode)
|
This property specifies the mode of iteration, either a user-provided number
of periods, or the maximum number of periods to rotate to 360°.
|
1
|
The value(s) is an enumeration of the following:
* Manual (0)
* Maximum (1)
|-
|'''NumberOfPeriods''' (NumberOfPeriods)
|
|
If this property is set to 1, then the input cell data is passed through to the output; otherwise, only the generated point data will be available in the output.
This property specifies the number of iteration
 
|
| 0
3
|
|
Only the values 0 and 1 are accepted.


|-
|'''RotationMode''' (RotationMode)
|
This property specifies the mode of rotation, either from a user provided
angle or from an array in the data.
|
0
|
The value(s) is an enumeration of the following:
* Direct Angle (0)
* Array Value (1)
|-
|'''RotationAngle''' (RotationAngle)
|
Rotation angle in degree.


|}
|
 
10
|


==Clean==
|-
|'''RotationArrayName''' (RotationArrayName)
|
Field array name that contains the rotation angle in radian.
 
|
periodic angle
|
 
|-
|'''Axis''' (Axis)
|
This property specifies the axis of rotation
|
0
|
The value(s) is an enumeration of the following:
* Axis X (0)
* Axis Y (1)
* Axis Z (2)
|-
|'''Center''' (Center)
|
This property specifies the 3D coordinates for the
center of the rotation.
|
0.0 0.0 0.0
|
 
 
|}


==Annotate Attribute Data==


Merge coincident points if they do not meet a feature edge criteria.
Adds a text annotation to a Rander View
This filter can be used to add a text annotation to a Render View (or
similar) using a tuple from any attribute array (point/cell/field/row
etc.) from a specific rank (when running in parallel). Use **ArrayName**
property to select the array association and array name. Use
**ElementId* property to set the element number to extract the value to
label with. When running on multiple ranks, use **ProcessId** property
to select the rank of interest. The **Prefix** property can be used to
specify a string that will be used as the prefix to the generated
annotation text.


The Clean filter takes polygonal data as input and generates polygonal data as output. This filter can merge duplicate points, remove unused points, and transform degenerate cells into their appropriate forms (e.g., a triangle is converted into a line if two of its points are merged).<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 562: Line 613:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Absolute Tolerance'''<br>''(AbsoluteTolerance)''
|'''Input''' (Input)
|
If merging nearby points (see PointMerging property) and using absolute tolerance (see ToleranceIsAbsolute property), this property specifies the tolerance for performing merging in the spatial units of the input data set.
 
| 1
|
|
The value must be greater than or equal to 0.


Set the input of the filter. To avoid the complications/confusion when identifying
elements in a composite dataset, this filter doesn't support composite datasets
currently.


|-
| '''Convert Lines To Points'''<br>''(ConvertLinesToPoints)''
|
|
If this property is set to 1, degenerate lines (a "line" whose endpoints are at the same spatial location) will be converted to points.


| 1
|
|
Only the values 0 and 1 are accepted.
Accepts input of following types:
* vtkDataSet
* vtkTable
The dataset must contain a field array (any)


with 1 component(s).


|-
|-
| '''Convert Polys To Lines'''<br>''(ConvertPolysToLines)''
|'''ArrayAssociation''' (ArrayAssociation)
|
|
If this property is set to 1, degenerate polygons (a "polygon" with only two distinct point coordinates) will be converted to lines.
Select the attribute to use to popular array names from.
 
|
| 1
2
|
|
Only the values 0 and 1 are accepted.
The value(s) is an enumeration of the following:
 
* Point Data (0)
 
* Cell Data (1)
* Field Data (2)
* Row Data (6)
|-
|-
| '''Convert Strips To Polys'''<br>''(ConvertStripsToPolys)''
|'''ArrayName''' (ArrayName)
|
Choose arrays that is going to be displayed
|
|
If this property is set to 1, degenerate triangle strips (a triangle "strip" containing only one triangle) will be converted to triangles.


| 1
|
|
Only the values 0 and 1 are accepted.


|-
|-
| '''Input'''<br>''(Input)''
|'''ElementId''' (ElementId)
|
|
Set the input to the Clean filter.
 
Set the element index to annotate with.


|
|
0
|
|
The selected object must be the result of the following: sources (includes readers), filters.


|-
|'''ProcessId''' (ProcessId)
|


The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
Set the process rank to extract element from.


|-
| '''Piece Invariant'''<br>''(PieceInvariant)''
|
|
If this property is set to 1, the whole data set will be processed at once so that cleaning the data set always produces the same results. If it is set to 0, the data set can be processed one piece at a time, so it is not necessary for the entire data set to fit into memory; however the results are not guaranteed to be the same as they would be if the Piece invariant option was on. Setting this option to 0 may produce seams in the output dataset when ParaView is run in parallel.
0
 
| 1
|
|
Only the values 0 and 1 are accepted.


|-
|-
| '''Point Merging'''<br>''(PointMerging)''
|'''Prefix''' (Prefix)
|
Text that is used as a prefix to the field value
|
|
If this property is set to 1, then points will be merged if they are within the specified Tolerance or AbsoluteTolerance (see the Tolerance and AbsoluteTolerance propertys), depending on the value of the ToleranceIsAbsolute property. (See the ToleranceIsAbsolute property.) If this property is set to 0, points will not be merged.
Value is:
 
| 1
|
|
Only the values 0 and 1 are accepted.




|-
|}
| '''Tolerance'''<br>''(Tolerance)''
|
If merging nearby points (see PointMerging property) and not using absolute tolerance (see ToleranceIsAbsolute property), this property specifies the tolerance for performing merging as a fraction of the length of the diagonal of the bounding box of the input data set.


| 0
==Annotate Global Data==
|
The value must be greater than or equal to 0 and less than or equal to 1.


Filter for annotating with global data (designed for ExodusII reader)
Annotate Global Data provides a simpler API for creating text
annotations using vtkPythonAnnotationFilter. Instead of users
specifying the annotation expression, this filter determines the
expression based on the array selected by limiting the scope of the
functionality. This filter only allows the user to annotate using
"global-data" aka field data and specify the string prefix to use. If
the field array chosen has as many elements as number of timesteps,
the array is assumed to be "temporal" and indexed using the current
timestep.


|-
| '''Tolerance Is Absolute'''<br>''(ToleranceIsAbsolute)''
|
This property determines whether to use absolute or relative (a percentage of the bounding box) tolerance when performing point merging.
| 0
|
Only the values 0 and 1 are accepted.
|}
==Clean to Grid==
This filter merges points and converts the data set to unstructured grid.
The Clean to Grid filter merges points that are exactly coincident. It also converts the data set to an unstructured grid. You may wish to do this if you want to apply a filter to your data set that is available for unstructured grids but not for the initial type of your data set (e.g., applying warp vector to volumetric data). The Clean to Grid filter operates on any type of data set.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 671: Line 703:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Input'''<br>''(Input)''
|'''Input''' (Input)
|
|
This property specifies the input to the Clean to Grid filter.
Set the input of the filter.
|
 
|
Accepts input of following types:
* vtkDataSet
The dataset must contain a field array (none)


with 1 component(s).
|-
|'''SelectArrays''' (SelectArrays)
|
|
Choose arrays that is going to be
displayed
|
|
The selected object must be the result of the following: sources (includes readers), filters.


|


The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
|-
|'''Prefix''' (Prefix)
|
Text that is used as a prefix to the field
value
|
Value is:  
|


|-
|'''Suffix''' (Suffix)
|
Text that is used as a suffix to the field
value
|


|}
|




==Clip==
|}


==Annotate Time Filter==


Clip with an implicit plane. Clipping does not reduce the dimensionality of the data set. The output data type of this filter is always an unstructured grid.
Shows input data time as text annnotation in the view.The Annotate Time
 
filter can be used to show the data time in a text
The Clip filter cuts away a portion of the input data set using an implicit plane. This filter operates on all types of data sets, and it returns unstructured grid data on output.<br>
annotation.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 700: Line 759:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Clip Type'''<br>''(ClipFunction)''
|'''Input''' (Input)
|
This property specifies the input dataset for which to
display the time.
|
|
This property specifies the parameters of the clip function (an implicit plane) used to clip the dataset.


|
|
|
The value must be set to one of the following: Plane, Box, Sphere, Scalar.


|-
|-
| '''Input'''<br>''(Input)''
|'''Format''' (Format)
|
|
This property specifies the dataset on which the Clip filter will operate.
The value of this property is a format string used to
 
display the input time. The format string is specified using printf
style.
|
|
Time: %f
|
|
The selected object must be the result of the following: sources (includes readers), filters.
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.


|-
|-
| '''Inside Out'''<br>''(InsideOut)''
|'''Shift''' (Shift)
|
The amount of time the input is shifted (after
scaling).
|
|
If this property is set to 0, the clip filter will return that portion of the dataset that lies within the clip function. If set to 1, the portions of the dataset that lie outside the clip function will be returned instead.
0.0
 
| 0
|
|
Only the values 0 and 1 are accepted.


|-
|-
| '''Scalars'''<br>''(SelectInputScalars)''
|'''Scale''' (Scale)
|
|
If clipping with scalars, this property specifies the name of the scalar array on which to perform the clip operation.
The factor by which the input time is
 
scaled.
|
|
1.0
|
|
An array of scalars is required.




Valud array names will be chosen from point and cell data.
|}
 
==Append Attributes==


Copies geometry from first input. Puts all of the arrays into the output.
The Append Attributes filter takes multiple input data
sets with the same geometry and merges their point and
cell attributes to produce a single output containing all
the point and cell attributes of the inputs. Any inputs
without the same number of points and cells as the first
input are ignored. The input data sets must already be
collected together, either as a result of a reader that
loads multiple parts (e.g., EnSight reader) or because the
Group Parts filter has been run to form a collection of
data sets.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Use Value As Offset'''<br>''(UseValueAsOffset)''
| '''Property'''
|
| '''Description'''
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.
| '''Default Value(s)'''
| '''Restrictions'''


| 0
|-
|'''Input''' (Input)
|
|
Only the values 0 and 1 are accepted.
This property specifies the input to the Append
 
Attributes filter.
 
|-
| '''Value'''<br>''(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 ParaView's user interface.


| 0
|
|
The value must lie within the range of the selected data array.
Accepts input of following types:
 
* vtkDataSet


|}
|}


==Append Datasets==


==Clip Closed Surface==
Takes an input of multiple datasets and output has only one unstructured grid.The Append
 
Datasets filter operates on multiple data sets of any type
 
(polygonal, structured, etc.). It merges their geometry
Clip a polygonal dataset with a plane to produce closed surfaces
into a single data set. Only the point and cell attributes
 
that all of the input data sets have in common will appear
This clip filter cuts away a portion of the input polygonal dataset using a plane to generate a new polygonal dataset.<br>
in the output. The input data sets must already be
collected together, either as a result of a reader that
loads multiple parts (e.g., EnSight reader) or because the
Group Parts filter has been run to form a collection of
data sets.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 782: Line 853:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Base Color'''<br>''(BaseColor)''
|'''Input''' (Input)
|
This property specifies the datasets to be merged into a
single dataset by the Append Datasets filter.
|
|
Specify the color for the faces from the input.


| 0.1 0.1 1
|
|
The value must be greater than or equal to (0, 0, 0) and less than or equal to (1, 1, 1).
Accepts input of following types:
* vtkDataSet


|}


|-
==Append Geometry==
| '''Clip Color'''<br>''(ClipColor)''
|
Specifiy the color for the capping faces (generated on the clipping interface).


| 1 0.11 0.1
Takes an input of multiple poly data parts and output has only one part.The Append
|
Geometry filter operates on multiple polygonal data sets.
The value must be greater than or equal to (0, 0, 0) and less than or equal to (1, 1, 1).
It merges their geometry into a single data set. Only the
point and cell attributes that all of the input data sets
have in common will appear in the output.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


|-
|-
| '''Clipping Plane'''<br>''(ClippingPlane)''
|'''Input''' (Input)
|
Set the input to the Append Geometry
filter.
|
|
This property specifies the parameters of the clipping plane used to clip the polygonal data.


|
|
|
Accepts input of following types:
The value must be set to one of the following: Plane.
* vtkPolyData


|}


|-
==Block Scalars==
| '''Generate Cell Origins'''<br>''(GenerateColorScalars)''
|
Generate (cell) data for coloring purposes such that the newly generated cells (including capping faces and clipping outlines) can be distinguished from the input cells.


| 0
The Level Scalars filter uses colors to show levels of a multiblock dataset.The Level
|
Scalars filter uses colors to show levels of a multiblock
Only the values 0 and 1 are accepted.
dataset.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


|-
|-
| '''Generate Faces'''<br>''(GenerateFaces)''
|'''Input''' (Input)
|
This property specifies the input to the Level Scalars
filter.
|
|
Generate polygonal faces in the output.


| 1
|
|
Only the values 0 and 1 are accepted.
Accepts input of following types:
* vtkMultiBlockDataSet


|}


|-
==CTH Surface==
| '''Generate Outline'''<br>''(GenerateOutline)''
|
Generate clipping outlines in the output wherever an input face is cut by the clipping plane.
 
| 0
|
Only the values 0 and 1 are accepted.


Not finished yet.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Input'''<br>''(Input)''
| '''Property'''
|
| '''Description'''
This property specifies the dataset on which the Clip filter will operate.
| '''Default Value(s)'''
 
| '''Restrictions'''
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
 


|-
|-
| '''Inside Out'''<br>''(InsideOut)''
|'''Input''' (Input)
|
|
If this flag is turned off, the clipper will return the portion of the data that lies within the clipping plane. Otherwise, the clipper will return the portion of the data that lies outside the clipping plane.
This property specifies the input of the
 
filter.
| 0
|
|
Only the values 0 and 1 are accepted.


|-
| '''Clipping Tolerance'''<br>''(Tolerance)''
|
|
Specify the tolerance for creating new points. A small value might incur degenerate triangles.
Accepts input of following types:
* vtkCompositeDataSet


| 1e-06
|
|}
|}


==CacheKeeper==


==Compute Derivatives==
vtkPVCacheKeeper manages data cache for flip book
 
animations. When caching is disabled, this simply acts as a pass through
 
filter. When caching is enabled, is the current time step has been
This filter computes derivatives of scalars and vectors.
previously cached then this filter shuts the update request, otherwise
 
propagates the update and then cache the result for later use. The
CellDerivatives is a filter that computes derivatives of scalars and vectors at the center of cells. You can choose to generate different output including the scalar gradient (a vector), computed tensor vorticity (a vector), gradient of input vectors (a tensor), and strain matrix of the input vectors (a tensor); or you may choose to pass data through to the output.<br>
current time step is set using SetCacheTime().


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 888: Line 960:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.


|-
|-
| '''Output Tensor Type'''<br>''(OutputTensorType)''
|'''Input''' (Input)
|
|
This property controls how the filter works to generate tensor cell data. You can choose to compute the gradient of the input vectors, or compute the strain tensor of the vector gradient tensor. By default, the filter will take the gradient of the vector data to construct a tensor.
Set the input to the Update Suppressor
 
filter.
| 1
|
|
The value must be one of the following: Nothing (0), Vector Gradient (1), Strain (2).


|-
| '''Output Vector Type'''<br>''(OutputVectorType)''
|
This property Controls how the filter works to generate vector cell data. You can choose to compute the gradient of the input scalars, or extract the vorticity of the computed vector gradient tensor. By default, the filter will take the gradient of the input scalar data.
| 1
|
|
The value must be one of the following: Nothing (0), Scalar Gradient (1), Vorticity (2).


|-
|-
| '''Scalars'''<br>''(SelectInputScalars)''
|'''CacheTime''' (CacheTime)
|
|
This property indicates the name of the scalar array to differentiate.


|
|
0.0
|
|
An array of scalars is required.


|-
|-
| '''Vectors'''<br>''(SelectInputVectors)''
|'''CachingEnabled''' (CachingEnabled)
|
|
This property indicates the name of the vector array to differentiate.
Toggle whether the caching is enabled.
 
|
| 1
1
|
|
An array of vectors is required.
Accepts boolean values (0 or 1).
 


|}
|}


==Calculator==


==Connectivity==
Compute new attribute arrays as function of existing arrays.
The Calculator filter computes a new data array or new point
coordinates as a function of existing scalar or vector arrays. If
point-centered arrays are used in the computation of a new data array,
the resulting array will also be point-centered. Similarly,
computations using cell-centered arrays will produce a new
cell-centered array. If the function is computing point coordinates,
the result of the function must be a three-component vector.


The Calculator interface operates similarly to a scientific
calculator. In creating the function to evaluate, the standard order
of operations applies. Each of the calculator functions is described
below. Unless otherwise noted, enclose the operand in parentheses
using the ( and ) buttons.


Mark connected components with integer point attribute array.
- Clear: Erase the current function (displayed in the read-only text
box above the calculator buttons).
- /: Divide one scalar by another. The operands for this function are
not required to be enclosed in parentheses.
- *: Multiply two scalars, or multiply a vector by a scalar (scalar multiple).
The operands for this function are not required to be enclosed in parentheses.
- -: Negate a scalar or vector (unary minus), or subtract one scalar or vector
from another. The operands for this function are not required to be enclosed
in parentheses.
- +: Add two scalars or two vectors. The operands for this function are not
required to be enclosed in parentheses.
- sin: Compute the sine of a scalar. cos: Compute the cosine of a scalar.
- tan: Compute the tangent of a scalar.
- asin: Compute the arcsine of a scalar.
- acos: Compute the arccosine of a scalar.
- atan: Compute the arctangent of a scalar.
- sinh: Compute the hyperbolic sine of a scalar.
- cosh: Compute the hyperbolic cosine of a scalar.
- tanh: Compute the hyperbolic tangent of a scalar.
- min: Compute minimum of two scalars.
- max: Compute maximum of two scalars.
- x^y: Raise one scalar to the power of another scalar. The operands for
this function are not required to be enclosed in parentheses.
- sqrt: Compute the square root of a scalar.
- e^x: Raise e to the power of a scalar.
- log: Compute the logarithm of a scalar (deprecated. same as log10).
- log10: Compute the logarithm of a scalar to the base 10.
- ln: Compute the logarithm of a scalar to the base 'e'.
- ceil: Compute the ceiling of a scalar. floor: Compute the floor of a scalar.
- abs: Compute the absolute value of a scalar.
- v1.v2: Compute the dot product of two vectors. The operands for this
function are not required to be enclosed in parentheses.
- cross: Compute cross product of two vectors.
- mag: Compute the magnitude of a vector.
- norm: Normalize a vector.


The Connectivity filter assigns a region id to connected components of the input data set. (The region id is assigned as a point scalar value.) This filter takes any data set type as input and produces unstructured grid output.<br>
The operands are described below. The digits 0 - 9 and the decimal
point are used to enter constant scalar values. **iHat**, **jHat**,
and **kHat** are vector constants representing unit vectors in the X,
Y, and Z directions, respectively. The scalars menu lists the names of
the scalar arrays and the components of the vector arrays of either
the point-centered or cell-centered data. The vectors menu lists the
names of the point-centered or cell-centered vector arrays. The
function will be computed for each point (or cell) using the scalar or
vector value of the array at that point (or cell). The filter operates
on any type of data set, but the input data set must have at least one
scalar or vector array. The arrays can be either point-centered or
cell-centered. The Calculator filter's output is of the same data set
type as the input.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 957: Line 1,062:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Color Regions'''<br>''(ColorRegions)''
|'''Input''' (Input)
|
This property specifies the input dataset to the
Calculator filter. The scalar and vector variables may be chosen from
this dataset's arrays.
|
|
Controls the coloring of the connected regions.


| 1
|
|
Only the values 0 and 1 are accepted.
Accepts input of following types:
 
* vtkDataSet
The dataset must contain a field array ()


|-
|-
| '''Extraction Mode'''<br>''(ExtractionMode)''
|'''AttributeMode''' (AttributeMode)
|
|
Controls the extraction of connected surfaces.
This property determines whether the computation is to
 
be performed on point-centered or cell-centered data.
| 5
|
1
|
|
The value must be one of the following: Extract Point Seeded Regions (1), Extract Cell Seeded Regions (2), Extract Specified Regions (3), Extract Largest Region (4), Extract All Regions (5), Extract Closes Point Region (6).
The value(s) is an enumeration of the following:
 
* Point Data (1)
 
* Cell Data (2)
|-
|'''CoordinateResults''' (CoordinateResults)
|
The value of this property determines whether the
results of this computation should be used as point coordinates or as a
new array.
|
0
|
Accepts boolean values (0 or 1).
|-
|'''ResultNormals''' (ResultNormals)
|
Set whether to output results as point/cell
normals. Outputing as normals is only valid with vector
results. Point or cell normals are selected using
AttributeMode.
|
0
|
Accepts boolean values (0 or 1).
|-
|'''ResultTCoords''' (ResultTCoords)
|
Set whether to output results as point/cell
texture coordinates. Point or cell texture coordinates are
selected using AttributeMode. 2-component texture coordinates
cannot be generated at this time.
|
0
|
Accepts boolean values (0 or 1).
|-
|-
| '''Input'''<br>''(Input)''
|'''ResultArrayName''' (ResultArrayName)
|
|
This property specifies the input to the Connectivity filter.
This property contains the name for the output array
 
containing the result of this computation.
|
|
Result
|
|
The selected object must be the result of the following: sources (includes readers), filters.


|-
|'''Function''' (Function)
|


The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
This property contains the equation for computing the new
array.


|


|}
|


|-
|'''Replace Invalid Results''' (ReplaceInvalidValues)
|
This property determines whether invalid values in the
computation will be replaced with a specific value. (See the
ReplacementValue property.)
|
1
|
Accepts boolean values (0 or 1).
|-
|'''ReplacementValue''' (ReplacementValue)
|
If invalid values in the computation are to be replaced
with another value, this property contains that value.
|
0.0
|


==Contingency Statistics==


|}


Compute a statistical model of a dataset and/or assess the dataset with a statistical model.
==Cell Centers==


This filter either computes a statistical model of a dataset or takes such a model as its second input.  Then, the model (however it is obtained) may optionally be used to assess the input dataset.<br>
Create a point (no geometry) at the center of each input cell.The Cell Centers
This filter computes contingency tables between pairs of attributes. This result is a tabular bivariate probability distribution which serves as a Bayesian-style prior model. Data is assessed by computing <br>
filter places a point at the center of each cell in the
*  the probability of observing both variables simultaneously;<br>
input data set. The center computed is the parametric
*  the probability of each variable conditioned on the other (the two values need not be identical); and<br>
center of the cell, not necessarily the geometric or
*  the pointwise mutual information (PMI).
bounding box center. The cell attributes of the input will
<br>
be associated with these newly created points of the
Finally, the summary statistics include the information entropy of the observations.<br>
output. You have the option of creating a vertex cell per
point in the outpuut. This is useful because vertex cells
are rendered, but points are not. The points themselves
could be used for placing glyphs (using the Glyph filter).
The Cell Centers filter takes any type of data set as
input and produces a polygonal data set as
output.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,012: Line 1,183:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Attribute Mode'''<br>''(AttributeMode)''
|'''Input''' (Input)
|
This property specifies the input to the Cell Centers
filter.
|
|
Specify which type of field data the arrays will be drawn from.


| 0
|
|
Valud array names will be chosen from point and cell data.
Accepts input of following types:
 
* vtkDataSet
 
|-
|-
| '''Input'''<br>''(Input)''
|'''VertexCells''' (VertexCells)
|
|
The input to the filter. Arrays from this dataset will be used for computing statistics and/or assessed by a statistical model.
If set to 1, a vertex cell will be generated per point
 
in the output. Otherwise only points will be generated.
|
|
0
|
|
The selected object must be the result of the following: sources (includes readers), filters.
Accepts boolean values (0 or 1).


|}


The dataset must contain a point or cell array.
==Cell Data to Point Data==


Create point attributes by averaging cell attributes.The Cell
Data to Point Data filter averages the values of the cell
attributes of the cells surrounding a point to compute
point attributes. The Cell Data to Point Data filter
operates on any type of data set, and the output data set
is of the same type as the input.


The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData, vtkStructuredGrid, vtkPolyData, vtkUnstructuredGrid, vtkTable, vtkGraph.
{| class="PropertiesTable" border="1" cellpadding="5"
 
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


|-
|-
| '''Model Input'''<br>''(ModelInput)''
|'''Input''' (Input)
|
This property specifies the input to the Cell Data to
Point Data filter.
|
|
A previously-calculated model with which to assess a separate dataset. This input is optional.


|
|
|
Accepts input of following types:
The selected object must be the result of the following: sources (includes readers), filters.
* vtkDataSet
The dataset must contain a field array (cell)


 
|-
The selected dataset must be one of the following types (or a subclass of one of them): vtkTable, vtkMultiBlockDataSet.
|'''PassCellData''' (PassCellData)
 
 
|-
| '''Variables of Interest'''<br>''(SelectArrays)''
|
|
Choose arrays whose entries will be used to form observations for statistical analysis.
If this property is set to 1, then the input cell data
 
is passed through to the output; otherwise, only the generated point
data will be available in the output.
|
|
0
|
|
An array of scalars is required.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Task'''<br>''(Task)''
|'''PieceInvariant''' (PieceInvariant)
|
|
Specify the task to be performed: modeling and/or assessment.
If the value of this property is set to 1, this filter
#  "Statistics of all the data," creates an output table (or tables) summarizing the '''entire''' input dataset;
will request ghost levels so that the values at boundary points match
#  "Model a subset of the data," creates an output table (or tables) summarizing a '''randomly-chosen subset''' of the input dataset;
across processes. NOTE: Enabling this option might cause multiple
#  "Assess the data with a model," adds attributes to the first input dataset using a model provided on the second input port; and
executions of the data source because more information is needed to
#  "Model and assess the same data," is really just operations 2 and 3 above applied to the same input dataset.  The model is first trained using a fraction of the input data and then the entire dataset is assessed using that model.
remove internal surfaces.
 
When the task includes creating a model (i.e., tasks 2, and 4), you may adjust the fraction of the input dataset used for training.  You should avoid using a large fraction of the input data for training as you will then not be able to detect overfitting.  The ''Training fraction'' setting will be ignored for tasks 1 and 3.
 
| 3
|
|
The value must be one of the following: Statistics of all the data (0), Model a subset of the data (1), Assess the data with a model (2), Model and assess the same data (3).
0
 
 
|-
| '''Training Fraction'''<br>''(TrainingFraction)''
|
|
Specify the fraction of values from the input dataset to be used for model fitting. The exact set of values is chosen at random from the dataset.
Accepts boolean values (0 or 1).
 
| 0.1
|
The value must be greater than or equal to 0 and less than or equal to 1.
 


|}
|}


==Clean==


==Contour==
Merge coincident points if they do not meet a feature edge criteria.The Clean filter
 
takes polygonal data as input and generates polygonal data
 
as output. This filter can merge duplicate points, remove
Generate isolines or isosurfaces using point scalars.
unused points, and transform degenerate cells into their
 
appropriate forms (e.g., a triangle is converted into a
The Contour filter computes isolines or isosurfaces using a selected point-centered scalar array. The Contour filter operates on any type of data set, but the input is required to have at least one point-centered scalar (single-component) array. The output of this filter is polygonal.<br>
line if two of its points are merged).


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,103: Line 1,274:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Compute Gradients'''<br>''(ComputeGradients)''
|'''Input''' (Input)
|
Set the input to the Clean filter.
|
|
If this property is set to 1, a scalar array containing a gradient value at each point in the isosurface or isoline will be created by this filter; otherwise an array of gradients will not be computed. This operation is fairly expensive both in terms of computation time and memory required, so if the output dataset produced by the contour filter will be processed by filters that modify the dataset's topology or geometry, it may be wise to set the value of this property to 0. Not that if ComputeNormals is set to 1, then gradients will have to be calculated, but they will only be stored in the output dataset if ComputeGradients is also set to 1.


| 0
|
|
Only the values 0 and 1 are accepted.
Accepts input of following types:
 
* vtkPolyData
 
|-
|-
| '''Compute Normals'''<br>''(ComputeNormals)''
|'''PieceInvariant''' (PieceInvariant)
|
If this property is set to 1, the whole data set will be
processed at once so that cleaning the data set always produces the
same results. If it is set to 0, the data set can be processed one
piece at a time, so it is not necessary for the entire data set to fit
into memory; however the results are not guaranteed to be the same as
they would be if the Piece invariant option was on. Setting this option
to 0 may produce seams in the output dataset when ParaView is run in
parallel.
|
|
If this property is set to 1, a scalar array containing a normal value at each point in the isosurface or isoline will be created by the contour filter; otherwise an array of normals will not be computed. This operation is fairly expensive both in terms of computation time and memory required, so if the output dataset produced by the contour filter will be processed by filters that modify the dataset's topology or geometry, it may be wise to set the value of this property to 0.
1
Select whether to compute normals.
 
| 1
|
|
Only the values 0 and 1 are accepted.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Compute Scalars'''<br>''(ComputeScalars)''
|'''Tolerance''' (Tolerance)
|
|
If this property is set to 1, an array of scalars (containing the contour value) will be added to the output dataset. If set to 0, the output will not contain this array.
If merging nearby points (see PointMerging property) and
 
not using absolute tolerance (see ToleranceIsAbsolute property), this
| 0
property specifies the tolerance for performing merging as a fraction
of the length of the diagonal of the bounding box of the input data
set.
|
0.0
|
|
Only the values 0 and 1 are accepted.


|-
|-
| '''Isosurfaces'''<br>''(ContourValues)''
|'''AbsoluteTolerance''' (AbsoluteTolerance)
|
|
This property specifies the values at which to compute isosurfaces/isolines and also the number of such values.
If merging nearby points (see PointMerging property) and
 
using absolute tolerance (see ToleranceIsAbsolute property), this
property specifies the tolerance for performing merging in the spatial
units of the input data set.
|
|
1.0
|
|
The value must lie within the range of the selected data array.


|-
|-
| '''Input'''<br>''(Input)''
|'''ToleranceIsAbsolute''' (ToleranceIsAbsolute)
|
|
This property specifies the input dataset to be used by the contour filter.
This property determines whether to use absolute or
 
relative (a percentage of the bounding box) tolerance when performing
point merging.
|
|
0
|
|
The selected object must be the result of the following: sources (includes readers), filters.
Accepts boolean values (0 or 1).
 
 
The dataset must contain a point or cell array with 1 components.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
|-
| '''Point Merge Method'''<br>''(Locator)''
|'''ConvertLinesToPoints''' (ConvertLinesToPoints)
|
|
This property specifies an incremental point locator for merging duplicate / coincident points.
If this property is set to 1, degenerate lines (a "line"
 
whose endpoints are at the same spatial location) will be converted to
points.
|
|
1
|
|
The selected object must be the result of the following: incremental_point_locators.
Accepts boolean values (0 or 1).
 
 
The value must be set to one of the following: MergePoints, IncrementalOctreeMergePoints, NonMergingPointLocator.
 
 
|-
|-
| '''Contour By'''<br>''(SelectInputScalars)''
|'''ConvertPolysToLines''' (ConvertPolysToLines)
|
|
This property specifies the name of the scalar array from which the contour filter will compute isolines and/or isosurfaces.
If this property is set to 1, degenerate polygons (a
 
"polygon" with only two distinct point coordinates) will be converted
to lines.
|
|
1
|
|
An array of scalars is required.
Accepts boolean values (0 or 1).
 
|-
 
|'''ConvertStripsToPolys''' (ConvertStripsToPolys)
Valud array names will be chosen from point and cell data.
|
 
If this property is set to 1, degenerate triangle strips
(a triangle "strip" containing only one triangle) will be converted to
triangles.
|
1
|
Accepts boolean values (0 or 1).
|-
|'''PointMerging''' (PointMerging)
|
If this property is set to 1, then points will be merged
if they are within the specified Tolerance or AbsoluteTolerance (see
the Tolerance and AbsoluteTolerance propertys), depending on the value
of the ToleranceIsAbsolute property. (See the ToleranceIsAbsolute
property.) If this property is set to 0, points will not be
merged.
|
1
|
Accepts boolean values (0 or 1).


|}
|}


==Clean Cells to Grid==


==Cosmology FOF Halo Finder==
This filter merges cells and converts the data set to unstructured grid.Merges degenerate cells. Assumes
 
the input grid does not contain duplicate points. You may
 
want to run vtkCleanUnstructuredGrid first to assert it.
Sorry, no help is currently available.
If duplicated cells are found they are removed in the
 
output. The filter also handles the case, where a cell may
contain degenerate nodes (i.e. one and the same node is
referenced by a cell more than once).


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,201: Line 1,394:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''bb (linking length/distance)'''<br>''(BB)''
|'''Input''' (Input)
|
This property specifies the input to the Clean Cells to
Grid filter.
|
|
Linking length measured in units of interparticle spacing and is dimensionless.  Used to link particles into halos for the friend-of-a-friend algorithm.


| 0.2
|
|
The value must be greater than or equal to 0.
Accepts input of following types:
* vtkUnstructuredGrid


|}


|-
==Clean to Grid==
| '''Compute the most bound particle for halos'''<br>''(ComputeMostBoundParticle)''
|
If checked, the most bound particle will be calculated.  This can be very slow.


| 0
This filter merges points and converts the data set to unstructured grid.The Clean to Grid filter merges
|
points that are exactly coincident. It also converts the
Only the values 0 and 1 are accepted.
data set to an unstructured grid. You may wish to do this
if you want to apply a filter to your data set that is
available for unstructured grids but not for the initial
type of your data set (e.g., applying warp vector to
volumetric data). The Clean to Grid filter operates on any
type of data set.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


|-
|-
| '''Compute the most connected particle for halos'''<br>''(ComputeMostConnectedParticle)''
|'''Input''' (Input)
|
This property specifies the input to the Clean to Grid
filter.
|
|
If checked, the most connected particle will be calculated.  This can be very slow.


| 0
|
|
Only the values 0 and 1 are accepted.
Accepts input of following types:
* vtkDataSet


|}


|-
==ClientServerMoveData==
| '''Copy halo catalog information to original particles'''<br>''(CopyHaloDataToParticles)''
|
If checked, the halo catalog information will be copied to the original particles as well.


| 1
|
Only the values 0 and 1 are accepted.




{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Halo position for 3D visualization'''<br>''(HaloPositionType)''
| '''Property'''
|
| '''Description'''
This sets the position for the halo catalog particles (second output) in 3D space for visualization.  Input particle positions (first output) will be unaltered by this.  MBP and MCP for particle positions can potentially take a very long time to calculate.
| '''Default Value(s)'''
 
| '''Restrictions'''
| 0
|
The value must be one of the following: Average (0), Center of Mass (1), Most Bound Particle (2), Most Connected Particle (3).
 


|-
|-
| '''Input'''<br>''(Input)''
|'''Input''' (Input)
|
|
Set the input to the Client Server Move Data
filter.
|
|
|
|
The selected object must be the result of the following: sources (includes readers), filters.
The selected dataset must be one of the following types (or a subclass of one of them): vtkUnstructuredGrid.


|-
|-
| '''np (number of seeded particles in one dimension, i.e., total particles = np^3)'''<br>''(NP)''
|'''OutputDataType''' (OutputDataType)
|
|
Number of seeded particles in one dimension.  Therefore, total simulation particles is np^3 (cubed).


| 256
|
|
The value must be greater than or equal to 0.
0
 
|


|-
|-
| '''overlap (shared point/ghost cell gap distance)'''<br>''(Overlap)''
|'''WholeExtent''' (WholeExtent)
|
|
The space in rL units to extend processor particle ownership for ghost particles/cells.  Needed for correct halo calculation when halos cross processor boundaries in parallel computation.


| 5
|
|
The value must be greater than or equal to 0.
0 -1 0 -1 0 -1
|




|-
|}
| '''pmin (minimum particle threshold for a halo)'''<br>''(PMin)''
|
Minimum number of particles (threshold) needed before a group is called a halo.


| 10
==Clip==
|
The value must be greater than or equal to 1.


 
Clip with an implicit plane. 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
| '''rL (physical box side length)'''<br>''(RL)''
implicit plane. This filter operates on all types of data
|
sets, and it returns unstructured grid data on
The box side length used to wrap particles around if they exceed rL (or less than 0) in any dimension (only positive positions are allowed in the input, or the are wrapped around).
output.
 
| 90.1408
|
The value must be greater than or equal to 0.
 
 
|}
 
 
==Curvature==
 
 
This filter will compute the Gaussian or mean curvature of the mesh at each point.
 
The Curvature filter computes the curvature at each point in a polygonal data set. This filter supports both Gaussian and mean curvatures.<br><br><br>
; the type can be selected from the Curvature type menu button.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,319: Line 1,492:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Curvature Type'''<br>''(CurvatureType)''
|'''Input''' (Input)
|
This property specifies the dataset on which the Clip
filter will operate.
|
|
This propery specifies which type of curvature to compute.


| 0
|
|
The value must be one of the following: Gaussian (0), Mean (1).
Accepts input of following types:
* vtkDataSet
The dataset must contain a field array ()


with 1 component(s).


|-
|-
| '''Input'''<br>''(Input)''
|'''Clip Type''' (ClipFunction)
|
This property specifies the parameters of the clip
function (an implicit plane) used to clip the dataset.
|
|
This property specifies the input to the Curvature filter.


|
|
|
The value can be one of the following:
The selected object must be the result of the following: sources (includes readers), filters.
* Plane (implicit_functions)
 
* Box (implicit_functions)


* Sphere (implicit_functions)


The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
* Cylinder (implicit_functions)


* Scalar (implicit_functions)


|-
|-
| '''Invert Mean Curvature'''<br>''(InvertMeanCurvature)''
|'''InputBounds''' (InputBounds)
|
|
If this property is set to 1, the mean curvature calculation will be inverted. This is useful for meshes with inward-pointing normals.


| 0
|
|
Only the values 0 and 1 are accepted.
|}


|


==D3==
Repartition a data set into load-balanced spatially convex regions.  Create ghost cells if requested.
The D3 filter is available when ParaView is run in parallel. It operates on any type of data set to evenly divide it across the processors into spatially contiguous regions. The output of this filter is of type unstructured grid.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''Scalars''' (SelectInputScalars)
| '''Description'''
|
| '''Default Value(s)'''
If clipping with scalars, this property specifies the
| '''Restrictions'''
name of the scalar array on which to perform the clip
|-
operation.
| '''Boundary Mode'''<br>''(BoundaryMode)''
|
|
This property determines how cells that lie on processor boundaries are handled. The "Assign cells uniquely" option assigns each boundary cell to exactly one process, which is useful for isosurfacing. Selecting "Duplicate cells" causes the cells on the boundaries to be copied to each process that shares that boundary. The "Divide cells" option breaks cells across process boundary lines so that pieces of the cell lie in different processes. This option is useful for volume rendering.


| 0
|
|
The value must be one of the following: Assign cells uniquely (0), Duplicate cells (1), Divide cells (2).
An array of scalars is required.The value must be field array name.
 
 
|-
|-
| '''Input'''<br>''(Input)''
|'''Value''' (Value)
|
|
This property specifies the input to the D3 filter.
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
ParaView's user interface.
|
|
0.0
|
|
The selected object must be the result of the following: sources (includes readers), filters.
The value must lie within the range of the selected data array.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
|-
| '''Minimal Memory'''<br>''(UseMinimalMemory)''
|'''InsideOut''' (InsideOut)
|
|
If this property is set to 1, the D3 filter requires communication routines to use minimal memory than without this restriction.
If this property is set to 0, the clip filter will
 
return that portion of the dataset that lies within the clip function.
| 0
If set to 1, the portions of the dataset that lie outside the clip
function will be returned instead.
|
0
|
|
Only the values 0 and 1 are accepted.
Accepts boolean values (0 or 1).
 
|-
|'''UseValueAsOffset''' (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''' (PreserveInputCells)
|
This parameter controls whether to extract entire cells
in the given region or clip those cells so all of the output one stay
only inside that region.
|
0
|
Accepts boolean values (0 or 1).


|}
|}


==Clip Closed Surface==


==Decimate==
Clip a polygonal dataset with a plane to produce closed surfaces
 
This clip filter cuts away a portion of the input polygonal dataset using
 
a plane to generate a new polygonal dataset.
Simplify a polygonal model using an adaptive edge collapse algorithm.  This filter works with triangles only.
 
The Decimate filter reduces the number of triangles in a polygonal data set. Because this filter only operates on triangles, first run the Triangulate filter on a dataset that contains polygons other than triangles.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,417: Line 1,603:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Boundary Vertex Deletion'''<br>''(BoundaryVertexDeletion)''
|'''Input''' (Input)
|
This property specifies the dataset on which the Clip
filter will operate.
|
|
If this property is set to 1, then vertices on the boundary of the dataset can be removed. Setting the value of this property to 0 preserves the boundary of the dataset, but it may cause the filter not to reach its reduction target.


| 1
|
|
Only the values 0 and 1 are accepted.
Accepts input of following types:
* vtkPolyData
The dataset must contain a field array (point)


with 1 component(s).


|-
|-
| '''Feature Angle'''<br>''(FeatureAngle)''
|'''Clipping Plane''' (ClippingPlane)
|
This property specifies the parameters of the clipping
plane used to clip the polygonal data.
|
|
The value of thie property is used in determining where the data set may be split. If the angle between two adjacent triangles is greater than or equal to the FeatureAngle value, then their boundary is considered a feature edge where the dataset can be split.


| 15
|
|
The value must be greater than or equal to 0 and less than or equal to 180.
The value can be one of the following:
 
* Plane (implicit_functions)


|-
|-
| '''Input'''<br>''(Input)''
|'''GenerateFaces''' (GenerateFaces)
|
Generate polygonal faces in the output.
|
1
|
Accepts boolean values (0 or 1).
|-
|'''GenerateOutline''' (GenerateOutline)
|
Generate clipping outlines in the output wherever an
input face is cut by the clipping plane.
|
0
|
Accepts boolean values (0 or 1).
|-
|'''Generate Cell Origins''' (ScalarMode)
|
Generate (cell) data for coloring purposes such that the
newly generated cells (including capping faces and clipping outlines)
can be distinguished from the input cells.
|
0
|
The value(s) is an enumeration of the following:
* None (0)
* Color (1)
* Label (2)
|-
|'''InsideOut''' (InsideOut)
|
If this flag is turned off, the clipper will return the
portion of the data that lies within the clipping plane. Otherwise, the
clipper will return the portion of the data that lies outside the
clipping plane.
|
0
|
Accepts boolean values (0 or 1).
|-
|'''Clipping Tolerance''' (Tolerance)
|
|
This property specifies the input to the Decimate filter.
Specify the tolerance for creating new points. A small
 
value might incur degenerate triangles.
|
|
0.000001
|
|
The selected object must be the result of the following: sources (includes readers), filters.
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.


|-
|-
| '''Preserve Topology'''<br>''(PreserveTopology)''
|'''Base Color''' (BaseColor)
|
Specify the color for the faces from the
input.
|
|
If this property is set to 1, decimation will not split the dataset or produce holes, but it may keep the filter from reaching the reduction target. If it is set to 0, better reduction can occur (reaching the reduction target), but holes in the model may be produced.
0.10 0.10 1.00
 
| 0
|
|
Only the values 0 and 1 are accepted.


|-
|-
| '''Target Reduction'''<br>''(TargetReduction)''
|'''Clip Color''' (ClipColor)
|
Specifiy the color for the capping faces (generated on
the clipping interface).
|
|
This property specifies the desired reduction in the total number of polygons in the output dataset. For example, if the TargetReduction value is 0.9, the Decimate filter will attempt to produce an output dataset that is 10% the size of the input.)
1.00 0.11 0.10
 
| 0.9
|
|
The value must be greater than or equal to 0 and less than or equal to 1.




|}
|}


==Clip Generic Dataset==


==Delaunay 2D==
Clip with an implicit plane, sphere or with scalars. Clipping does not reduce the dimensionality of the data set. This output data type of this filter is always an unstructured grid.
The Generic Clip filter cuts away a portion of the input
data set using a plane, a sphere, a box, or a scalar
value. The menu in the Clip Function portion of the
interface allows the user to select which implicit
function to use or whether to clip using a scalar value.
Making this selection loads the appropriate user
interface. For the implicit functions, the appropriate 3D
widget (plane, sphere, or box) is also displayed. The use
of these 3D widgets, including their user interface
components, is discussed in section 7.4. If an implicit
function is selected, the clip filter returns that portion
of the input data set that lies inside the function. If
Scalars is selected, then the user must specify a scalar
array to clip according to. The clip filter will return
the portions of the data set whose value in the selected
Scalars array is larger than the Clip value. Regardless of
the selection from the Clip Function menu, if the Inside
Out option is checked, the opposite portions of the data
set will be returned. This filter operates on all types of
data sets, and it returns unstructured grid data on
output.


 
{| class="PropertiesTable" border="1" cellpadding="5"
Create 2D Delaunay triangulation of input points. It expects a vtkPointSet as input and produces vtkPolyData as output. The points are expected to be in a mostly planar distribution.
|-
 
Delaunay2D is a filter that constructs a 2D Delaunay triangulation from a list of input points. These points may be represented by any dataset of type vtkPointSet and subclasses. The output of the filter is a polygonal dataset containing a triangle mesh.<br><br><br>
The 2D Delaunay triangulation is defined as the triangulation that satisfies the Delaunay criterion for n-dimensional simplexes (in this case n=2 and the simplexes are triangles). This criterion states that a circumsphere of each simplex in a triangulation contains only the n+1 defining points of the simplex. In two dimensions, this translates into an optimal triangulation. That is, the maximum interior angle of any triangle is less than or equal to that of any possible triangulation.<br><br><br>
Delaunay triangulations are used to build topological structures from unorganized (or unstructured) points. The input to this filter is a list of points specified in 3D, even though the triangulation is 2D. Thus the triangulation is constructed in the x-y plane, and the z coordinate is ignored (although carried through to the output). You can use the option ProjectionPlaneMode in order to compute the best-fitting plane to the set of points, project the points and that plane and then perform the triangulation using their projected positions and then use it as the plane in which the triangulation is performed.<br><br><br>
The Delaunay triangulation can be numerically sensitive in some cases. To prevent problems, try to avoid injecting points that will result in triangles with bad aspect ratios (1000:1 or greater). In practice this means inserting points that are "widely dispersed", and enables smooth transition of triangle sizes throughout the mesh. (You may even want to add extra points to create a better point distribution.) If numerical problems are present, you will see a warning message to this effect at the end of the triangulation process.<br><br><br>
Warning:<br>
Points arranged on a regular lattice (termed degenerate cases) can be triangulated in more than one way (at least according to the Delaunay criterion). The choice of triangulation (as implemented by this algorithm) depends on the order of the input points. The first three points will form a triangle; other degenerate points will not break this triangle.<br><br><br>
Points that are coincident (or nearly so) may be discarded by the algorithm. This is because the Delaunay triangulation requires unique input points. The output of the Delaunay triangulation is supposedly a convex hull. In certain cases this implementation may not generate the convex hull.<br>
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Property'''
| '''Description'''
| '''Description'''
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Alpha'''<br>''(Alpha)''
|'''Input''' (Input)
|
Set the input to the Generic Clip
filter.
|
|
The value of this property controls the output of this filter. For a non-zero alpha value, only edges or triangles contained within a sphere centered at mesh vertices will be output. Otherwise, only triangles will be output.


| 0
|
|
The value must be greater than or equal to 0.
Accepts input of following types:
 
* vtkGenericDataSet
The dataset must contain a field array (point)


|-
|-
| '''Bounding Triangulation'''<br>''(BoundingTriangulation)''
|'''Clip Type''' (ClipFunction)
|
Set the parameters of the clip function.
|
|
If this property is set to 1, bounding triangulation points (and associated triangles) are included in the output. These are introduced as an initial triangulation to begin the triangulation process. This feature is nice for debugging output.


| 0
|
|
Only the values 0 and 1 are accepted.
The value can be one of the following:
* Plane (implicit_functions)
 
* Box (implicit_functions)
 
* Sphere (implicit_functions)


* Scalar (implicit_functions)


|-
|-
| '''Input'''<br>''(Input)''
|'''InputBounds''' (InputBounds)
|
|
This property specifies the input dataset to the Delaunay 2D filter.


|
|
|
|
The selected object must be the result of the following: sources (includes readers), filters.
The selected dataset must be one of the following types (or a subclass of one of them): vtkPointSet.


|-
|-
| '''Offset'''<br>''(Offset)''
|'''Scalars''' (SelectInputScalars)
|
If clipping with scalars, this property specifies the
name of the scalar array on which to perform the clip
operation.
|
|
This property is a multiplier to control the size of the initial, bounding Delaunay triangulation.


| 1
|
|
The value must be greater than or equal to 0.75.
An array of scalars is required.The value must be field array name.
 
 
|-
|-
| '''Projection Plane Mode'''<br>''(ProjectionPlaneMode)''
|'''InsideOut''' (InsideOut)
|
Choose which portion of the dataset should be clipped
away.
|
|
This property determines type of projection plane to use in performing the triangulation.
0
 
| 0
|
|
The value must be one of the following: XY Plane (0), Best-Fitting Plane (2).
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Tolerance'''<br>''(Tolerance)''
|'''Value''' (Value)
|
If clipping with a scalar array, choose the clipping
value.
|
|
This property specifies a tolerance to control discarding of closely spaced points. This tolerance is specified as a fraction of the diagonal length of the bounding box of the points.
0.0
 
| 1e-05
|
|
The value must be greater than or equal to 0 and less than or equal to 1.
The value must lie within the range of the selected data array.
 


|}
|}


==Color By Array==


==Delaunay 3D==
This filter generate a color based image data based on a selected data scalar
 
 
Create a 3D Delaunay triangulation of input                                points.  It expects a vtkPointSet as input and                                produces vtkUnstructuredGrid as output.
 
Delaunay3D is a filter that constructs a 3D Delaunay triangulation<br>
from a list of input points. These points may be represented by any<br>
dataset of type vtkPointSet and subclasses. The output of the filter<br>
is an unstructured grid dataset. Usually the output is a tetrahedral<br>
mesh, but if a non-zero alpha distance value is specified (called<br>
the "alpha" value), then only tetrahedra, triangles, edges, and<br>
vertices lying within the alpha radius are output. In other words,<br>
non-zero alpha values may result in arbitrary combinations of<br>
tetrahedra, triangles, lines, and vertices. (The notion of alpha<br>
value is derived from Edelsbrunner's work on "alpha shapes".)<br><br><br>
The 3D Delaunay triangulation is defined as the triangulation that<br>
satisfies the Delaunay criterion for n-dimensional simplexes (in<br>
this case n=3 and the simplexes are tetrahedra). This criterion<br>
states that a circumsphere of each simplex in a triangulation<br>
contains only the n+1 defining points of the simplex. (See text for<br>
more information.) While in two dimensions this translates into an<br>
"optimal" triangulation, this is not true in 3D, since a measurement<br>
for optimality in 3D is not agreed on.<br><br><br>
Delaunay triangulations are used to build topological structures<br>
from unorganized (or unstructured) points. The input to this filter<br>
is a list of points specified in 3D. (If you wish to create 2D<br>
triangulations see Delaunay2D.) The output is an unstructured<br>
grid.<br><br><br>
The Delaunay triangulation can be numerically sensitive. To prevent<br>
problems, try to avoid injecting points that will result in<br>
triangles with bad aspect ratios (1000:1 or greater). In practice<br>
this means inserting points that are "widely dispersed", and enables<br>
smooth transition of triangle sizes throughout the mesh. (You may<br>
even want to add extra points to create a better point<br>
distribution.) If numerical problems are present, you will see a<br>
warning message to this effect at the end of the triangulation<br>
process.<br><br><br>
Warning:<br>
Points arranged on a regular lattice (termed degenerate cases) can<br>
be triangulated in more than one way (at least according to the<br>
Delaunay criterion). The choice of triangulation (as implemented by<br>
this algorithm) depends on the order of the input points. The first<br>
four points will form a tetrahedron; other degenerate points<br>
(relative to this initial tetrahedron) will not break it.<br><br><br>
Points that are coincident (or nearly so) may be discarded by the<br>
algorithm. This is because the Delaunay triangulation requires<br>
unique input points. You can control the definition of coincidence<br>
with the "Tolerance" instance variable.<br><br><br>
The output of the Delaunay triangulation is supposedly a convex<br>
hull. In certain cases this implementation may not generate the<br>
convex hull. This behavior can be controlled by the Offset instance<br>
variable. Offset is a multiplier used to control the size of the<br>
initial triangulation. The larger the offset value, the more likely<br>
you will generate a convex hull; and the more likely you are to see<br>
numerical problems.<br><br><br>
The implementation of this algorithm varies from the 2D Delaunay<br>
algorithm (i.e., Delaunay2D) in an important way. When points are<br>
injected into the triangulation, the search for the enclosing<br>
tetrahedron is quite different. In the 3D case, the closest<br>
previously inserted point point is found, and then the connected<br>
tetrahedra are searched to find the containing one. (In 2D, a "walk"<br>
towards the enclosing triangle is performed.) If the triangulation<br>
is Delaunay, then an enclosing tetrahedron will be found. However,<br>
in degenerate cases an enclosing tetrahedron may not be found and<br>
the point will be rejected.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,630: Line 1,809:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Alpha'''<br>''(Alpha)''
|'''Input''' (Input)
|
 
|
|
This property specifies the alpha (or distance) value to control
the output of this filter.  For a non-zero alpha value, only
edges, faces, or tetra contained within the circumsphere (of
radius alpha) will be output.  Otherwise, only tetrahedra will be
output.


| 0
|
|
The value must be greater than or equal to 0.
Accepts input of following types:
* vtkImageData
The dataset must contain a field array (point)


with 1 component(s).


|-
|-
| '''Bounding Triangulation'''<br>''(BoundingTriangulation)''
|'''LookupTable''' (LookupTable)
|
|
This boolean controls whether bounding triangulation points (and
associated triangles) are included in the output. (These are
introduced as an initial triangulation to begin the triangulation
process. This feature is nice for debugging output.)


| 0
|
|
Only the values 0 and 1 are accepted.


|


|-
|-
| '''Input'''<br>''(Input)''
|'''Color By''' (SelectInputScalars)
|
This property specifies the name of the scalar array
from which we will color by.
|
|
This property specifies the input dataset to the Delaunay 3D filter.


|
|
An array of scalars is required.The value must be field array name.
|-
|'''RGBA NaN Color''' (NaNColor)
|
|
The selected object must be the result of the following: sources (includes readers), filters.
The selected dataset must be one of the following types (or a subclass of one of them): vtkPointSet.


|-
| '''Offset'''<br>''(Offset)''
|
|
This property specifies a multiplier to control the size of the
0 0 0 255
initial, bounding Delaunay triangulation.
 
| 2.5
|
|
The value must be greater than or equal to 2.5.


|-
|-
| '''Tolerance'''<br>''(Tolerance)''
|'''OutputFormat''' (OutputFormat)
|
|
This property specifies a tolerance to control discarding of
closely spaced points. This tolerance is specified as a fraction
of the diagonal length of the bounding box of the points.


| 0.001
|
|
The value must be greater than or equal to 0 and less than or equal to 1.
3
 
|
The value(s) is an enumeration of the following:
* Luminance (1)
* Luminance Alpha (2)
* RGB (3)
* RGBA (4)


|}
|}


==Compute Derivatives==


==Descriptive Statistics==
This filter computes derivatives of scalars and vectors.
 
CellDerivatives is a filter that computes derivatives of
 
scalars and vectors at the center of cells. You can choose
Compute a statistical model of a dataset and/or assess the dataset with a statistical model.
to generate different output including the scalar gradient
 
(a vector), computed tensor vorticity (a vector), gradient
This filter either computes a statistical model of a dataset or takes such a model as its second input.  Then, the model (however it is obtained) may optionally be used to assess the input dataset.
of input vectors (a tensor), and strain matrix of the
<br>
input vectors (a tensor); or you may choose to pass data
This filter computes the min, max, mean, raw moments M2 through M4, standard deviation, skewness, and kurtosis for each array you select.
through to the output.
 
<br>
The model is simply a univariate Gaussian distribution with the mean and standard deviation provided. Data is assessed using this model by detrending the data (i.e., subtracting the mean) and then dividing by the standard deviation. Thus the assessment is an array whose entries are the number of standard deviations from the mean that each input point lies.<br>
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,715: Line 1,880:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Attribute Mode'''<br>''(AttributeMode)''
|'''Input''' (Input)
|
|
Specify which type of field data the arrays will be drawn from.
This property specifies the input to the
 
filter.
| 0
|
|
Valud array names will be chosen from point and cell data.


|-
| '''Input'''<br>''(Input)''
|
|
The input to the filter.  Arrays from this dataset will be used for computing statistics and/or assessed by a statistical model.
Accepts input of following types:
* vtkDataSet
The dataset must contain a field array (point)


|
with 1 component(s).
|
The selected object must be the result of the following: sources (includes readers), filters.


The dataset must contain a field array (point)


The dataset must contain a point or cell array.
with 3 component(s).
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData, vtkStructuredGrid, vtkPolyData, vtkUnstructuredGrid, vtkTable, vtkGraph.
 


|-
|-
| '''Model Input'''<br>''(ModelInput)''
|'''Scalars''' (SelectInputScalars)
|
This property indicates the name of the scalar array to
differentiate.
|
|
A previously-calculated model with which to assess a separate dataset.  This input is optional.


|
|
|
An array of scalars is required.
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkTable, vtkMultiBlockDataSet.
 
 
|-
|-
| '''Variables of Interest'''<br>''(SelectArrays)''
|'''Vectors''' (SelectInputVectors)
|
|
Choose arrays whose entries will be used to form observations for statistical analysis.
This property indicates the name of the vector array to
 
differentiate.
|
|
1
|
|
An array of scalars is required.
An array of vectors is required.
 
 
|-
|-
| '''Deviations should be'''<br>''(SignedDeviations)''
|'''OutputVectorType''' (OutputVectorType)
|
|
Should the assessed values be signed deviations or unsigned?
This property Controls how the filter works to generate
 
vector cell data. You can choose to compute the gradient of the input
| 0
scalars, or extract the vorticity of the computed vector gradient
tensor. By default, the filter will take the gradient of the input
scalar data.
|
1
|
|
The value must be one of the following: Unsigned (0), Signed (1).
The value(s) is an enumeration of the following:
 
* Nothing (0)
 
* Scalar Gradient (1)
* Vorticity (2)
|-
|-
| '''Task'''<br>''(Task)''
|'''OutputTensorType''' (OutputTensorType)
|
|
Specify the task to be performed: modeling and/or assessment.
This property controls how the filter works to generate
#  "Statistics of all the data," creates an output table (or tables) summarizing the '''entire''' input dataset;
tensor cell data. You can choose to compute the gradient of the input
#  "Model a subset of the data," creates an output table (or tables) summarizing a '''randomly-chosen subset''' of the input dataset;
vectors, or compute the strain tensor of the vector gradient tensor. By
#  "Assess the data with a model," adds attributes to the first input dataset using a model provided on the second input port; and
default, the filter will take the gradient of the vector data to
#  "Model and assess the same data," is really just operations 2 and 3 above applied to the same input dataset.  The model is first trained using a fraction of the input data and then the entire dataset is assessed using that model.
construct a tensor.
 
When the task includes creating a model (i.e., tasks 2, and 4), you may adjust the fraction of the input dataset used for training.  You should avoid using a large fraction of the input data for training as you will then not be able to detect overfitting. The ''Training fraction'' setting will be ignored for tasks 1 and 3.
 
| 3
|
|
The value must be one of the following: Statistics of all the data (0), Model a subset of the data (1), Assess the data with a model (2), Model and assess the same data (3).
1
 
 
|-
| '''Training Fraction'''<br>''(TrainingFraction)''
|
|
Specify the fraction of values from the input dataset to be used for model fitting. The exact set of values is chosen at random from the dataset.
The value(s) is an enumeration of the following:
 
* Nothing (0)
| 0.1
* Vector Gradient (1)
|
* Strain (2)
The value must be greater than or equal to 0 and less than or equal to 1.
 


|}
|}


==Compute Quartiles==


==Elevation==
Compute the quartiles table from a dataset or table.
 
 
Create point attribute array by projecting points onto an elevation vector.
 
The Elevation filter generates point scalar values for an input dataset along a specified direction vector.<br><br><br>
The Input menu allows the user to select the data set to which this filter will be applied. Use the Scalar range entry boxes to specify the minimum and maximum scalar value to be generated. The Low Point and High Point define a line onto which each point of the data set is projected. The minimum scalar value is associated with the Low Point, and the maximum scalar value is associated with the High Point. The scalar value for each point in the data set is determined by the location along the line to which that point projects.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,817: Line 1,960:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''High Point'''<br>''(HighPoint)''
|'''Input''' (Input)
|
This property specifies the input to the
filter.
|
|
This property defines the other end of the direction vector (large scalar values).


| 0 0 1
|
|
The coordinate must lie within the bounding box of the dataset. It will default to the maximum in each dimension.
Accepts input of following types:
* vtkDataObject


|}


|-
==Connectivity==
| '''Input'''<br>''(Input)''
|
This property specifies the input dataset to the Elevation filter.


|
Mark connected components with integer point attribute array.The Connectivity
|
filter assigns a region id to connected components of the
The selected object must be the result of the following: sources (includes readers), filters.
input data set. (The region id is assigned as a point
 
scalar value.) This filter takes any data set type as
 
input and produces unstructured grid
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
output.
 
 
|-
| '''Low Point'''<br>''(LowPoint)''
|
This property defines one end of the direction vector (small scalar values).
 
| 0 0 0
|
The coordinate must lie within the bounding box of the dataset. It will default to the minimum in each dimension.
 
 
|-
| '''Scalar Range'''<br>''(ScalarRange)''
|
This property determines the range into which scalars will be mapped.
 
| 0 1
|
|}
 
 
==Extract AMR Blocks==
 
 
This filter extracts a list of datasets from hierarchical datasets.
 
This filter extracts a list of datasets from hierarchical datasets.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,873: Line 1,989:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Input'''<br>''(Input)''
|'''Input''' (Input)
|
This property specifies the input to the Connectivity
filter.
|
|
This property specifies the input to the Extract Datasets filter.


|
|
Accepts input of following types:
* vtkDataSet
|-
|'''ExtractionMode''' (ExtractionMode)
|
Controls the extraction of connected
surfaces.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
5
 
|
 
The value(s) is an enumeration of the following:
The selected dataset must be one of the following types (or a subclass of one of them): vtkHierarchicalBoxDataSet.
* Extract Point Seeded Regions (1)
 
* Extract Cell Seeded Regions (2)
 
* Extract Specified Regions (3)
* Extract Largest Region (4)
* Extract All Regions (5)
* Extract Closes Point Region (6)
|-
|-
| '''Selected Data Sets'''<br>''(SelectedDataSets)''
|'''ColorRegions''' (ColorRegions)
|
|
This property provides a list of datasets to extract.
Controls the coloring of the connected
 
regions.
|
|
1
|
|
Accepts boolean values (0 or 1).
|}
|}


==Contingency Statistics==


==Extract Block==
Compute a statistical model of a dataset and/or assess the dataset with a statistical model.
 
This filter either computes a statistical model of a dataset or takes
 
such a model as its second input. Then, the model (however it is
This filter extracts a range of blocks from a multiblock dataset.
obtained) may optionally be used to assess the input dataset. This filter
 
computes contingency tables between pairs of attributes. This result is a
This filter extracts a range of groups from a multiblock dataset<br>
tabular bivariate probability distribution which serves as a
Bayesian-style prior model. Data is assessed by computing &lt;ul&gt;
&lt;li&gt; the probability of observing both variables simultaneously;
&lt;li&gt; the probability of each variable conditioned on the other (the
two values need not be identical); and &lt;li&gt; the pointwise mutual
information (PMI). &lt;/ul&gt; Finally, the summary statistics include
the information entropy of the observations.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,909: Line 2,048:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Block Indices'''<br>''(BlockIndices)''
|'''Input''' (Input)
|
The input to the filter. Arrays from this dataset will
be used for computing statistics and/or assessed by a statistical
model.
|
|
This property lists the ids of the blocks to extract
from the input multiblock dataset.


|
|
Accepts input of following types:
* vtkImageData
* vtkStructuredGrid
* vtkPolyData
* vtkUnstructuredGrid
* vtkTable
* vtkGraph
The dataset must contain a field array ()
|-
|'''ModelInput''' (ModelInput)
|
|
|-
A previously-calculated model with which to assess a
| '''Input'''<br>''(Input)''
separate dataset. This input is optional.
|
|
This property specifies the input to the Extract Group filter.


|
|
Accepts input of following types:
* vtkTable
* vtkMultiBlockDataSet
|-
|'''AttributeMode''' (AttributeMode)
|
Specify which type of field data the arrays will be
drawn from.
|
0
|
The value must be field array name.
|-
|'''Variables of Interest''' (SelectArrays)
|
Choose arrays whose entries will be used to form
observations for statistical analysis.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
The selected dataset must be one of the following types (or a subclass of one of them): vtkMultiBlockDataSet.


|


|-
|-
| '''Maintain Structure'''<br>''(MaintainStructure)''
|'''Task''' (Task)
|
|
This is used only when PruneOutput is ON. By default, when pruning the
Specify the task to be performed: modeling and/or
output i.e. remove empty blocks, if node has only 1 non-null child
assessment. &lt;ol&gt; &lt;li&gt; "Detailed model of input data,"
block, then that node is removed. To preserve these parent nodes, set
creates a set of output tables containing a calculated statistical
this flag to true.
model of the &lt;b&gt;entire&lt;/b&gt; input dataset;&lt;/li&gt;
 
&lt;li&gt; "Model a subset of the data," creates an output table (or
| 0
tables) summarizing a &lt;b&gt;randomly-chosen subset&lt;/b&gt; of the
input dataset;&lt;/li&gt; &lt;li&gt; "Assess the data with a model,"
adds attributes to the first input dataset using a model provided on
the second input port; and&lt;/li&gt; &lt;li&gt; "Model and assess the
same data," is really just operations 2 and 3 above applied to the same
input dataset. The model is first trained using a fraction of the input
data and then the entire dataset is assessed using that
model.&lt;/li&gt; &lt;/ol&gt; When the task includes creating a model
(i.e., tasks 2, and 4), you may adjust the fraction of the input
dataset used for training. You should avoid using a large fraction of
the input data for training as you will then not be able to detect
overfitting. The &lt;i&gt;Training fraction&lt;/i&gt; setting will be
ignored for tasks 1 and 3.
|
3
|
|
Only the values 0 and 1 are accepted.
The value(s) is an enumeration of the following:
 
* Detailed model of input data (0)
 
* Model a subset of the data (1)
* Assess the data with a model (2)
* Model and assess the same data (3)
|-
|-
| '''Prune Output'''<br>''(PruneOutput)''
|'''TrainingFraction''' (TrainingFraction)
|
|
When set, the output mutliblock dataset will be pruned to remove empty
Specify the fraction of values from the input dataset to
nodes. On by default.
be used for model fitting. The exact set of values is chosen at random
 
from the dataset.
| 1
|
0.1
|
|
Only the values 0 and 1 are accepted.




|}
|}


==Contour==


==Extract CTH Parts==
Generate isolines or isosurfaces using point scalars.The Contour
 
filter computes isolines or isosurfaces using a selected
 
point-centered scalar array. The Contour filter operates
Create a surface from a CTH volume fraction.
on any type of data set, but the input is required to have
 
at least one point-centered scalar (single-component)
Extract CTH Parts is a specialized filter for visualizing the data from a CTH simulation. It first converts the selected cell-centered arrays to point-centered ones. It then contours each array at a value of 0.5. The user has the option of clipping the resulting surface(s) with a plane. This filter only operates on unstructured data. It produces polygonal output.<br>
array. The output of this filter is
polygonal.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,970: Line 2,154:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Double Volume Arrays'''<br>''(AddDoubleVolumeArrayName)''
|'''Input''' (Input)
|
This property specifies the input dataset to be used by
the contour filter.
|
|
This property specifies the name(s) of the volume fraction array(s) for generating parts.


|
|
|
Accepts input of following types:
An array of scalars is required.
* vtkDataSet
The dataset must contain a field array (point)


with 1 component(s).


|-
|-
| '''Float Volume Arrays'''<br>''(AddFloatVolumeArrayName)''
|'''Contour By''' (SelectInputScalars)
|
This property specifies the name of the scalar array
from which the contour filter will compute isolines and/or
isosurfaces.
|
|
This property specifies the name(s) of the volume fraction array(s) for generating parts.


|
|
An array of scalars is required.The value must be field array name.
|-
|'''ComputeNormals''' (ComputeNormals)
|
If this property is set to 1, a scalar array containing
a normal value at each point in the isosurface or isoline will be
created by the contour filter; otherwise an array of normals will not
be computed. This operation is fairly expensive both in terms of
computation time and memory required, so if the output dataset produced
by the contour filter will be processed by filters that modify the
dataset's topology or geometry, it may be wise to set the value of this
property to 0. Select whether to compute normals.
|
1
|
Accepts boolean values (0 or 1).
|-
|'''ComputeGradients''' (ComputeGradients)
|
|
An array of scalars is required.
If this property is set to 1, a scalar array containing
 
a gradient value at each point in the isosurface or isoline will be
 
created by this filter; otherwise an array of gradients will not be
computed. This operation is fairly expensive both in terms of
computation time and memory required, so if the output dataset produced
by the contour filter will be processed by filters that modify the
dataset's topology or geometry, it may be wise to set the value of this
property to 0. Not that if ComputeNormals is set to 1, then gradients
will have to be calculated, but they will only be stored in the output
dataset if ComputeGradients is also set to 1.
|
0
|
Accepts boolean values (0 or 1).
|-
|-
| '''Unsigned Character Volume Arrays'''<br>''(AddUnsignedCharVolumeArrayName)''
|'''ComputeScalars''' (ComputeScalars)
|
If this property is set to 1, an array of scalars
(containing the contour value) will be added to the output dataset. If
set to 0, the output will not contain this array.
|
|
This property specifies the name(s) of the volume fraction array(s) for generating parts.
0
 
|
|
Accepts boolean values (0 or 1).
|-
|'''OutputPointsPrecision''' (OutputPointsPrecision)
|
|
An array of scalars is required.


Select the output precision of the coordinates. **Single** sets the
output to single-precision floating-point (i.e., float), **Double**
sets it to double-precision floating-point (i.e., double), and
**Default** sets it to the same precision as the precision of the
points in the input. Defaults to ***Single***.


|
0
|
The value(s) is an enumeration of the following:
* Single (0)
* Double (1)
* Same as input (2)
|-
|-
| '''Clip Type'''<br>''(ClipPlane)''
|'''GenerateTriangles''' (GenerateTriangles)
|
|
This property specifies whether to clip the dataset, and if so, it also specifies the parameters of the plane with which to clip.
This parameter controls whether to produce triangles in the output.
Warning: Many filters do not properly handle non-trianglular polygons.


|
|
1
|
|
The value must be set to one of the following: None, Plane, Box, Sphere.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Input'''<br>''(Input)''
|'''Isosurfaces''' (ContourValues)
|
This property specifies the values at which to compute
isosurfaces/isolines and also the number of such
values.
|
|
This property specifies the input to the Extract CTH Parts filter.


|
|
The value must lie within the range of the selected data array.
|-
|'''Point Merge Method''' (Locator)
|
This property specifies an incremental point locator for
merging duplicate / coincident points.
|
|
The selected object must be the result of the following: sources (includes readers), filters.


|
The value can be one of the following:
* MergePoints (incremental_point_locators)


The dataset must contain a cell array with 1 components.
* IncrementalOctreeMergePoints (incremental_point_locators)


* NonMergingPointLocator (incremental_point_locators)


The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.


|}


|-
==Contour Generic Dataset==
| '''Volume Fraction Value'''<br>''(VolumeFractionSurfaceValue)''
|
The value of this property is the volume fraction value for the surface.


| 0.1
Generate isolines or isosurfaces using point scalars.The Generic
|
Contour filter computes isolines or isosurfaces using a
The value must be greater than or equal to 0 and less than or equal to 1.
selected point-centered scalar array. The available scalar
 
arrays are listed in the Scalars menu. The scalar range of
 
the selected array will be displayed. The interface for
|}
adding contour values is very similar to the one for
 
selecting cut offsets (in the Cut filter). To add a single
 
contour value, select the value from the New Value slider
==Extract Cells By Region==
in the Add value portion of the interface and click the
 
Add button, or press Enter. To instead add several evenly
 
spaced contours, use the controls in the Generate range of
This filter extracts cells that are inside/outside a region or at a region boundary.
values section. Select the number of contour values to
 
generate using the Number of Values slider. The Range
This filter extracts from its input dataset all cells that are either completely inside or outside of a specified region (implicit function). On output, the filter generates an unstructured grid.<br>
slider controls the interval in which to generate the
To use this filter you must specify a region  (implicit function). You must also specify whethter to extract cells lying inside or outside of the region. An option exists to extract cells that are neither inside or outside (i.e., boundary).<br>
contour values. Once the number of values and range have
been selected, click the Generate button. The new values
will be added to the Contour Values list. To delete a
value from the Contour Values list, select the value and
click the Delete button. (If no value is selected, the
last value in the list will be removed.) Clicking the
Delete All button removes all the values in the list. If
no values are in the Contour Values list when Accept is
pressed, the current value of the New Value slider will be
used. In addition to selecting contour values, you can
also select additional computations to perform. If any of
Compute Normals, Compute Gradients, or Compute Scalars is
selected, the appropriate computation will be performed,
and a corresponding point-centered array will be added to
the output. The Generic Contour filter operates on a
generic data set, but the input is required to have at
least one point-centered scalar (single-component) array.
The output of this filter is polygonal.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,053: Line 2,317:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Extract intersected'''<br>''(Extract intersected)''
|'''Input''' (Input)
|
Set the input to the Generic Contour
filter.
|
|
This parameter controls whether to extract cells that are on the boundary of the region.


| 0
|
|
Only the values 0 and 1 are accepted.
Accepts input of following types:
* vtkGenericDataSet
The dataset must contain a field array (point)


with 1 component(s).


|-
|-
| '''Extract only intersected'''<br>''(Extract only intersected)''
|'''Contour By''' (SelectInputScalars)
|
This property specifies the name of the scalar array
from which the contour filter will compute isolines and/or
isosurfaces.
|
|
This parameter controls whether to extract only cells that are on the boundary of the region. If this parameter is set, the Extraction Side parameter is ignored. If Extract Intersected is off, this parameter has no effect.


| 0
|
|
Only the values 0 and 1 are accepted.
An array of scalars is required.The value must be field array name.
 
|-
 
|'''ComputeNormals''' (ComputeNormals)
|
Select whether to compute normals.
|
1
|
Accepts boolean values (0 or 1).
|-
|-
| '''Extraction Side'''<br>''(ExtractInside)''
|'''ComputeGradients''' (ComputeGradients)
|
Select whether to compute gradients.
|
|
This parameter controls whether to extract cells that are inside or outside the region.
0
 
| 1
|
|
The value must be one of the following: outside (0), inside (1).
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Intersect With'''<br>''(ImplicitFunction)''
|'''ComputeScalars''' (ComputeScalars)
|
Select whether to compute scalars.
|
0
|
|
This property sets the region used to extract cells.
Accepts boolean values (0 or 1).
 
|-
|'''Isosurfaces''' (ContourValues)
|
|
This property specifies the values at which to compute
isosurfaces/isolines and also the number of such
values.
|
|
The value must be set to one of the following: Plane, Box, Sphere.


|
The value must lie within the range of the selected data array.
|-
|-
| '''Input'''<br>''(Input)''
|'''Point Merge Method''' (Locator)
|
This property specifies an incremental point locator for
merging duplicate / coincident points.
|
|
This property specifies the input to the Slice filter.


|
|
|
The value can be one of the following:
The selected object must be the result of the following: sources (includes readers), filters.
* MergePoints (incremental_point_locators)


* IncrementalOctreeMergePoints (incremental_point_locators)


The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
* NonMergingPointLocator (incremental_point_locators)




|}
|}


==Convert AMR dataset to Multi-block==


==Extract Edges==
Convert AMR to Multiblock
 
 
Extract edges of 2D and 3D cells as lines.
 
The Extract Edges filter produces a wireframe version of the input dataset by extracting all the edges of the dataset's cells as lines. This filter operates on any type of data set and produces polygonal output.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,122: Line 2,404:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Input'''<br>''(Input)''
|'''Input''' (Input)
|
This property specifies the input for this
filter.
|
|
This property specifies the input to the Extract Edges filter.


|
|
|
Accepts input of following types:
The selected object must be the result of the following: sources (includes readers), filters.
* vtkOverlappingAMR
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 


|}
|}


==ConvertSelection==


==Extract Level==
Converts a selection from one type to
 
another.
 
This filter extracts a range of groups from a hierarchical dataset.
 
This filter extracts a range of levels from a hierarchical dataset<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,151: Line 2,429:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Input'''<br>''(Input)''
|'''DataInput''' (DataInput)
|
Set the vtkDataObject input used to convert the
selection.
|
|
This property specifies the input to the Extract Group filter.


|
|
Accepts input of following types:
* vtkDataObject
|-
|'''Input''' (Input)
|
Set the selection to convert.
|
|
The selected object must be the result of the following: sources (includes readers), filters.


|
Accepts input of following types:
* vtkSelection
|-
|'''OutputType''' (OutputType)
|
Set the ContentType for the output.
|
5
|
The value(s) is an enumeration of the following:
* SELECTIONS (0)
* GLOBALIDs (1)
* PEDIGREEIDS (2)
* VALUES (3)
* INDICES (4)
* FRUSTUM (5)
* LOCATION (6)
* THRESHOLDS (7)
|-
|'''ArrayNames''' (ArrayNames)
|


The selected dataset must be one of the following types (or a subclass of one of them): vtkHierarchicalBoxDataSet.
|


|


|-
|-
| '''Levels'''<br>''(Levels)''
|'''MatchAnyValues''' (MatchAnyValues)
|
|
This property lists the levels to extract
from the input hierarchical dataset.


|
|
0
|
|
Accepts boolean values (0 or 1).
|}
|}


==Crop==


==Extract Selection==
Efficiently extract an area/volume of interest from a 2-d image or 3-d volume.The Crop filter
 
extracts an area/volume of interest from a 2D image or a
 
3D volume by allowing the user to specify the minimum and
Extract different type of selections.
maximum extents of each dimension of the data. Both the
 
input and output of this filter are uniform rectilinear
This filter extracts a set of cells/points given a selection.<br>
data.
The selection can be obtained from a rubber-band selection<br>
(either cell, visible or in a frustum) or threshold selection<br>
and passed to the filter or specified by providing an ID list.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,191: Line 2,499:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Input'''<br>''(Input)''
|'''Input''' (Input)
|
This property specifies the input to the Crop
filter.
|
|
This property specifies the input from which the selection is extracted.


|
|
Accepts input of following types:
* vtkImageData
|-
|'''OutputWholeExtent''' (OutputWholeExtent)
|
This property gives the minimum and maximum point index
(extent) in each dimension for the output dataset.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
0 0 0 0 0 0
|
The value(s) must lie within the structured-extents of the input dataset.
 
|}


==Curvature==


The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet, vtkTable.
This filter will compute the Gaussian or mean curvature of the mesh at each point.The
Curvature filter computes the curvature at each point in a
polygonal data set. This filter supports both Gaussian and
mean curvatures. ; the type can be selected from the
Curvature type menu button.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


|-
|-
| '''Preserve Topology'''<br>''(PreserveTopology)''
|'''Input''' (Input)
|
This property specifies the input to the Curvature
filter.
|
|
If this property is set to 1 the output preserves the topology of its
input and adds an insidedness array to mark which cells are inside or
out. If 0 then the output is an unstructured grid which contains only
the subset of cells that are inside.


| 0
|
|
Only the values 0 and 1 are accepted.
Accepts input of following types:
 
* vtkPolyData
 
|-
|-
| '''Selection'''<br>''(Selection)''
|'''InvertMeanCurvature''' (InvertMeanCurvature)
|
|
The input that provides the selection object.
If this property is set to 1, the mean curvature
 
calculation will be inverted. This is useful for meshes with
inward-pointing normals.
|
|
0
|
|
The selected object must be the result of the following: sources (includes readers), filters.
Accepts boolean values (0 or 1).
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkSelection.
 
 
|-
|-
| '''Show Bounds'''<br>''(ShowBounds)''
|'''CurvatureType''' (CurvatureType)
|
|
For frustum selection, if this property is set to 1 the output is the
This propery specifies which type of curvature to
outline of the frustum instead of the contents of the input that lie
compute.
within the frustum.
|
 
0
| 0
|
|
Only the values 0 and 1 are accepted.
The value(s) is an enumeration of the following:
 
* Gaussian (0)
* Mean (1)


|}
|}


==D3==


==Extract Subset==
Repartition a data set into load-balanced spatially convex regions. Create ghost cells if requested.The D3 filter is
 
available when ParaView is run in parallel. It operates on
 
any type of data set to evenly divide it across the
Extract a subgrid from a structured grid with the option of setting subsample strides.
processors into spatially contiguous regions. The output
 
of this filter is of type unstructured
The Extract Grid filter returns a subgrid of a structured input data set (uniform rectilinear, curvilinear, or nonuniform rectilinear). The output data set type of this filter is the same as the input type.<br>
grid.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,258: Line 2,586:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Include Boundary'''<br>''(IncludeBoundary)''
|'''Input''' (Input)
|
This property specifies the input to the D3
filter.
|
|
If the value of this property is 1, then if the sample rate in any dimension is greater than 1, the boundary indices of the input dataset will be passed to the output even if the boundary extent is not an even multiple of the sample rate in a given dimension.


| 0
|
|
Only the values 0 and 1 are accepted.
Accepts input of following types:
 
* vtkDataSet
 
|-
|-
| '''Input'''<br>''(Input)''
|'''BoundaryMode''' (BoundaryMode)
|
|
This property specifies the input to the Extract Grid filter.
This property determines how cells that lie on processor
 
boundaries are handled. The "Assign cells uniquely" option assigns each
boundary cell to exactly one process, which is useful for isosurfacing.
Selecting "Duplicate cells" causes the cells on the boundaries to be
copied to each process that shares that boundary. The "Divide cells"
option breaks cells across process boundary lines so that pieces of the
cell lie in different processes. This option is useful for volume
rendering.
|
0
|
The value(s) is an enumeration of the following:
* Assign cells uniquely (0)
* Duplicate cells (1)
* Divide cells (2)
|-
|'''Minimal Memory''' (UseMinimalMemory)
|
If this property is set to 1, the D3 filter requires
communication routines to use minimal memory than without this
restriction.
|
|
0
|
|
The selected object must be the result of the following: sources (includes readers), filters.
Accepts boolean values (0 or 1).


|}


The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData, vtkRectilinearGrid, vtkStructuredPoints, vtkStructuredGrid.
==Decimate==


Simplify a polygonal model using an adaptive edge collapse algorithm. This filter works with triangles only.
The Decimate filter reduces the number of triangles in a
polygonal data set. Because this filter only operates on
triangles, first run the Triangulate filter on a dataset
that contains polygons other than
triangles.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Sample Rate I'''<br>''(SampleRateI)''
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''Input''' (Input)
|
This property specifies the input to the Decimate
filter.
|
|
This property indicates the sampling rate in the I dimension. A value grater than 1 results in subsampling; every nth index will be included in the output.


| 1
|
|
The value must be greater than or equal to 1.
Accepts input of following types:
 
* vtkPolyData
|-
|'''TargetReduction''' (TargetReduction)
|
This property specifies the desired reduction in the
total number of polygons in the output dataset. For example, if the
TargetReduction value is 0.9, the Decimate filter will attempt to
produce an output dataset that is 10% the size of the
input.)
|
0.9
|


|-
|-
| '''Sample Rate J'''<br>''(SampleRateJ)''
|'''PreserveTopology''' (PreserveTopology)
|
|
This property indicates the sampling rate in the J dimension. A value grater than 1 results in subsampling; every nth index will be included in the output.
If this property is set to 1, decimation will not split
 
the dataset or produce holes, but it may keep the filter from reaching
| 1
the reduction target. If it is set to 0, better reduction can occur
(reaching the reduction target), but holes in the model may be
produced.
|
0
|
|
The value must be greater than or equal to 1.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Sample Rate K'''<br>''(SampleRateK)''
|'''FeatureAngle''' (FeatureAngle)
|
The value of this property is used in determining where
the data set may be split. If the angle between two adjacent triangles
is greater than or equal to the FeatureAngle value, then their boundary
is considered a feature edge where the dataset can be
split.
|
|
This property indicates the sampling rate in the K dimension. A value grater than 1 results in subsampling; every nth index will be included in the output.
15.0
 
| 1
|
|
The value must be greater than or equal to 1.


|-
|-
| '''V OI'''<br>''(VOI)''
|'''BoundaryVertexDeletion''' (BoundaryVertexDeletion)
|
If this property is set to 1, then vertices on the
boundary of the dataset can be removed. Setting the value of this
property to 0 preserves the boundary of the dataset, but it may cause
the filter not to reach its reduction target.
|
|
This property specifies the minimum and maximum point indices along each of the I, J, and K axes; these values indicate the volume of interest (VOI). The output will have the (I,J,K) extent specified here.
1
 
| 0 0 0 0 0 0
|
|
The values must lie within the extent of the input dataset.
Accepts boolean values (0 or 1).
 


|}
|}


==Delaunay 2D==


==Extract Surface==
Create 2D Delaunay triangulation of input points. It expects a vtkPointSet as input and produces vtkPolyData as output. The points are expected to be in a mostly planar distribution.
 
Delaunay2D is a filter that constructs a 2D Delaunay
 
triangulation from a list of input points. These points
Extract a 2D boundary surface using neighbor relations to eliminate internal faces.
may be represented by any dataset of type vtkPointSet and
 
subclasses. The output of the filter is a polygonal
The Extract Surface filter extracts the polygons forming the outer surface of the input dataset. This filter operates on any type of data and produces polygonal data as output.<br>
dataset containing a triangle mesh. The 2D Delaunay
triangulation is defined as the triangulation that
satisfies the Delaunay criterion for n-dimensional
simplexes (in this case n=2 and the simplexes are
triangles). This criterion states that a circumsphere of
each simplex in a triangulation contains only the n+1
defining points of the simplex. In two dimensions, this
translates into an optimal triangulation. That is, the
maximum interior angle of any triangle is less than or
equal to that of any possible triangulation. Delaunay
triangulations are used to build topological structures
from unorganized (or unstructured) points. The input to
this filter is a list of points specified in 3D, even
though the triangulation is 2D. Thus the triangulation is
constructed in the x-y plane, and the z coordinate is
ignored (although carried through to the output). You can
use the option ProjectionPlaneMode in order to compute the
best-fitting plane to the set of points, project the
points and that plane and then perform the triangulation
using their projected positions and then use it as the
plane in which the triangulation is performed. The
Delaunay triangulation can be numerically sensitive in
some cases. To prevent problems, try to avoid injecting
points that will result in triangles with bad aspect
ratios (1000:1 or greater). In practice this means
inserting points that are "widely dispersed", and enables
smooth transition of triangle sizes throughout the mesh.
(You may even want to add extra points to create a better
point distribution.) If numerical problems are present,
you will see a warning message to this effect at the end
of the triangulation process. Warning: Points arranged on
a regular lattice (termed degenerate cases) can be
triangulated in more than one way (at least according to
the Delaunay criterion). The choice of triangulation (as
implemented by this algorithm) depends on the order of the
input points. The first three points will form a triangle;
other degenerate points will not break this triangle.
Points that are coincident (or nearly so) may be discarded
by the algorithm. This is because the Delaunay
triangulation requires unique input points. The output of
the Delaunay triangulation is supposedly a convex hull. In
certain cases this implementation may not generate the
convex hull.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,337: Line 2,761:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Input'''<br>''(Input)''
|'''Input''' (Input)
|
This property specifies the input dataset to the
Delaunay 2D filter.
|
|
This property specifies the input to the Extract Surface filter.


|
|
Accepts input of following types:
* vtkPointSet
|-
|'''ProjectionPlaneMode''' (ProjectionPlaneMode)
|
This property determines type of projection plane to use
in performing the triangulation.
|
0
|
|
The selected object must be the result of the following: sources (includes readers), filters.
The value(s) is an enumeration of the following:
 
* XY Plane (0)
 
* Best-Fitting Plane (2)
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
|-
| '''Nonlinear Subdivision Level'''<br>''(NonlinearSubdivisionLevel)''
|'''Alpha''' (Alpha)
|
|
If the input is an unstructured grid with nonlinear faces, this
The value of this property controls the output of this
parameter determines how many times the face is subdivided into
filter. For a non-zero alpha value, only edges or triangles contained
linear faces.  If 0, the output is the equivalent of its linear
within a sphere centered at mesh vertices will be output. Otherwise,
couterpart (and the midpoints determining the nonlinear
only triangles will be output.
interpolation are discarded). If 1, the nonlinear face is
|
triangulated based on the midpoints. If greater than 1, the
0.0
triangulated pieces are recursively subdivided to reach the
desired subdivision. Setting the value to greater than 1 may
cause some point data to not be passed even if no quadratic faces
exist. This option has no effect if the input is not an
unstructured grid.
 
| 1
|
|
The value must be greater than or equal to 0 and less than or equal to 4.


|-
|-
| '''Piece Invariant'''<br>''(PieceInvariant)''
|'''Tolerance''' (Tolerance)
|
|
If the value of this property is set to 1, internal surfaces along process boundaries will be removed. NOTE: Enabling this option might cause multiple executions of the data source because more information is needed to remove internal surfaces.
This property specifies a tolerance to control
 
discarding of closely spaced points. This tolerance is specified as a
| 1
fraction of the diagonal length of the bounding box of the
points.
|
0.00001
|
|
Only the values 0 and 1 are accepted.
|}


==FFT Of Selection Over Time==
Extracts selection over time and plots the FFT
Extracts the data of a selection (e.g. points or cells) over time,<br>
takes the FFT of them, and plots them.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''Offset''' (Offset)
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
|
The input from which the selection is extracted.
This property is a multiplier to control the size of the
 
initial, bounding Delaunay triangulation.
|
|
1.0
|
|
The selected object must be the result of the following: sources (includes readers), filters.
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet, vtkTable, vtkCompositeDataSet.


|-
|-
| '''Selection'''<br>''(Selection)''
|'''BoundingTriangulation''' (BoundingTriangulation)
|
|
The input that provides the selection object.
If this property is set to 1, bounding triangulation
 
points (and associated triangles) are included in the output. These are
introduced as an initial triangulation to begin the triangulation
process. This feature is nice for debugging output.
|
|
0
|
|
The selected object must be the result of the following: sources (includes readers), filters.
Accepts boolean values (0 or 1).
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkSelection.
 


|}
|}


==Delaunay 3D==


==Feature Edges==
Create a 3D Delaunay triangulation of input points. It expects a vtkPointSet as input and produces vtkUnstructuredGrid as output.Delaunay3D is a filter that constructs
 
a 3D Delaunay triangulation from a list of input points. These points may be
 
represented by any dataset of type vtkPointSet and subclasses. The output of
This filter will extract edges along sharp edges of surfaces or boundaries of surfaces.
the filter is an unstructured grid dataset. Usually the output is a tetrahedral
 
mesh, but if a non-zero alpha distance value is specified (called the "alpha"
The Feature Edges filter extracts various subsets of edges from the input data set. This filter operates on polygonal data and produces polygonal output.<br>
value), then only tetrahedra, triangles, edges, and vertices lying within the
alpha radius are output. In other words, non-zero alpha values may result in
arbitrary combinations of tetrahedra, triangles, lines, and vertices. (The
notion of alpha value is derived from Edelsbrunner's work on "alpha shapes".)
The 3D Delaunay triangulation is defined as the triangulation that satisfies
the Delaunay criterion for n-dimensional simplexes (in this case n=3 and the
simplexes are tetrahedra). This criterion states that a circumsphere of each
simplex in a triangulation contains only the n+1 defining points of the
simplex. (See text for more information.) While in two dimensions this
translates into an "optimal" triangulation, this is not true in 3D, since a
measurement for optimality in 3D is not agreed on. Delaunay triangulations are
used to build topological structures from unorganized (or unstructured) points.
The input to this filter is a list of points specified in 3D. (If you wish to
create 2D triangulations see Delaunay2D.) The output is an unstructured grid.
The Delaunay triangulation can be numerically sensitive. To prevent problems,
try to avoid injecting points that will result in triangles with bad aspect
ratios (1000:1 or greater). In practice this means inserting points that are
"widely dispersed", and enables smooth transition of triangle sizes throughout
the mesh. (You may even want to add extra points to create a better point
distribution.) If numerical problems are present, you will see a warning
message to this effect at the end of the triangulation process. Warning: Points
arranged on a regular lattice (termed degenerate cases) can be triangulated in
more than one way (at least according to the Delaunay criterion). The choice of
triangulation (as implemented by this algorithm) depends on the order of the
input points. The first four points will form a tetrahedron; other degenerate
points (relative to this initial tetrahedron) will not break it. Points that
are coincident (or nearly so) may be discarded by the algorithm. This is
because the Delaunay triangulation requires unique input points. You can
control the definition of coincidence with the "Tolerance" instance variable.
The output of the Delaunay triangulation is supposedly a convex hull. In
certain cases this implementation may not generate the convex hull. This
behavior can be controlled by the Offset instance variable. Offset is a
multiplier used to control the size of the initial triangulation. The larger
the offset value, the more likely you will generate a convex hull; and the more
likely you are to see numerical problems. The implementation of this algorithm
varies from the 2D Delaunay algorithm (i.e., Delaunay2D) in an important way.
When points are injected into the triangulation, the search for the enclosing
tetrahedron is quite different. In the 3D case, the closest previously inserted
point point is found, and then the connected tetrahedra are searched to find
the containing one. (In 2D, a "walk" towards the enclosing triangle is
performed.) If the triangulation is Delaunay, then an enclosing tetrahedron
will be found. However, in degenerate cases an enclosing tetrahedron may not be
found and the point will be rejected.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,439: Line 2,885:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Boundary Edges'''<br>''(BoundaryEdges)''
|'''Input''' (Input)
|
This property specifies the input dataset to the
Delaunay 3D filter.
|
|
If the value of this property is set to 1, boundary edges will be extracted. Boundary edges are defined as lines cells or edges that are used by only one polygon.


| 1
|
|
Only the values 0 and 1 are accepted.
Accepts input of following types:
 
* vtkPointSet
 
|-
|-
| '''Coloring'''<br>''(Coloring)''
|'''Alpha''' (Alpha)
|
|
If the value of this property is set to 1, then the extracted edges are assigned a scalar value based on the type of the edge.
This property specifies the alpha (or distance) value to
 
control the output of this filter. For a non-zero alpha value, only
| 0
edges, faces, or tetra contained within the circumsphere (of radius
alpha) will be output. Otherwise, only tetrahedra will be
output.
|
0.0
|
|
Only the values 0 and 1 are accepted.


|-
|-
| '''Feature Angle'''<br>''(FeatureAngle)''
|'''Tolerance''' (Tolerance)
|
This property specifies a tolerance to control
discarding of closely spaced points. This tolerance is specified as a
fraction of the diagonal length of the bounding box of the
points.
|
|
Ths value of this property is used to define a feature edge. If the surface normal between two adjacent triangles is at least as large as this Feature Angle, a feature edge exists. (See the FeatureEdges property.)
0.001
 
| 30
|
|
The value must be greater than or equal to 0 and less than or equal to 180.


|-
|-
| '''Feature Edges'''<br>''(FeatureEdges)''
|'''Offset''' (Offset)
|
This property specifies a multiplier to control the size
of the initial, bounding Delaunay triangulation.
|
|
If the value of this property is set to 1, feature edges will be extracted. Feature edges are defined as edges that are used by two polygons whose dihedral angle is greater than the feature angle. (See the FeatureAngle property.)
2.5
Toggle whether to extract feature edges.
 
| 1
|
|
Only the values 0 and 1 are accepted.


|-
|-
| '''Input'''<br>''(Input)''
|'''BoundingTriangulation''' (BoundingTriangulation)
|
|
This property specifies the input to the Feature Edges filter.
This boolean controls whether bounding triangulation
 
points (and associated triangles) are included in the output. (These
are introduced as an initial triangulation to begin the triangulation
process. This feature is nice for debugging output.)
|
|
0
|
|
The selected object must be the result of the following: sources (includes readers), filters.
Accepts boolean values (0 or 1).
 
|-
 
|'''AlphaTets''' (AlphaTets)
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
|
 
This boolean controls whether tetrahedrons which satisfy
 
the alpha criterion output when alpha is non-zero.
|
1
|
Accepts boolean values (0 or 1).
|-
|'''AlphaTris''' (AlphaTris)
|
This boolean controls whether triangles which satisfy
the alpha criterion output when alpha is non-zero.
|
1
|
Accepts boolean values (0 or 1).
|-
|-
| '''Manifold Edges'''<br>''(ManifoldEdges)''
|'''AlphaLines''' (AlphaLines)
|
|
If the value of this property is set to 1, manifold edges will be extracted. Manifold edges are defined as edges that are used by exactly two polygons.
This boolean controls whether lines which satisfy the
 
alpha criterion output when alpha is non-zero.
| 0
|
0
|
|
Only the values 0 and 1 are accepted.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Non-Manifold Edges'''<br>''(NonManifoldEdges)''
|'''AlphaVerts''' (AlphaVerts)
|
This boolean controls whether vertices which satisfy the
alpha criterion are output when alpha is non-zero.
|
|
If the value of this property is set to 1, non-manifold ediges will be extracted. Non-manifold edges are defined as edges that are use by three or more polygons.
0
 
| 1
|
|
Only the values 0 and 1 are accepted.
Accepts boolean values (0 or 1).
 


|}
|}


==Descriptive Statistics==


==Generate Ids==
Compute a statistical model of a dataset and/or assess the dataset with a statistical model.
 
This filter either computes a statistical model of a dataset or takes
 
such a model as its second input. Then, the model (however it is
Generate scalars from point and cell ids.
obtained) may optionally be used to assess the input dataset.&lt;p&gt;
 
This filter computes the min, max, mean, raw moments M2 through M4,
This filter generates scalars  using cell and point ids. That is, the point attribute data scalars are generated from the point ids, and the cell attribute data scalars or field data are generated from the the cell ids.<br>
standard deviation, skewness, and kurtosis for each array you
select.&lt;p&gt; The model is simply a univariate Gaussian distribution
with the mean and standard deviation provided. Data is assessed using
this model by detrending the data (i.e., subtracting the mean) and then
dividing by the standard deviation. Thus the assessment is an array whose
entries are the number of standard deviations from the mean that each
input point lies.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,529: Line 2,999:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Array Name'''<br>''(ArrayName)''
|'''Input''' (Input)
|
The input to the filter. Arrays from this dataset will
be used for computing statistics and/or assessed by a statistical
model.
|
|
The name of the array that will contain ids.


| Ids
|
|
Accepts input of following types:
* vtkImageData
* vtkStructuredGrid
* vtkPolyData
* vtkUnstructuredGrid
* vtkTable
* vtkGraph
The dataset must contain a field array ()
|-
|-
| '''Input'''<br>''(Input)''
|'''ModelInput''' (ModelInput)
|
A previously-calculated model with which to assess a
separate dataset. This input is optional.
|
|
This property specifies the input to the Cell Data to Point Data filter.


|
|
Accepts input of following types:
* vtkTable
* vtkMultiBlockDataSet
|-
|'''AttributeMode''' (AttributeMode)
|
Specify which type of field data the arrays will be
drawn from.
|
0
|
The value must be field array name.
|-
|'''Variables of Interest''' (SelectArrays)
|
Choose arrays whose entries will be used to form
observations for statistical analysis.
|
|
The selected object must be the result of the following: sources (includes readers), filters.


|


The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
|-
|'''Task''' (Task)
|
Specify the task to be performed: modeling and/or
assessment. &lt;ol&gt; &lt;li&gt; "Detailed model of input data,"
creates a set of output tables containing a calculated statistical
model of the &lt;b&gt;entire&lt;/b&gt; input dataset;&lt;/li&gt;
&lt;li&gt; "Model a subset of the data," creates an output table (or
tables) summarizing a &lt;b&gt;randomly-chosen subset&lt;/b&gt; of the
input dataset;&lt;/li&gt; &lt;li&gt; "Assess the data with a model,"
adds attributes to the first input dataset using a model provided on
the second input port; and&lt;/li&gt; &lt;li&gt; "Model and assess the
same data," is really just operations 2 and 3 above applied to the same
input dataset. The model is first trained using a fraction of the input
data and then the entire dataset is assessed using that
model.&lt;/li&gt; &lt;/ol&gt; When the task includes creating a model
(i.e., tasks 2, and 4), you may adjust the fraction of the input
dataset used for training. You should avoid using a large fraction of
the input data for training as you will then not be able to detect
overfitting. The &lt;i&gt;Training fraction&lt;/i&gt; setting will be
ignored for tasks 1 and 3.
|
3
|
The value(s) is an enumeration of the following:
* Detailed model of input data (0)
* Model a subset of the data (1)
* Assess the data with a model (2)
* Model and assess the same data (3)
|-
|'''TrainingFraction''' (TrainingFraction)
|
Specify the fraction of values from the input dataset to
be used for model fitting. The exact set of values is chosen at random
from the dataset.
|
0.1
|


|-
|'''Deviations should be''' (SignedDeviations)
|
Should the assessed values be signed deviations or
unsigned?
|
0
|
The value(s) is an enumeration of the following:
* Unsigned (0)
* Signed (1)


|}
|}


==Elevation==


==Generate Quadrature Points==
Create point attribute array by projecting points onto an elevation vector.
 
The Elevation filter generates point scalar values for an
 
input dataset along a specified direction vector. The
Create a point set with data at quadrature points.
Input menu allows the user to select the data set to which
 
this filter will be applied. Use the Scalar range entry
"Create a point set with data at quadrature points."<br>
boxes to specify the minimum and maximum scalar value to
be generated. The Low Point and High Point define a line
onto which each point of the data set is projected. The
minimum scalar value is associated with the Low Point, and
the maximum scalar value is associated with the High
Point. The scalar value for each point in the data set is
determined by the location along the line to which that
point projects.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,565: Line 3,122:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Input'''<br>''(Input)''
|'''Input''' (Input)