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

From KitwarePublic
Jump to navigationJump to search
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==AMR Contour==


Iso surface cell array.
==AMR Connectivity==
 
Fragment Identification


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 13: Line 14:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input of the filter.
This property specifies the volume input of the
filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkCompositeDataSet
* vtkNonOverlappingAMR
The dataset much contain a field array (cell)
The dataset must contain a field array (cell)


with 1 component(s).
with 1 component(s).
Line 26: Line 28:
|'''SelectMaterialArrays''' (SelectMaterialArrays)
|'''SelectMaterialArrays''' (SelectMaterialArrays)
|
|
 
This property specifies the cell arrays from which the
This property specifies the cell arrays from which the contour filter will
analysis will determine fragments
compute contour cells.
|
|


Line 37: Line 37:
|'''Volume Fraction Value''' (VolumeFractionSurfaceValue)
|'''Volume Fraction Value''' (VolumeFractionSurfaceValue)
|
|
 
This property specifies the values at which to compute
This property specifies the values at which to compute the isosurface.
the isosurface.
|
|
0.1
0.1
Line 45: Line 44:


|-
|-
|'''Capping''' (Capping)
|'''Resolve Blocks''' (Resolve Blocks)
|
|
 
Resolve the fragments between blocks.
If this property is on, the the boundary of the data set is capped.
|
|
1
1
Line 55: Line 52:
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|-
|'''DegenerateCells''' (DegenerateCells)
|'''Propagate Ghosts''' (Propagate Ghosts)
|
|
 
Propagate regionIds into the ghosts.
If this property is on, a transition mesh between levels is created.
|
|
1
0
|
Accepts boolean values (0 or 1).
|-
|'''MultiprocessCommunication''' (MultiprocessCommunication)
|
 
If this property is off, each process executes independantly.
|
1
|
Accepts boolean values (0 or 1).
|-
|'''SkipGhostCopy''' (SkipGhostCopy)
|
 
A simple test to see if ghost values are already set properly.
|
1
|
Accepts boolean values (0 or 1).
|-
|'''Triangulate''' (Triangulate)
|
 
Use triangles instead of quads on capping surfaces.
|
1
|
Accepts boolean values (0 or 1).
|-
|'''MergePoints''' (MergePoints)
|
 
Use more memory to merge points on the boundaries of blocks.
|
1
|
|
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
Line 107: Line 62:
|}
|}


==AMR Dual Clip==
==AMR Contour==


Clip with scalars. Tetrahedra.
Iso surface cell array.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 121: Line 76:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input of the filter.
This property specifies the input of the
filter.
|
|


Line 127: Line 83:
Accepts input of following types:
Accepts input of following types:
* vtkCompositeDataSet
* vtkCompositeDataSet
The dataset much contain a field array (cell)
The dataset must contain a field array (cell)


with 1 component(s).
with 1 component(s).
Line 134: Line 90:
|'''SelectMaterialArrays''' (SelectMaterialArrays)
|'''SelectMaterialArrays''' (SelectMaterialArrays)
|
|
 
This property specifies the cell arrays from which the
This property specifies the cell arrays from which the clip filter will
contour filter will compute contour cells.
compute clipped cells.
|
|


Line 145: Line 99:
|'''Volume Fraction Value''' (VolumeFractionSurfaceValue)
|'''Volume Fraction Value''' (VolumeFractionSurfaceValue)
|
|
 
This property specifies the values at which to compute
This property specifies the values at which to compute the isosurface.
the isosurface.
|
|
0.1
0.1
Line 153: Line 106:


|-
|-
|'''InternalDecimation''' (InternalDecimation)
|'''Capping''' (Capping)
|
|
 
If this property is on, the the boundary of the data set
If this property is on, internal tetrahedra are decimation
is capped.
|
|
1
1
Line 163: Line 115:
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|-
|'''MultiprocessCommunication''' (MultiprocessCommunication)
|'''DegenerateCells''' (DegenerateCells)
|
|
 
If this property is on, a transition mesh between levels
If this property is off, each process executes independantly.
is created.
|
|
1
1
Line 173: Line 124:
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|-
|'''MergePoints''' (MergePoints)
|'''MultiprocessCommunication''' (MultiprocessCommunication)
|
|
 
If this property is off, each process executes
Use more memory to merge points on the boundaries of blocks.
independantly.
|
|
1
1
|
|
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|}
==All to N==
Redistribute data to a subset of available processes.
The All to N filter is available when ParaView is run in parallel. It redistributes the data so that it is located on the number of processes specified in the Number of Processes entry box. It also does load-balancing of the data among these processes. This filter operates on polygonal data and produces polygonal output.
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''SkipGhostCopy''' (SkipGhostCopy)
| '''Description'''
|
| '''Default Value(s)'''
A simple test to see if ghost values are already set
| '''Restrictions'''
properly.
 
|
1
|
Accepts boolean values (0 or 1).
|-
|-
|'''Input''' (Input)
|'''Triangulate''' (Triangulate)
|
|
 
Use triangles instead of quads on capping
Set the input to the All to N filter.
surfaces.
|
|
 
1
|
|
Accepts input of following types:
Accepts boolean values (0 or 1).
* vtkPolyData
|-
|-
|'''Number of Processes''' (NumberOfProcesses)
|'''MergePoints''' (MergePoints)
|
|
 
Use more memory to merge points on the boundaries of
Set the number of processes across which to split the input data.
blocks.
|
|
1
1
|
|
 
Accepts boolean values (0 or 1).


|}
|}


==Annotate Time Filter==
==AMR CutPlane==
 
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.


Planar Cut of an AMR grid datasetThis filter
creates a cut-plane of the


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 237: Line 176:
|-
|-
|'''Input''' (Input)
|'''Input''' (Input)
|
This property specifies the input for this
filter.
|
|


This property specifies the input dataset for which to display the time.
|
|
 
Accepts input of following types:
* vtkOverlappingAMR
|-
|'''UseNativeCutter''' (UseNativeCutter)
|
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).
|-
|-
|'''Format''' (Format)
|'''LevelOfResolution''' (LevelOfResolution)
|
|
 
Set maximum slice resolution.
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
0
|
|


|-
|-
|'''Shift''' (Shift)
|'''Center''' (Center)
|
|


The amount of time the input is shifted (after scaling).
|
|
0.0
0.5 0.5 0.5
|
|


|-
|-
|'''Scale''' (Scale)
|'''Normal''' (Normal)
|
|


The factor by which the input time is scaled.
|
|
1.0
0 0 1
|
|


Line 278: Line 221:
|}
|}


==Append Attributes==
==AMR Dual Clip==
 
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.


Clip with scalars. Tetrahedra.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 294: Line 235:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
This property specifies the input of the
This property specifies the input to the Append Attributes filter.
filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkCompositeDataSet
The dataset must contain a field array (cell)


|}
with 1 component(s).


==Append Datasets==
|-
|'''SelectMaterialArrays''' (SelectMaterialArrays)
|
This property specifies the cell arrays from which the
clip filter will compute clipped cells.
|


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


{| 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''' (Input)
|'''MergePoints''' (MergePoints)
|
|
 
Use more memory to merge points on the boundaries of
This property specifies the datasets to be merged into a single dataset by the Append Datasets filter.
blocks.
|
|
 
1
|
|
Accepts input of following types:
Accepts boolean values (0 or 1).
* vtkDataSet


|}
|}


==Append Geometry==
==AMR 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.


Fragment Integration


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 348: Line 308:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
This property specifies the volume input of the
Set the input to the Append Geometry filter.
filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkPolyData
* vtkNonOverlappingAMR
The dataset must contain a field array (cell)


|}
with 1 component(s).


==Balance==
|-
|'''SelectMaterialArrays''' (SelectMaterialArrays)
|
This property specifies the cell arrays from which the
analysis will determine fragments
|


Balance data among available processes.
|
The Balance filter is available when ParaView is run in parallel. It does load-balancing so that all processes have the same number of cells. It operates on polygonal data sets and produces polygonal output.
An array of scalars is required.
 
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''SelectMassArrays''' (SelectMassArrays)
| '''Description'''
|
| '''Default Value(s)'''
This property specifies the cell arrays from which the
| '''Restrictions'''
analysis will determine fragment mass
|


|
An array of scalars is required.
|-
|-
|'''Input''' (Input)
|'''SelectVolumeWeightedArrays''' (SelectVolumeWeightedArrays)
|
|
 
This property specifies the cell arrays from which the
Set the input to the Balance filter.
analysis will determine volume weighted average values
|
|


|
|
Accepts input of following types:
An array of scalars is required.
* vtkPolyData
 
|}
 
==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.
 
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''SelectMassWeightedArrays''' (SelectMassWeightedArrays)
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''Input''' (Input)
|
|
 
This property specifies the cell arrays from which the
This property specifies the input to the Level Scalars filter.
analysis will determine mass weighted average values
|
|


|
|
Accepts input of following types:
An array of scalars is required.
* vtkMultiBlockDataSet


|}
|}


==CTH Surface==
==AMR Fragments Filter==


Not finished yet.
Meta Fragment filterCombines the running of
AMRContour, AMRFragmentIntegration, AMRDualContour and ExtractCTHParts


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 427: Line 373:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input of the filter.
This property specifies the volume input of the
filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkCompositeDataSet
* vtkNonOverlappingAMR
The dataset must contain a field array (cell)


|}
with 1 component(s).


==CacheKeeper==
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 previously cached
then this filter shuts the update request, otherwise propagates the
update and then cache the result for later use. The current time step
is set using SetCacheTime().
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''SelectMaterialArrays''' (SelectMaterialArrays)
| '''Description'''
|
| '''Default Value(s)'''
This property specifies the cell arrays from which the
| '''Restrictions'''
analysis will determine fragments
|


|
An array of scalars is required.
|-
|-
|'''Input''' (Input)
|'''SelectMassArrays''' (SelectMassArrays)
|
|
 
This property specifies the cell arrays from which the
Set the input to the Update Suppressor filter.
analysis will determine fragment mass
|
|


|
An array of scalars is required.
|-
|'''SelectVolumeWeightedArrays''' (SelectVolumeWeightedArrays)
|
This property specifies the cell arrays from which the
analysis will determine volume weighted average values
|
|


|
An array of scalars is required.
|-
|-
|'''CacheTime''' (CacheTime)
|'''SelectMassWeightedArrays''' (SelectMassWeightedArrays)
|
This property specifies the cell arrays from which the
analysis will determine mass weighted average values
|
|


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


|-
|-
|'''CachingEnabled''' (CachingEnabled)
|'''Extract Surface''' (Extract Surface)
|
Whether or not to extract a surface from this data
|
0
|
Accepts boolean values (0 or 1).
|-
|'''Use Watertight Surface''' (Use Watertight Surface)
|
Whether the extracted surface should be watertight or not
|
0
|
Accepts boolean values (0 or 1).
|-
|'''Integrate Fragments''' (Integrate Fragments)
|
|
 
Whether or not to integrate fragments in this data
Toggle whether the caching is enabled.
|
|
1
1
Line 485: Line 456:
|}
|}


==Calculator==
==Add Field Arrays==


Compute new attribute arrays as function of existing arrays.
Reads arrays from a file and adds them to the input data object.
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.
Takes in an input data object and a filename. Opens the file
Each of the calculator functions is described below. Unless otherwise noted, enclose the operand in parentheses using the ( and ) buttons.
and adds any arrays it sees there to the input data.
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 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.




Line 535: Line 472:
|-
|-
|'''Input''' (Input)
|'''Input''' (Input)
|
The input.
|
|


This property specifies the input dataset to the Calculator filter. The scalar and vector variables may be chosen from this dataset's arrays.
|
|


|
Accepts input of following types:
* vtkDataSet
|-
|-
|'''ResultArrayName''' (ResultArrayName)
|'''FileName''' (FileName)
|
|


This property contains the name for the output array containing the result of this computation.
This property specifies the file to read to get arrays
 
|
|
Result
 
|
|
The value(s) must be a filename (or filenames).
|}


==Angular Periodic Filter==
This filter generate a periodic multiblock dataset.This filter generate a periodic
multiblock dataset
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
|'''Function''' (Function)
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''Input''' (Input)
|
|
This property specifies the input to the Periodic filter.


This property contains the equation for computing the new array.
|
|


|
|
 
Accepts input of following types:
* vtkDataSet
|-
|-
|'''CoordinateResults''' (CoordinateResults)
|'''BlockIndices''' (BlockIndices)
|
This property lists the ids of the blocks to make periodic
from the input multiblock dataset.
|
|


The value of this property determines whether the results of this computation should be used as point coordinates or as a new array.
|


|-
|'''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°.
|
|
0
1
|
|
Accepts boolean values (0 or 1).
The value(s) is an enumeration of the following:
* Manual (0)
* Maximum (1)
|-
|-
|'''AttributeMode''' (AttributeMode)
|'''NumberOfPeriods''' (NumberOfPeriods)
|
This property specifies the number of iteration
|
3
|
|


This property determines whether the computation is to be performed on point-centered or cell-centered data.
|-
 
|'''RotationMode''' (RotationMode)
|
This property specifies the mode of rotation, either from a user provided
angle or from an array in the data.
|
|
0
0
|
|
The value(s) is an enumeration of the following:
The value(s) is an enumeration of the following:
* point_data (1)
* Direct Angle (0)
* cell_data (2)
* Array Value (1)
* field_data (5)
|-
|-
|'''Replace Invalid Results''' (ReplaceInvalidValues)
|'''RotationAngle''' (RotationAngle)
|
|
 
Rotation angle in degree.
This property determines whether invalid values in the computation will be replaced with a specific value. (See the ReplacementValue property.)


|
|
1
10
|
|
Accepts boolean values (0 or 1).
 
|-
|-
|'''ReplacementValue''' (ReplacementValue)
|'''RotationArrayName''' (RotationArrayName)
|
|
 
Field array name that contains the rotation angle in radian.
If invalid values in the computation are to be replaced with another value, this property contains that value.


|
|
0.0
periodic angle
|
|


|}
==Cell Centers==
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.
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''Axis''' (Axis)
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''Input''' (Input)
|
|
 
This property specifies the axis of rotation
This property specifies the input to the Cell Centers filter.
|
|
 
0
|
|
Accepts input of following types:
The value(s) is an enumeration of the following:
* vtkDataSet
* Axis X (0)
* Axis Y (1)
* Axis Z (2)
|-
|-
|'''VertexCells''' (VertexCells)
|'''Center''' (Center)
|
|
 
This property specifies the 3D coordinates for the
If set to 1, a vertex cell will be generated per point in the output. Otherwise only points will be generated.
center of the rotation.
 
|
|
0
0.0 0.0 0.0
|
|
Accepts boolean values (0 or 1).
 


|}
|}


==Cell Data to Point Data==
==Annotate Attribute Data==


Create point attributes by averaging cell attributes.
Adds a text annotation to a Rander View
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.
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.




Line 664: Line 618:
|
|


This property specifies the input to the Cell Data to Point Data filter.
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.
 
|
|


Line 671: Line 627:
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkDataSet
The dataset much contain a field array (cell)
* vtkTable
The dataset must contain a field array (any)
 
with 1 component(s).


|-
|-
|'''PassCellData''' (PassCellData)
|'''ArrayAssociation''' (ArrayAssociation)
|
|
 
Select the attribute to use to popular array names from.
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.
|
 
2
|
The value(s) is an enumeration of the following:
* Point Data (0)
* Cell Data (1)
* Field Data (2)
* Row Data (6)
|-
|'''ArrayName''' (ArrayName)
|
Choose arrays that is going to be displayed
|
 
|
 
|-
|'''ElementId''' (ElementId)
|
 
Set the element index to annotate with.
 
|
|
0
0
|
|
Accepts boolean values (0 or 1).
 
|-
|-
|'''PieceInvariant''' (PieceInvariant)
|'''ProcessId''' (ProcessId)
|
|


If the value of this property is set to 1, this filter will request ghost levels so that the values at boundary points match across processes. NOTE: Enabling this option might cause multiple executions of the data source because more information is needed to remove internal surfaces.
Set the process rank to extract element from.


|
|
0
0
|
|
Accepts boolean values (0 or 1).
 
|-
|'''Prefix''' (Prefix)
|
Text that is used as a prefix to the field value
|
Value is:
|
 


|}
|}


==Clean==
==Annotate Global Data==


Merge coincident points if they do not meet a feature edge criteria.
Filter for annotating with global data (designed for ExodusII reader)
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).
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.




Line 712: Line 707:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
Set the input of the filter.
Set the input to the Clean filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkPolyData
* vtkDataSet
|-
The dataset must contain a field array (none)
|'''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.
with 1 component(s).


|-
|'''SelectArrays''' (SelectArrays)
|
|
1
Choose arrays that is going to be
|
displayed
Accepts boolean values (0 or 1).
|-
|'''Tolerance''' (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.0
|
|


|-
|-
|'''AbsoluteTolerance''' (AbsoluteTolerance)
|'''Prefix''' (Prefix)
|
|
 
Text that is used as a prefix to the field
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.
value
 
|
|
1.0
Value is:
|
|


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


This property determines whether to use absolute or relative (a percentage of the bounding box) tolerance when performing point merging.
|
0
|
Accepts boolean values (0 or 1).
|-
|'''ConvertLinesToPoints''' (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.


|}
==Annotate Time Filter==
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.
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
|'''Input''' (Input)
|
This property specifies the input dataset for which to
display the time.
|
|
1
 
|
|
Accepts boolean values (0 or 1).
 
|-
|-
|'''ConvertPolysToLines''' (ConvertPolysToLines)
|'''Format''' (Format)
|
|
 
The value of this property is a format string used to
If this property is set to 1, degenerate polygons (a "polygon" with only two distinct point coordinates) will be converted to lines.
display the input time. The format string is specified using printf
 
style.
|
|
1
Time: %f
|
|
Accepts boolean values (0 or 1).
 
|-
|-
|'''ConvertStripsToPolys''' (ConvertStripsToPolys)
|'''Shift''' (Shift)
|
|
 
The amount of time the input is shifted (after
If this property is set to 1, degenerate triangle strips (a triangle "strip" containing only one triangle) will be converted to triangles.
scaling).
 
|
|
1
0.0
|
|
Accepts boolean values (0 or 1).
 
|-
|-
|'''PointMerging''' (PointMerging)
|'''Scale''' (Scale)
|
|
 
The factor by which the input time is
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.
scaled.
 
|
|
1
1.0
|
|
Accepts boolean values (0 or 1).
 


|}
|}


==Clean Cells to Grid==
==Append Attributes==
 
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. 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).


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"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 823: Line 824:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
This property specifies the input to the Append
This property specifies the input to the Clean Cells to Grid filter.
Attributes filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkUnstructuredGrid
* vtkDataSet


|}
|}


==Clean to Grid==
==Append Datasets==
 
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.


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.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 850: Line 857:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
This property specifies the datasets to be merged into a
This property specifies the input to the Clean to Grid filter.
single dataset by the Append Datasets filter.
|
|


Line 861: Line 867:
|}
|}


==ClientServerMoveData==
==Append Geometry==
 


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.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 875: Line 885:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
Set the input to the Append Geometry
Set the input to the Client Server Move Data filter.
filter.
|
|


|
|
Accepts input of following types:
* vtkPolyData
|}


|-
==Block Scalars==
|'''OutputDataType''' (OutputDataType)
|


|
The Level Scalars filter uses colors to show levels of a multiblock dataset.The Level
0
Scalars filter uses colors to show levels of a multiblock
|
dataset.


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


|-
|'''Input''' (Input)
|
|
0 -1 0 -1 0 -1
This property specifies the input to the Level Scalars
filter.
|
|


|
Accepts input of following types:
* vtkMultiBlockDataSet


|}
|}


==Clip==
==CTH Surface==
 
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 implicit plane. This filter operates on all types of data sets, and it returns unstructured grid data on output.


Not finished yet.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 917: Line 935:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
This property specifies the input of the
This property specifies the dataset on which the Clip filter will operate.
filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkCompositeDataSet
The dataset much contain a field array ()


with 1 component(s).
|}


|-
==CacheKeeper==
|'''Clip Type''' (ClipFunction)
|


This property specifies the parameters of the clip function (an implicit plane) used to clip the dataset.
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
previously cached then this filter shuts the update request, otherwise
propagates the update and then cache the result for later use. The
current time step is set using SetCacheTime().


|
{| class="PropertiesTable" border="1" cellpadding="5"
The value can be one of the following:
|-
* Plane (implicit_functions)
| '''Property'''
 
| '''Description'''
* Box (implicit_functions)
| '''Default Value(s)'''
 
| '''Restrictions'''
* Sphere (implicit_functions)
 
* Scalar (implicit_functions)


|-
|-
|'''InputBounds''' (InputBounds)
|'''Input''' (Input)
|
|
 
Set the input to the Update Suppressor
filter.
|
|


Line 956: Line 971:


|-
|-
|'''Scalars''' (SelectInputScalars)
|'''CacheTime''' (CacheTime)
|
|


If clipping with scalars, this property specifies the name of the scalar array on which to perform the clip operation.
|
0.0
|
|


|
An array of scalars is required.The value must be field array name.
|-
|-
|'''Value''' (Value)
|'''CachingEnabled''' (CachingEnabled)
|
|
 
Toggle whether the caching is enabled.
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
1
|
The value must lie within the range of the selected data array.
|-
|'''InsideOut''' (InsideOut)
|
|
Accepts boolean values (0 or 1).


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.
|}


|
==Calculator==
0
|
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.
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
0
point-centered arrays are used in the computation of a new data array,
|
the resulting array will also be point-centered. Similarly,
Accepts boolean values (0 or 1).
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.


==Clip Closed Surface==
- Clear: Erase the current function (displayed in the read-only text
 
box above the calculator buttons).
Clip a polygonal dataset with a plane to produce closed surfaces
- /: Divide one scalar by another. The operands for this function are
This clip filter cuts away a portion of the input polygonal dataset using a plane to generate a new polygonal dataset.
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 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 1,014: Line 1,066:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
This property specifies the input dataset to the
This property specifies the dataset on which the Clip filter will operate.
Calculator filter. The scalar and vector variables may be chosen from
this dataset's arrays.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkPolyData
* vtkDataSet
The dataset much contain a field array (point)
The dataset must contain a field array ()
 
with 1 component(s).


|-
|-
|'''Clipping Plane''' (ClippingPlane)
|'''AttributeMode''' (AttributeMode)
|
|
 
This property determines whether the computation is to
This property specifies the parameters of the clipping plane used to clip the polygonal data.
be performed on point-centered or cell-centered data.
|
|
 
1
|
|
The value can be one of the following:
The value(s) is an enumeration of the following:
* Plane (implicit_functions)
* Point Data (1)
 
* Cell Data (2)
|-
|-
|'''GenerateFaces''' (GenerateFaces)
|'''CoordinateResults''' (CoordinateResults)
|
|
 
The value of this property determines whether the
Generate polygonal faces in the output.
results of this computation should be used as point coordinates or as a
 
new array.
|
|
1
0
|
|
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|-
|'''GenerateOutline''' (GenerateOutline)
|'''ResultNormals''' (ResultNormals)
|
|
 
Set whether to output results as point/cell
Generate clipping outlines in the output wherever an input face is cut by the clipping plane.
normals. Outputing as normals is only valid with vector
 
results. Point or cell normals are selected using
AttributeMode.
|
|
0
0
Line 1,059: Line 1,109:
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|-
|'''Generate Cell Origins''' (GenerateColorScalars)
|'''ResultTCoords''' (ResultTCoords)
|
|
 
Set whether to output results as point/cell
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.
texture coordinates. Point or cell texture coordinates are
 
selected using AttributeMode. 2-component texture coordinates
cannot be generated at this time.
|
|
0
0
Line 1,069: Line 1,120:
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|-
|'''InsideOut''' (InsideOut)
|'''ResultArrayName''' (ResultArrayName)
|
|
 
This property contains the name for the output array
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.
containing the result of this computation.
 
|
|
0
Result
|
|
Accepts boolean values (0 or 1).
 
|-
|-
|'''Clipping Tolerance''' (Tolerance)
|'''Function''' (Function)
|
|


Specify the tolerance for creating new points. A small value might incur degenerate triangles.
This property contains the equation for computing the new
array.


|
|
0.000001
 
|
|


|-
|-
|'''Base Color''' (BaseColor)
|'''Replace Invalid Results''' (ReplaceInvalidValues)
|
|
 
This property determines whether invalid values in the
Specify the color for the faces from the input.
computation will be replaced with a specific value. (See the
 
ReplacementValue property.)
|
|
0.10 0.10 1.00
1
|
|
 
Accepts boolean values (0 or 1).
|-
|-
|'''Clip Color''' (ClipColor)
|'''ReplacementValue''' (ReplacementValue)
|
|
 
If invalid values in the computation are to be replaced
Specifiy the color for the capping faces (generated on the clipping interface).
with another value, this property contains that value.
 
|
|
1.00 0.11 0.10
0.0
|
|


Line 1,111: Line 1,161:
|}
|}


==Clip Generic Dataset==
==Cell Centers==
 
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.


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.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,129: Line 1,187:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
This property specifies the input to the Cell Centers
Set the input to the Generic Clip filter.
filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkGenericDataSet
* vtkDataSet
The dataset much contain a field array (point)
 
|-
|-
|'''Clip Type''' (ClipFunction)
|'''VertexCells''' (VertexCells)
|
If set to 1, a vertex cell will be generated per point
in the output. Otherwise only points will be generated.
|
|
 
0
Set the parameters of the clip function.
|
|
Accepts boolean values (0 or 1).


|
|}
The value can be one of the following:
* Plane (implicit_functions)


* Box (implicit_functions)
==Cell Data to Point Data==


* Sphere (implicit_functions)
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.


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


|-
|-
|'''InputBounds''' (InputBounds)
|'''Input''' (Input)
|
|
 
This property specifies the input to the Cell Data to
Point Data filter.
|
|


|
|
Accepts input of following types:
* vtkDataSet
The dataset must contain a field array (cell)


|-
|-
|'''Scalars''' (SelectInputScalars)
|'''PassCellData''' (PassCellData)
|
|
 
If this property is set to 1, then the input cell data
If clipping with scalars, this property specifies the name of the scalar array on which to perform the clip operation.
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.The value must be field array name.
Accepts boolean values (0 or 1).
|-
|-
|'''InsideOut''' (InsideOut)
|'''PieceInvariant''' (PieceInvariant)
|
|
 
If the value of this property is set to 1, this filter
Choose which portion of the dataset should be clipped away.
will request ghost levels so that the values at boundary points match
 
across processes. NOTE: Enabling this option might cause multiple
executions of the data source because more information is needed to
remove internal surfaces.
|
|
0
0
|
|
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|'''Value''' (Value)
|
If clipping with a scalar array, choose the clipping value.
|
0.0
|
The value must lie within the range of the selected data array.


|}
|}


==Compute Derivatives==
==Clean==
 
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 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.


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
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).


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,214: Line 1,278:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
Set the input to the Clean filter.
This property specifies the input to the filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkPolyData
The dataset much contain a field array (point)
 
with 1 component(s).
 
The dataset much contain a field array (point)
 
with 3 component(s).
 
|-
|-
|'''Scalars''' (SelectInputScalars)
|'''PieceInvariant''' (PieceInvariant)
|
|
 
If this property is set to 1, the whole data set will be
This property indicates the name of the scalar array to differentiate.
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.
|
|
 
1
|
|
An array of scalars is required.
Accepts boolean values (0 or 1).
|-
|-
|'''Vectors''' (SelectInputVectors)
|'''Tolerance''' (Tolerance)
|
|
 
If merging nearby points (see PointMerging property) and
This property indicates the name of the vector array to differentiate.
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.
|
|
1
0.0
|
|
An array of vectors is required.
 
|-
|-
|'''OutputVectorType''' (OutputVectorType)
|'''AbsoluteTolerance''' (AbsoluteTolerance)
|
|
 
If merging nearby points (see PointMerging property) and
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.
using absolute tolerance (see ToleranceIsAbsolute property), this
 
property specifies the tolerance for performing merging in the spatial
units of the input data set.
|
|
1
1.0
|
|
The value(s) is an enumeration of the following:
 
* Nothing (0)
* Scalar Gradient (1)
* Vorticity (2)
|-
|-
|'''OutputTensorType''' (OutputTensorType)
|'''ToleranceIsAbsolute''' (ToleranceIsAbsolute)
|
|
 
This property determines whether to use absolute or
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.
relative (a percentage of the bounding box) tolerance when performing
 
point merging.
|
|
1
0
|
|
The value(s) is an enumeration of the following:
Accepts boolean values (0 or 1).
* Nothing (0)
* Vector Gradient (1)
* Strain (2)
 
|}
 
==Connectivity==
 
Mark connected components with integer point attribute array.
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.
 
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''ConvertLinesToPoints''' (ConvertLinesToPoints)
| '''Description'''
|
| '''Default Value(s)'''
If this property is set to 1, degenerate lines (a "line"
| '''Restrictions'''
whose endpoints are at the same spatial location) will be converted to
 
points.
|
1
|
Accepts boolean values (0 or 1).
|-
|-
|'''Input''' (Input)
|'''ConvertPolysToLines''' (ConvertPolysToLines)
|
|
 
If this property is set to 1, degenerate polygons (a
This property specifies the input to the Connectivity filter.
"polygon" with only two distinct point coordinates) will be converted
to lines.
|
|
 
1
|
|
Accepts input of following types:
Accepts boolean values (0 or 1).
* vtkDataSet
|-
|-
|'''ExtractionMode''' (ExtractionMode)
|'''ConvertStripsToPolys''' (ConvertStripsToPolys)
|
|
 
If this property is set to 1, degenerate triangle strips
Controls the extraction of connected surfaces.
(a triangle "strip" containing only one triangle) will be converted to
 
triangles.
|
|
5
1
|
|
The value(s) is an enumeration of the following:
Accepts boolean values (0 or 1).
* 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)
|-
|-
|'''ColorRegions''' (ColorRegions)
|'''PointMerging''' (PointMerging)
|
|
 
If this property is set to 1, then points will be merged
Controls the coloring of the connected regions.
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
1
Line 1,332: Line 1,378:
|}
|}


==Contingency Statistics==
==Clean Cells to Grid==
 
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 obtained) may optionally be used to assess the input dataset.
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 <ul>
<li> the probability of observing both variables simultaneously;
<li> the probability of each variable conditioned on the other (the two values need not be identical); and
<li> the pointwise mutual information (PMI). </ul>
Finally, the summary statistics include the information entropy of the observations.


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.
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,353: Line 1,398:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
This property specifies the input to the Clean Cells to
The input to the filter. Arrays from this dataset will be used for computing statistics and/or assessed by a statistical model.
Grid filter.
 
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkImageData
* vtkStructuredGrid
* vtkPolyData
* vtkUnstructuredGrid
* vtkUnstructuredGrid
* vtkTable
* vtkGraph
The dataset much contain a field array ()


|-
|}
|'''ModelInput''' (ModelInput)
|


A previously-calculated model with which to assess a separate dataset. This input is optional.
==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.


|
{| class="PropertiesTable" border="1" cellpadding="5"
Accepts input of following types:
* vtkTable
* vtkMultiBlockDataSet
|-
|-
|'''AttributeMode''' (AttributeMode)
| '''Property'''
|
| '''Description'''
 
| '''Default Value(s)'''
Specify which type of field data the arrays will be drawn from.
| '''Restrictions'''


|
0
|
The value must be field array name.
|-
|-
|'''Variables of Interest''' (SelectArrays)
|'''Input''' (Input)
|
|
 
This property specifies the input to the Clean to Grid
Choose arrays whose entries will be used to form observations for statistical analysis.
filter.
 
|
|


|
|
 
Accepts input of following types:
|-
* vtkDataSet
|'''Task''' (Task)
|
 
Specify the task to be performed: modeling and/or assessment. <ol>
<li> "Detailed model of input data," creates a set of output tables containing a calculated statistical model of the <b>entire</b> input dataset;</li>
<li> "Model a subset of the data," creates an output table (or tables) summarizing a <b>randomly-chosen subset</b> of the input dataset;</li>
<li> "Assess the data with a model," adds attributes to the first input dataset using a model provided on the second input port; and</li>
<li> "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.</li>
</ol>
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 <i>Training fraction</i> 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
|
 


|}
|}


==Contour==
==ClientServerMoveData==


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 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.




Line 1,448: Line 1,452:
|-
|-
|'''Input''' (Input)
|'''Input''' (Input)
|
Set the input to the Client Server Move Data
filter.
|
|


This property specifies the input dataset to be used by the contour filter.
|
|


|
|-
Accepts input of following types:
|'''OutputDataType''' (OutputDataType)
* vtkDataSet
The dataset much contain a field array (point)
 
with 1 component(s).
 
|-
|'''Contour By''' (SelectInputScalars)
|
 
This property specifies the name of the scalar array from which the contour filter will compute isolines and/or isosurfaces.
|
 
|
An array of scalars is required.The value must be field array name.
|-
|'''Isosurfaces''' (ContourValues)
|
 
This property specifies the values at which to compute isosurfaces/isolines and also the number of such values.
|
|
|
The value must lie within the range of the selected data array.
|-
|'''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)
|
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
0
|
Accepts boolean values (0 or 1).
|-
|'''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.
|
0
|
Accepts boolean values (0 or 1).
|-
|-
|'''Point Merge Method''' (Locator)
|'''WholeExtent''' (WholeExtent)
|
|
This property specifies an incremental point locator for merging duplicate / coincident points.


|
|
 
0 -1 0 -1 0 -1
|
|
The value can be one of the following:
* MergePoints (incremental_point_locators)
* IncrementalOctreeMergePoints (incremental_point_locators)
* NonMergingPointLocator (incremental_point_locators)




|}
|}


==Contour Generic Dataset==
==Clip==
 
Generate isolines or isosurfaces using point scalars.
The Generic Contour filter computes isolines or isosurfaces using a 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 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 values section. Select the number of contour values to generate using the Number of Values slider. The Range slider controls the interval in which to generate the 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.


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
implicit plane. This filter operates on all types of data
sets, and it returns unstructured grid data on
output.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,550: Line 1,496:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
This property specifies the dataset on which the Clip
Set the input to the Generic Contour filter.
filter will operate.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkGenericDataSet
* vtkDataSet
The dataset much contain a field array (point)
The dataset must contain a field array ()


with 1 component(s).
with 1 component(s).


|-
|-
|'''Contour By''' (SelectInputScalars)
|'''Clip Type''' (ClipFunction)
|
This property specifies the parameters of the clip
function (an implicit plane) used to clip the dataset.
|
|


This property specifies the name of the scalar array from which the contour filter will compute isolines and/or isosurfaces.
|
|
The value can be one of the following:
* Plane (implicit_functions)
* Box (implicit_functions)
* Sphere (implicit_functions)
* Cylinder (implicit_functions)
* Scalar (implicit_functions)


|
An array of scalars is required.The value must be field array name.
|-
|-
|'''Isosurfaces''' (ContourValues)
|'''InputBounds''' (InputBounds)
|
|


This property specifies the values at which to compute isosurfaces/isolines and also the number of such values.
|
|


|
|
The value must lie within the range of the selected data array.
 
|-
|-
|'''ComputeNormals''' (ComputeNormals)
|'''Scalars''' (SelectInputScalars)
|
If clipping with scalars, this property specifies the
name of the scalar array on which to perform the clip
operation.
|
|


Select whether to compute normals.
|
|
1
An array of scalars is required.The value must be field array name.
|-
|'''Value''' (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.0
|
|
Accepts boolean values (0 or 1).
The value must lie within the range of the selected data array.
|-
|-
|'''ComputeGradients''' (ComputeGradients)
|'''InsideOut''' (InsideOut)
|
|
 
If this property is set to 0, the clip filter will
Select whether to compute gradients.
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
Line 1,603: Line 1,569:
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|-
|'''ComputeScalars''' (ComputeScalars)
|'''UseValueAsOffset''' (UseValueAsOffset)
|
|
 
If UseValueAsOffset is true, Value is used as an offset
Select whether to compute scalars.
parameter to the implicit function. Otherwise, Value is used only when
 
clipping using a scalar array.
|
|
0
0
Line 1,613: Line 1,579:
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|-
|'''Point Merge Method''' (Locator)
|'''Crinkle clip''' (PreserveInputCells)
|
|
 
This parameter controls whether to extract entire cells
This property specifies an incremental point locator for merging duplicate / coincident points.
in the given region or clip those cells so all of the output one stay
 
only inside that region.
|
|
 
0
|
|
The value can be one of the following:
Accepts boolean values (0 or 1).
* MergePoints (incremental_point_locators)
 
* IncrementalOctreeMergePoints (incremental_point_locators)
 
* NonMergingPointLocator (incremental_point_locators)
 


|}
|}


==ConvertSelection==
==Clip Closed Surface==
 
 
Converts a selection from one type to another.


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.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,645: Line 1,605:


|-
|-
|'''DataInput''' (DataInput)
|'''Input''' (Input)
|
|
 
This property specifies the dataset on which the Clip
Set the vtkDataObject input used to convert the selection.
filter will operate.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkDataObject
* vtkPolyData
The dataset must contain a field array (point)
 
with 1 component(s).
 
|-
|-
|'''Input''' (Input)
|'''Clipping Plane''' (ClippingPlane)
|
This property specifies the parameters of the clipping
plane used to clip the polygonal data.
|
|


Set the selection to convert.
|
|
The value can be one of the following:
* Plane (implicit_functions)


|-
|'''GenerateFaces''' (GenerateFaces)
|
Generate polygonal faces in the output.
|
1
|
|
Accepts input of following types:
Accepts boolean values (0 or 1).
* vtkSelection
|-
|-
|'''OutputType''' (OutputType)
|'''GenerateOutline''' (GenerateOutline)
|
|
 
Generate clipping outlines in the output wherever an
Set the ContentType for the output.
input face is cut by the clipping plane.
|
|
5
0
|
|
The value(s) is an enumeration of the following:
Accepts boolean values (0 or 1).
* SELECTIONS (0)
* GLOBALIDs (1)
* PEDIGREEIDS (2)
* VALUES (3)
* INDICES (4)
* FRUSTUM (5)
* LOCATION (6)
* THRESHOLDS (7)
|-
|-
|'''ArrayNames''' (ArrayNames)
|'''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)
|-
|-
|'''MatchAnyValues''' (MatchAnyValues)
|'''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
0
|
|
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|'''Clipping Tolerance''' (Tolerance)
|
Specify the tolerance for creating new points. A small
value might incur degenerate triangles.
|
0.000001
|


|}
==Crop==
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 maximum extents of each dimension of the data. Both the input and output of this filter are uniform rectilinear data.
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''Base Color''' (BaseColor)
| '''Description'''
|
| '''Default Value(s)'''
Specify the color for the faces from the
| '''Restrictions'''
input.
|
0.10 0.10 1.00
|


|-
|-
|'''Input''' (Input)
|'''Clip Color''' (ClipColor)
|
|
 
Specifiy the color for the capping faces (generated on
This property specifies the input to the Crop filter.
the clipping interface).
|
|
 
1.00 0.11 0.10
|
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.
|
0 0 0 0 0 0
|
The value(s) must lie within the structured-extents of the input dataset.


|}
|}


==Curvature==
==Clip Generic Dataset==
 
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.


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"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,758: Line 1,735:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
Set the input to the Generic Clip
This property specifies the input to the Curvature filter.
filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkPolyData
* vtkGenericDataSet
The dataset must contain a field array (point)
 
|-
|-
|'''InvertMeanCurvature''' (InvertMeanCurvature)
|'''Clip Type''' (ClipFunction)
|
Set the parameters of the clip function.
|
 
|
|
The value can be one of the following:
* Plane (implicit_functions)


If this property is set to 1, the mean curvature calculation will be inverted. This is useful for meshes with inward-pointing normals.
* Box (implicit_functions)


* Sphere (implicit_functions)
* Scalar (implicit_functions)
|-
|'''InputBounds''' (InputBounds)
|
|
0
 
|
 
|
|
Accepts boolean values (0 or 1).
 
|-
|-
|'''CurvatureType''' (CurvatureType)
|'''Scalars''' (SelectInputScalars)
|
If clipping with scalars, this property specifies the
name of the scalar array on which to perform the clip
operation.
|
|


This propery specifies which type of curvature to compute.
|
 
An array of scalars is required.The value must be field array name.
|-
|'''InsideOut''' (InsideOut)
|
Choose which portion of the dataset should be clipped
away.
|
|
0
0
|
|
The value(s) is an enumeration of the following:
Accepts boolean values (0 or 1).
* Gaussian (0)
|-
* Mean (1)
|'''Value''' (Value)
|
If clipping with a scalar array, choose the clipping
value.
|
0.0
|
The value must lie within the range of the selected data array.


|}
|}


==D3==
==Color By Array==
 
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.


This filter generate a color based image data based on a selected data scalar


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,808: Line 1,814:
|
|


This property specifies the input to the D3 filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkImageData
The dataset must contain a field array (point)
 
with 1 component(s).
 
|-
|-
|'''BoundaryMode''' (BoundaryMode)
|'''LookupTable''' (LookupTable)
|
 
|
|


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.
|


|-
|'''Color By''' (SelectInputScalars)
|
|
0
This property specifies the name of the scalar array
from which we will color by.
|
 
|
|
The value(s) is an enumeration of the following:
An array of scalars is required.The value must be field array name.
* Assign cells uniquely (0)
* Duplicate cells (1)
* Divide cells (2)
|-
|-
|'''Minimal Memory''' (UseMinimalMemory)
|'''RGBA NaN Color''' (NaNColor)
|
 
|
0 0 0 255
|
|


If this property is set to 1, the D3 filter requires communication routines to use minimal memory than without this restriction.
|-
|'''OutputFormat''' (OutputFormat)
|


|
|
0
3
|
|
Accepts boolean values (0 or 1).
The value(s) is an enumeration of the following:
* Luminance (1)
* Luminance Alpha (2)
* RGB (3)
* RGBA (4)


|}
|}


==Decimate==
==Compute Derivatives==
 
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.


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
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.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,857: Line 1,884:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
This property specifies the input to the
This property specifies the input to the Decimate filter.
filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkPolyData
* vtkDataSet
The dataset must contain a field array (point)
 
with 1 component(s).
 
The dataset must contain a field array (point)
 
with 3 component(s).
 
|-
|-
|'''TargetReduction''' (TargetReduction)
|'''Scalars''' (SelectInputScalars)
|
This property indicates the name of the scalar array to
differentiate.
|
|


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
An array of scalars is required.
|
 
|-
|-
|'''PreserveTopology''' (PreserveTopology)
|'''Vectors''' (SelectInputVectors)
|
|
 
This property indicates the name of the vector array to
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.
differentiate.
 
|
|
0
1
|
|
Accepts boolean values (0 or 1).
An array of vectors is required.
|-
|-
|'''FeatureAngle''' (FeatureAngle)
|'''OutputVectorType''' (OutputVectorType)
|
|
 
This property Controls how the filter works to generate
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.
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.
|
|
15.0
1
|
|
 
The value(s) is an enumeration of the following:
* Nothing (0)
* Scalar Gradient (1)
* Vorticity (2)
|-
|-
|'''BoundaryVertexDeletion''' (BoundaryVertexDeletion)
|'''OutputTensorType''' (OutputTensorType)
|
|
 
This property controls how the filter works to generate
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.
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.
|
|
1
1
|
|
Accepts boolean values (0 or 1).
The value(s) is an enumeration of the following:
* Nothing (0)
* Vector Gradient (1)
* Strain (2)


|}
|}


==Delaunay 2D==
==Compute Quartiles==


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.
Compute the quartiles table from a dataset or table.
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.


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


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.
|-
|'''Input''' (Input)
|
This property specifies the input to the
filter.
|


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.
|
Accepts input of following types:
* vtkDataObject


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.
==Connectivity==


Mark connected components with integer point attribute array.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.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,935: Line 1,993:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
This property specifies the input to the Connectivity
This property specifies the input dataset to the Delaunay 2D filter.
filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkPointSet
* vtkDataSet
|-
|-
|'''ProjectionPlaneMode''' (ProjectionPlaneMode)
|'''ExtractionMode''' (ExtractionMode)
|
|
 
Controls the extraction of connected
This property determines type of projection plane to use in performing the triangulation.
surfaces.
 
|
|
0
5
|
|
The value(s) is an enumeration of the following:
The value(s) is an enumeration of the following:
* XY Plane (0)
* Extract Point Seeded Regions (1)
* Best-Fitting Plane (2)
* Extract Cell Seeded Regions (2)
* Extract Specified Regions (3)
* Extract Largest Region (4)
* Extract All Regions (5)
* Extract Closes Point Region (6)
|-
|-
|'''Alpha''' (Alpha)
|'''ColorRegions''' (ColorRegions)
|
|
 
Controls the coloring of the connected
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.
regions.
 
|
|
0.0
1
|
 
|-
|'''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.
 
|
0.00001
|
 
|-
|'''Offset''' (Offset)
|
 
This property is a multiplier to control the size of the initial, bounding Delaunay triangulation.
 
|
1.0
|
 
|-
|'''BoundingTriangulation''' (BoundingTriangulation)
|
 
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
|
|
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
Line 1,998: Line 2,027:
|}
|}


==Delaunay 3D==
==Contingency Statistics==
 
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 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" 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.


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
obtained) may optionally be used to assess the input dataset. 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 <ul>
<li> the probability of observing both variables simultaneously;
<li> the probability of each variable conditioned on the other (the
two values need not be identical); and <li> the pointwise mutual
information (PMI). </ul> Finally, the summary statistics include
the information entropy of the observations.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,081: Line 2,052:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input to the filter. Arrays from this dataset will
This property specifies the input dataset to the Delaunay 3D filter.
be used for computing statistics and/or assessed by a statistical
 
model.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkPointSet
* vtkImageData
|-
* vtkStructuredGrid
|'''Alpha''' (Alpha)
* vtkPolyData
|
* vtkUnstructuredGrid
 
* vtkTable
This property specifies the alpha (or distance) value to control
* vtkGraph
the output of this filter. For a non-zero alpha value, only
The dataset must contain a field array ()
edges, faces, or tetra contained within the circumsphere (of
radius alpha) will be output. Otherwise, only tetrahedra will be
output.


|-
|'''ModelInput''' (ModelInput)
|
|
0.0
A previously-calculated model with which to assess a
separate dataset. This input is optional.
|
|


|
Accepts input of following types:
* vtkTable
* vtkMultiBlockDataSet
|-
|-
|'''Tolerance''' (Tolerance)
|'''AttributeMode''' (AttributeMode)
|
|
 
Specify which type of field data the arrays will be
This property specifies a tolerance to control discarding of
drawn from.
closely spaced points. This tolerance is specified as a fraction
of the diagonal length of the bounding box of the points.
 
|
|
0.001
0
|
|
 
The value must be field array name.
|-
|-
|'''Offset''' (Offset)
|'''Variables of Interest''' (SelectArrays)
|
Choose arrays whose entries will be used to form
observations for statistical analysis.
|
|


This property specifies a multiplier to control the size of the
|
initial, bounding Delaunay triangulation.


|-
|'''Task''' (Task)
|
|
2.5
Specify the task to be performed: modeling and/or
assessment. <ol> <li> "Detailed model of input data,"
creates a set of output tables containing a calculated statistical
model of the <b>entire</b> input dataset;</li>
<li> "Model a subset of the data," creates an output table (or
tables) summarizing a <b>randomly-chosen subset</b> of the
input dataset;</li> <li> "Assess the data with a model,"
adds attributes to the first input dataset using a model provided on
the second input port; and</li> <li> "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.</li> </ol> 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 <i>Training fraction</i> 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)
|-
|-
|'''BoundingTriangulation''' (BoundingTriangulation)
|'''TrainingFraction''' (TrainingFraction)
|
|
 
Specify the fraction of values from the input dataset to
This boolean controls whether bounding triangulation points (and
be used for model fitting. The exact set of values is chosen at random
associated triangles) are included in the output. (These are
from the dataset.
introduced as an initial triangulation to begin the triangulation
process. This feature is nice for debugging output.)
 
|
|
0
0.1
|
|
Accepts boolean values (0 or 1).
 


|}
|}


==Descriptive Statistics==
==Contour==
 
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 obtained) may optionally be used to assess the input dataset.<p>
This filter computes the min, max, mean, raw moments M2 through M4, standard deviation, skewness, and kurtosis for each array you select.<p>
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.


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
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.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,160: Line 2,158:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input dataset to be used by
the contour filter.
|
|
Accepts input of following types:
* vtkDataSet
The dataset must contain a field array (point)


The input to the filter. Arrays from this dataset will be used for computing statistics and/or assessed by a statistical model.
with 1 component(s).


|-
|'''Contour By''' (SelectInputScalars)
|
This property specifies the name of the scalar array
from which the contour filter will compute isolines and/or
isosurfaces.
|
|


|
|
Accepts input of following types:
An array of scalars is required.The value must be field array name.
* vtkImageData
* vtkStructuredGrid
* vtkPolyData
* vtkUnstructuredGrid
* vtkTable
* vtkGraph
The dataset much contain a field array ()
 
|-
|-
|'''ModelInput''' (ModelInput)
|'''ComputeNormals''' (ComputeNormals)
|
|
 
If this property is set to 1, a scalar array containing
A previously-calculated model with which to assess a separate dataset. This input is optional.
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 input of following types:
Accepts boolean values (0 or 1).
* vtkTable
* vtkMultiBlockDataSet
|-
|-
|'''SelectArrayInfo''' (SelectArrayInfo)
|'''ComputeGradients''' (ComputeGradients)
|
|
 
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).
|-
|-
|'''AttributeMode''' (AttributeMode)
|'''ComputeScalars''' (ComputeScalars)
|
|
 
If this property is set to 1, an array of scalars
Specify which type of field data the arrays will be drawn from.
(containing the contour value) will be added to the output dataset. If
 
set to 0, the output will not contain this array.
|
|
0
0
|
|
The value must be field array name.
Accepts boolean values (0 or 1).
|-
|-
|'''Variables of Interest''' (SelectArrays)
|'''OutputPointsPrecision''' (OutputPointsPrecision)
|
|


Choose arrays whose entries will be used to form observations for statistical analysis.
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)
|-
|-
|'''Task''' (Task)
|'''GenerateTriangles''' (GenerateTriangles)
|
|
 
This parameter controls whether to produce triangles in the output.
Specify the task to be performed: modeling and/or assessment. <ol>
Warning: Many filters do not properly handle non-trianglular polygons.
<li> "Detailed model of input data," creates a set of output tables containing a calculated statistical model of the <b>entire</b> input dataset;</li>
<li> "Model a subset of the data," creates an output table (or tables) summarizing a <b>randomly-chosen subset</b> of the input dataset;</li>
<li> "Assess the data with a model," adds attributes to the first input dataset using a model provided on the second input port; and</li>
<li> "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.</li>
</ol>
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 <i>Training fraction</i> setting will be ignored for tasks 1 and 3.


|
|
3
1
|
|
The value(s) is an enumeration of the following:
Accepts boolean values (0 or 1).
* 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)
|'''Isosurfaces''' (ContourValues)
|
This property specifies the values at which to compute
isosurfaces/isolines and also the number of such
values.
|
|


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
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.
|
|


|-
|'''Deviations should be''' (SignedDeviations)
|
|
The value can be one of the following:
* MergePoints (incremental_point_locators)


Should the assessed values be signed deviations or unsigned?
* IncrementalOctreeMergePoints (incremental_point_locators)
 
* NonMergingPointLocator (incremental_point_locators)


|
0
|
The value(s) is an enumeration of the following:
* Unsigned (0)
* Signed (1)


|}
|}


==Elevation==
==Contour Generic Dataset==
 
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 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.


Generate isolines or isosurfaces using point scalars.The Generic
Contour filter computes isolines or isosurfaces using a
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
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
values section. Select the number of contour values to
generate using the Number of Values slider. The Range
slider controls the interval in which to generate the
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,278: Line 2,321:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
Set the input to the Generic Contour
This property specifies the input dataset to the Elevation filter.
filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkGenericDataSet
The dataset must contain a field array (point)
 
with 1 component(s).
 
|-
|-
|'''ScalarRange''' (ScalarRange)
|'''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 determines the range into which scalars will be mapped.
|
|
0 1
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).
|-
|'''ComputeGradients''' (ComputeGradients)
|
Select whether to compute gradients.
|
0
|
|
 
Accepts boolean values (0 or 1).
|-
|-
|'''Low Point''' (LowPoint)
|'''ComputeScalars''' (ComputeScalars)
|
|
 
Select whether to compute scalars.
This property defines one end of the direction vector (small scalar values).
|
|
0 0 0
0
|
|
 
Accepts boolean values (0 or 1).
The value must lie within the bounding box of the dataset.
 
It will default to the min in each dimension.
 
|-
|-
|'''High Point''' (HighPoint)
|'''Isosurfaces''' (ContourValues)
|
This property specifies the values at which to compute
isosurfaces/isolines and also the number of such
values.
|
|


This property defines the other end of the direction vector (large scalar values).
|
|
0 0 1
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 value must lie within the bounding box of the dataset.
|
The value can be one of the following:
* MergePoints (incremental_point_locators)
 
* IncrementalOctreeMergePoints (incremental_point_locators)


It will default to the max in each dimension.
* NonMergingPointLocator (incremental_point_locators)




|}
|}


==Extract AMR Blocks==
==Convert AMR dataset to Multi-block==
 
This filter extracts a list of datasets from hierarchical datasets.
This filter extracts a list of datasets from hierarchical datasets.


Convert AMR to Multiblock


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,343: Line 2,408:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
This property specifies the input for this
This property specifies the input to the Extract Datasets filter.
filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkHierarchicalBoxDataSet
* vtkOverlappingAMR
|-
|'''SelectedDataSets''' (SelectedDataSets)
|
 
This property provides a list of datasets to extract.
|
 
|
 


|}
|}


==Extract Attributes==
==ConvertSelection==
 
Extract attribute data as a table.
This is a filter that produces a vtkTable from the chosen attribute in
the input dataobject. This filter can accept composite datasets. If the
input is a composite dataset, the output is a multiblock with vtkTable
leaves.


Converts a selection from one type to
another.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,381: Line 2,431:


|-
|-
|'''Input''' (Input)
|'''DataInput''' (DataInput)
|
|
This property specifies the input of the filter.
Set the vtkDataObject input used to convert the
selection.
|
|


Line 2,390: Line 2,441:
* vtkDataObject
* vtkDataObject
|-
|-
|'''FieldAssociation''' (FieldAssociation)
|'''Input''' (Input)
|
Set the selection to convert.
|
|


Select the attribute data to pass.
|
|
0
Accepts input of following types:
* vtkSelection
|-
|'''OutputType''' (OutputType)
|
Set the ContentType for the output.
|
5
|
|
The value(s) is an enumeration of the following:
The value(s) is an enumeration of the following:
* Points (0)
* SELECTIONS (0)
* Cells (1)
* GLOBALIDs (1)
* Field Data (2)
* PEDIGREEIDS (2)
* Vertices (4)
* VALUES (3)
* Edges (5)
* INDICES (4)
* Rows (6)
* FRUSTUM (5)
* LOCATION (6)
* THRESHOLDS (7)
|-
|'''ArrayNames''' (ArrayNames)
|
 
|
 
|
 
|-
|-
|'''AddMetaData''' (AddMetaData)
|'''MatchAnyValues''' (MatchAnyValues)
|
|


It is possible for this filter to add additional meta-data to the
field data such as point coordinates (when point attributes are
selected and input is pointset) or structured coordinates etc. To
enable this addition of extra information, turn this flag on. Off by
default.
|
|
0
0
Line 2,422: Line 2,484:
|}
|}


==Extract Block==
==Crop==
 
This filter extracts a range of blocks from a multiblock dataset.
This filter extracts a range of groups from a multiblock dataset


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
maximum extents of each dimension of the data. Both the
input and output of this filter are uniform rectilinear
data.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,438: Line 2,503:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
This property specifies the input to the Crop
This property specifies the input to the Extract Group filter.
filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkMultiBlockDataSet
* vtkImageData
|-
|-
|'''BlockIndices''' (BlockIndices)
|'''OutputWholeExtent''' (OutputWholeExtent)
|
This property gives the minimum and maximum point index
(extent) in each dimension for the output dataset.
|
0 0 0 0 0 0
|
|
The value(s) must lie within the structured-extents of the input dataset.
|}
==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. ; the type can be selected from the
Curvature type menu button.


This property lists the ids of the blocks to extract
{| class="PropertiesTable" border="1" cellpadding="5"
from the input multiblock dataset.
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


|-
|'''Input''' (Input)
|
This property specifies the input to the Curvature
filter.
|
|


|
|
 
Accepts input of following types:
* vtkPolyData
|-
|-
|'''PruneOutput''' (PruneOutput)
|'''InvertMeanCurvature''' (InvertMeanCurvature)
|
|
 
If this property is set to 1, the mean curvature
When set, the output mutliblock dataset will be pruned to remove empty
calculation will be inverted. This is useful for meshes with
nodes. On by default.
inward-pointing normals.
|
|
1
0
|
|
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|-
|'''MaintainStructure''' (MaintainStructure)
|'''CurvatureType''' (CurvatureType)
|
|
 
This propery specifies which type of curvature to
This is used only when PruneOutput is ON. By default, when pruning the
compute.
output i.e. remove empty blocks, if node has only 1 non-null child
block, then that node is removed. To preserve these parent nodes, set
this flag to true.
|
|
0
0
|
|
Accepts boolean values (0 or 1).
The value(s) is an enumeration of the following:
* Gaussian (0)
* Mean (1)


|}
|}


==Extract CTH Parts==
==D3==
 
Create a surface from a CTH volume fraction.
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.


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.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,500: Line 2,590:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
This property specifies the input to the D3
This property specifies the input to the Extract CTH Parts filter.
filter.
|
|


Line 2,508: Line 2,597:
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkDataSet
The dataset much contain a field array (cell)
with 1 component(s).
|-
|-
|'''Clip Type''' (ClipPlane)
|'''BoundaryMode''' (BoundaryMode)
|
|
 
This property determines how cells that lie on processor
This property specifies whether to clip the dataset, and if so, it also specifies the parameters of the plane with which to clip.
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 can be one of the following:
The value(s) is an enumeration of the following:
* None (implicit_functions)
* Assign cells uniquely (0)
 
* Duplicate cells (1)
* Plane (implicit_functions)
* Divide cells (2)
 
* Box (implicit_functions)
 
* Sphere (implicit_functions)
 
|-
|-
|'''Double Volume Arrays''' (AddDoubleVolumeArrayName)
|'''Minimal Memory''' (UseMinimalMemory)
|
|
 
If this property is set to 1, the D3 filter requires
This property specifies the name(s) of the volume fraction array(s) for generating parts.
communication routines to use minimal memory than without this
restriction.
|
|
 
0
|
An array of scalars is required.
|-
|'''Float Volume Arrays''' (AddFloatVolumeArrayName)
|
 
This property specifies the name(s) of the volume fraction array(s) for generating parts.
|
|
 
Accepts boolean values (0 or 1).
|
An array of scalars is required.
|-
|'''Unsigned Character Volume Arrays''' (AddUnsignedCharVolumeArrayName)
|
 
This property specifies the name(s) of the volume fraction array(s) for generating parts.
|
 
|
An array of scalars is required.
|-
|'''Volume Fraction Value''' (VolumeFractionSurfaceValue)
|
 
The value of this property is the volume fraction value for the surface.
 
|
0.1
|
 


|}
|}


==Extract Cells By Region==
==Decimate==
 
This filter extracts cells that are inside/outside a region or at a region boundary.
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.
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).


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"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,590: Line 2,647:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
This property specifies the input to the Decimate
This property specifies the input to the Slice filter.
filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkPolyData
|-
|-
|'''Intersect With''' (ImplicitFunction)
|'''TargetReduction''' (TargetReduction)
|
|
 
This property specifies the desired reduction in the
This property sets the region used to extract cells.
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
|
|
The value can be one of the following:
* Plane (implicit_functions)
* Box (implicit_functions)
* Sphere (implicit_functions)


|-
|-
|'''InputBounds''' (InputBounds)
|'''PreserveTopology''' (PreserveTopology)
|
|
 
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
|
|
 
Accepts boolean values (0 or 1).
|-
|-
|'''Extraction Side''' (ExtractInside)
|'''FeatureAngle''' (FeatureAngle)
|
|
 
The value of this property is used in determining where
This parameter controls whether to extract cells that are inside or outside the region.
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.
|
|
1
15.0
|
The value(s) is an enumeration of the following:
* outside (0)
* inside (1)
|-
|'''Extract only intersected''' (Extract only intersected)
|
|


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
|
Accepts boolean values (0 or 1).
|-
|-
|'''Extract intersected''' (Extract intersected)
|'''BoundaryVertexDeletion''' (BoundaryVertexDeletion)
|
|
 
If this property is set to 1, then vertices on the
This parameter controls whether to extract cells that are on the boundary of the region.
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.
|
|
0
1
|
|
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
Line 2,657: Line 2,704:
|}
|}


==Extract Edges==
==Delaunay 2D==
 
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.


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. 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,673: Line 2,765:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
This property specifies the input dataset to the
This property specifies the input to the Extract Edges filter.
Delaunay 2D filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkPointSet
 
|}
 
==Extract Generic Dataset Surface==
 
Extract geometry from a higher-order dataset
Extract geometry from a higher-order dataset.
 
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''ProjectionPlaneMode''' (ProjectionPlaneMode)
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''Input''' (Input)
|
|
 
This property determines type of projection plane to use
Set the input to the Generic Geometry Filter.
in performing the triangulation.
|
|
 
0
|
|
Accepts input of following types:
The value(s) is an enumeration of the following:
* vtkGenericDataSet
* XY Plane (0)
* Best-Fitting Plane (2)
|-
|-
|'''PassThroughCellIds''' (PassThroughCellIds)
|'''Alpha''' (Alpha)
|
|
 
The value of this property controls the output of this
Select whether to forward original ids.
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.
|
|
1
0.0
|
|
Accepts boolean values (0 or 1).
|}
==Extract Level==
This filter extracts a range of groups from a hierarchical dataset.
This filter extracts a range of levels from a hierarchical dataset


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''Tolerance''' (Tolerance)
| '''Description'''
|
| '''Default Value(s)'''
This property specifies a tolerance to control
| '''Restrictions'''
discarding of closely spaced points. This tolerance is specified as a
fraction of the diagonal length of the bounding box of the
points.
|
0.00001
|


|-
|-
|'''Input''' (Input)
|'''Offset''' (Offset)
|
This property is a multiplier to control the size of the
initial, bounding Delaunay triangulation.
|
|
 
1.0
This property specifies the input to the Extract Group filter.
|
|


|
Accepts input of following types:
* vtkHierarchicalBoxDataSet
|-
|-
|'''Levels''' (Levels)
|'''BoundingTriangulation''' (BoundingTriangulation)
|
|
 
If this property is set to 1, bounding triangulation
This property lists the levels to extract
points (and associated triangles) are included in the output. These are
from the input hierarchical dataset.
introduced as an initial triangulation to begin the triangulation
 
process. This feature is nice for debugging output.
|
|
 
0
|
|
 
Accepts boolean values (0 or 1).


|}
|}


==Extract Selection==
==Delaunay 3D==
 
Extract different type of selections.
This filter extracts a set of cells/points given a selection.
The selection can be obtained from a rubber-band selection
(either cell, visible or in a frustum) or threshold selection
and passed to the filter or specified by providing an ID list.


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
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"
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,778: Line 2,889:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
This property specifies the input dataset to the
This property specifies the input from which the selection is extracted.
Delaunay 3D filter.
 
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkPointSet
* vtkTable
|-
|-
|'''Selection''' (Selection)
|'''Alpha''' (Alpha)
|
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.0
The input that provides the selection object.
 
|
|


|-
|'''Tolerance''' (Tolerance)
|
|
Accepts input of following types:
This property specifies a tolerance to control
* vtkSelection
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
|
 
|-
|-
|'''PreserveTopology''' (PreserveTopology)
|'''Offset''' (Offset)
|
This property specifies a multiplier to control the size
of the initial, bounding Delaunay triangulation.
|
2.5
|
|


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
|'''BoundingTriangulation''' (BoundingTriangulation)
out. If 0 then the output is an unstructured grid which contains only
|
the subset of cells that are inside.
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
0
Line 2,812: Line 2,940:
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|-
|'''ShowBounds''' (ShowBounds)
|'''AlphaTets''' (AlphaTets)
|
|
 
This boolean controls whether tetrahedrons which satisfy
For frustum selection, if this property is set to 1 the output is the
the alpha criterion output when alpha is non-zero.
outline of the frustum instead of the contents of the input that lie
within the frustum.
 
|
|
0
1
|
|
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|}
==Extract Selection (internal)==
This filter extracts a given set of cells or points given a selection.
The selection can be obtained from a rubber-band selection
(either point, cell, visible or in a frustum) and passed to the filter
or specified by providing an ID list.
This is an internal filter, use "ExtractSelection" instead.
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''AlphaTris''' (AlphaTris)
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''Input''' (Input)
|
|
 
This boolean controls whether triangles which satisfy
The input from which the selection is extracted.
the alpha criterion output when alpha is non-zero.
 
|
|
 
1
|
|
Accepts input of following types:
Accepts boolean values (0 or 1).
* vtkDataSet
|-
|-
|'''Selection''' (Selection)
|'''AlphaLines''' (AlphaLines)
|
|
 
This boolean controls whether lines which satisfy the
The input that provides the selection object.
alpha criterion output when alpha is non-zero.
 
|
|
 
0
|
|
Accepts input of following types:
Accepts boolean values (0 or 1).
* vtkSelection
|-
|-
|'''PreserveTopology''' (PreserveTopology)
|'''AlphaVerts''' (AlphaVerts)
|
|
 
This boolean controls whether vertices which satisfy the
If this property is set to 1 the output preserves the topology of its
alpha criterion are output when alpha is non-zero.
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
0
Line 2,881: Line 2,978:
|}
|}


==Extract Subset==
==Descriptive Statistics==
 
Extract a subgrid from a structured grid with the option of setting subsample strides.
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.


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
obtained) may optionally be used to assess the input dataset.<p>
This filter computes the min, max, mean, raw moments M2 through M4,
standard deviation, skewness, and kurtosis for each array you
select.<p> 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,897: Line 3,003:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
The input to the filter. Arrays from this dataset will
This property specifies the input to the Extract Grid filter.
be used for computing statistics and/or assessed by a statistical
model.
|
|


Line 2,905: Line 3,011:
Accepts input of following types:
Accepts input of following types:
* vtkImageData
* vtkImageData
* vtkRectilinearGrid
* vtkStructuredGrid
* vtkStructuredPoints
* vtkPolyData
* vtkStructuredGrid
* vtkUnstructuredGrid
* vtkTable
* vtkGraph
The dataset must contain a field array ()
 
|-
|-
|'''VOI''' (VOI)
|'''ModelInput''' (ModelInput)
|
A previously-calculated model with which to assess a
separate dataset. This input is optional.
|
|


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.
|
|
0 0 0 0 0 0
Accepts input of following types:
* vtkTable
* vtkMultiBlockDataSet
|-
|'''AttributeMode''' (AttributeMode)
|
Specify which type of field data the arrays will be
drawn from.
|
0
|
|
The value(s) must lie within the structured-extents of the input dataset.
The value must be field array name.
|-
|-
|'''SampleRateI''' (SampleRateI)
|'''Variables of Interest''' (SelectArrays)
|
Choose arrays whose entries will be used to form
observations for statistical analysis.
|
|
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
|
|


|-
|-
|'''SampleRateJ''' (SampleRateJ)
|'''Task''' (Task)
|
|
 
Specify the task to be performed: modeling and/or
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.
assessment. <ol> <li> "Detailed model of input data,"
 
creates a set of output tables containing a calculated statistical
model of the <b>entire</b> input dataset;</li>
<li> "Model a subset of the data," creates an output table (or
tables) summarizing a <b>randomly-chosen subset</b> of the
input dataset;</li> <li> "Assess the data with a model,"
adds attributes to the first input dataset using a model provided on
the second input port; and</li> <li> "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.</li> </ol> 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 <i>Training fraction</i> setting will be
ignored for tasks 1 and 3.
|
|
1
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)
|-
|-
|'''SampleRateK''' (SampleRateK)
|'''TrainingFraction''' (TrainingFraction)
|
|
 
Specify the fraction of values from the input dataset to
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.
be used for model fitting. The exact set of values is chosen at random
 
from the dataset.
|
|
1
0.1
|
|


|-
|-
|'''IncludeBoundary''' (IncludeBoundary)
|'''Deviations should be''' (SignedDeviations)
|
|
 
Should the assessed values be signed deviations or
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.
unsigned?
 
|
|
0
0
|
|
Accepts boolean values (0 or 1).
The value(s) is an enumeration of the following:
* Unsigned (0)
* Signed (1)


|}
|}


==Extract Surface==
==Elevation==
 
Extract a 2D boundary surface using neighbor relations to eliminate internal faces.
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.


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
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.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,977: Line 3,126:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
 
This property specifies the input dataset to the
This property specifies the input to the Extract Surface filter.
Elevation filter.
|
|


Line 2,986: Line 3,134:
* vtkDataSet
* vtkDataSet
|-
|-
|'''PieceInvariant''' (PieceInvariant)
|'''ScalarRange''' (ScalarRange)
|
This property determines the range into which scalars
will be mapped.
|
0 1
|
|


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.
|-
 
|'''Low Point''' (LowPoint)
|
|
1
This property defines one end of the direction vector
(small scalar values).
|
|
Accepts boolean values (0 or 1).
0 0 0
|-
|'''NonlinearSubdivisionLevel''' (NonlinearSubdivisionLevel)
|
|


If the input is an unstructured grid with nonlinear faces, this
The value must lie within the bounding box of the dataset.
parameter determines how many times the face is subdivided into
 
linear faces. If 0, the output is the equivalent of its linear
It will default to the min in each dimension.
couterpart (and the midpoints determining the nonlinear
interpolation are discarded). If 1, the nonlinear face is
triangulated based on the midpoints. If greater than 1, the
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.


|-
|'''High Point''' (HighPoint)
|
This property defines the other end of the direction
vector (large scalar values).
|
|
1
0 0 1
|
|
The value must lie within the bounding box of the dataset.
It will default to the max in each dimension.




|}
|}


==FOF/SOD Halo Finder==
==Environment Annotation==


Allows annotation of user name, date/time, OS, and possibly filename.
Apply to any source. Gui allows manual selection of desired annotation options.
If the source is a file, can display the filename.




Line 3,032: Line 3,188:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input of the filter.
Set the input of the filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkUnstructuredGrid
* vtkDataObject
|-
|-
|'''rL (physical box side length)''' (RL)
|'''DisplayUserName''' (DisplayUserName)
|
|


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 they are wrapped around).
Toggle User Name Visibility.


|
|
100
0
|
|
 
Accepts boolean values (0 or 1).
|-
|-
|'''overlap (shared point/ghost cell gap distance)''' (Overlap)
|'''DisplaySystemName''' (DisplaySystemName)
|
|


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.
Toggle System Name Visibility.


|
|
5
0
|
|
 
Accepts boolean values (0 or 1).
|-
|-
|'''np (number of seeded particles in one dimension, i.e., total particles = np^3)''' (NP)
|'''DisplayDate''' (DisplayDate)
|
|


Number of seeded particles in one dimension. Therefore, total simulation particles is np^3 (cubed).
Toggle Date/Time Visibility.


|
|
256
0
|
|
 
Accepts boolean values (0 or 1).
|-
|-
|'''bb (linking length)''' (BB)
|'''DisplayFileName''' (DisplayFileName)
|
|


Linking length measured in units of interparticle spacing and is dimensionless. Used to link particles into halos for the friends-of-friends (FOF) algorithm.
Toggle File Name Visibility.


|
|
0.20
0
|
|
 
Accepts boolean values (0 or 1).
|-
|-
|'''pmin (minimum particle threshold for an FOF halo)''' (PMin)
|'''FileName''' (FileName)
|
Annotation of file name.
|
|


Minimum number of particles (threshold) needed before a group is called a friends-of-friends (FOF) halo.
|
100
|
|


|-
|'''Copy FOF halo catalog to original particles''' (CopyHaloDataToParticles)
|


If checked, the friends-of-friends (FOF) halo catalog information will be copied to the original particles as well.
|}


|
==Extract AMR Blocks==
0
|
Accepts boolean values (0 or 1).
|-
|'''Compute the most bound particle''' (ComputeMostBoundParticle)
|


If checked, the most bound particle for an FOF halo will be calculated. WARNING: This can be very slow.
This filter extracts a list of datasets from hierarchical datasets.This filter extracts a list
of datasets from hierarchical datasets.


|
{| class="PropertiesTable" border="1" cellpadding="5"
0
|
Accepts boolean values (0 or 1).
|-
|-
|'''Compute the most connected particle''' (ComputeMostConnectedParticle)
| '''Property'''
|
| '''Description'''
 
| '''Default Value(s)'''
If checked, the most connected particle for an FOF halo will be calculated. WARNING: This can be very slow.
| '''Restrictions'''


|
0
|
Accepts boolean values (0 or 1).
|-
|-
|'''Compute spherical overdensity (SOD) halos''' (ComputeSOD)
|'''Input''' (Input)
|
 
If checked, spherical overdensity (SOD) halos will be calculated in addition to friends-of-friends (FOF) halos.
 
|
0
|
|
Accepts boolean values (0 or 1).
This property specifies the input to the Extract
|-
Datasets filter.
|'''initial SOD center''' (SODCenterType)
|
|
The initial friends-of-friends (FOF) center used for calculating a spherical overdensity (SOD) halo. WARNING: Using MBP or MCP can be very slow.


|
|
0
Accepts input of following types:
|
* vtkUniformGridAMR
The value(s) is an enumeration of the following:
* Center of mass (0)
* Average position (1)
* Most bound particle (2)
* Most connected particle (3)
|-
|-
|'''rho_c''' (RhoC)
|'''SelectedDataSets''' (SelectedDataSets)
|
|
 
This property provides a list of datasets to
rho_c (critical density) for SOD halo finding.
extract.
 
|
2.77536627e11
|
|


|-
|'''initial SOD mass''' (SODMass)
|
|


The initial SOD mass.


|
|}
1.0e14
|


|-
==Extract Attributes==
|'''minimum radius factor''' (MinRadiusFactor)
|


Minimum radius factor for SOD finding.
Extract attribute data as a table.This is a
filter that produces a vtkTable from the chosen attribute
in the input dataobject. This filter can accept composite
datasets. If the input is a composite dataset, the output
is a multiblock with vtkTable leaves.


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


|-
|-
|'''maximum radius factor''' (MaxRadiusFactor)
|'''Input''' (Input)
|
This property specifies the input of the
filter.
|
|
Maximum radius factor for SOD finding.