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

From KitwarePublic
Jump to navigationJump to search
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
==AMR Connectivity==
Fragment Identification
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
|'''Input''' (Input)
|
This property specifies the volume input of the
filter.
|
|
Accepts input of following types:
* vtkNonOverlappingAMR
The dataset must contain a field array (cell)
with 1 component(s).
|-
|'''SelectMaterialArrays''' (SelectMaterialArrays)
|
This property specifies the cell arrays from which the
analysis will determine fragments
|
|
An array of scalars is required.
|-
|'''Volume Fraction Value''' (VolumeFractionSurfaceValue)
|
This property specifies the values at which to compute
the isosurface.
|
0.1
|
|-
|'''Resolve Blocks''' (Resolve Blocks)
|
Resolve the fragments between blocks.
|
1
|
Accepts boolean values (0 or 1).
|-
|'''Propagate Ghosts''' (Propagate Ghosts)
|
Propagate regionIds into the ghosts.
|
0
|
Accepts boolean values (0 or 1).
|}


==AMR Contour==
==AMR Contour==
Line 21: 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 180: Line 242:
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 232: Line 294:
|}
|}


==All to N==
==AMR Fragment Integration==


Redistribute data to a subset of available processes.The All to N filter
Fragment Integration
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"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 252: Line 308:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
Set the input to the All to N filter.
This property specifies the volume input of the
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).
 
|-
|-
|'''Number of Processes''' (NumberOfProcesses)
|'''SelectMaterialArrays''' (SelectMaterialArrays)
|
|
Set the number of processes across which to split the
This property specifies the cell arrays from which the
input data.
analysis will determine fragments
|
|
1
 
|
|
 
An array of scalars is required.
 
|}
 
==Annotate Global Data==
 
 
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''SelectMassArrays''' (SelectMassArrays)
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''Input''' (Input)
|
|
Set the input of the filter.
This property specifies the cell arrays from which the
analysis will determine fragment mass
|
|


|
|
Accepts input of following types:
An array of scalars is required.
* vtkDataSet
The dataset much contain a field array (none)
 
with 1 component(s).
 
|-
|-
|'''SelectArrays''' (SelectArrays)
|'''SelectVolumeWeightedArrays''' (SelectVolumeWeightedArrays)
|
|
Choose arrays that is going to be
This property specifies the cell arrays from which the
displayed
analysis will determine volume weighted average values
|
|


|
|
 
An array of scalars is required.
|-
|-
|'''Prefix''' (Prefix)
|'''SelectMassWeightedArrays''' (SelectMassWeightedArrays)
|
|
Text that is used as a prefix to the field
This property specifies the cell arrays from which the
value
analysis will determine mass weighted average values
|
|
Value is:
 
|
|
 
An array of scalars is required.


|}
|}


==Annotate Time Filter==
==AMR Fragments Filter==


Shows input data time as text annnotation in the view.The Annotate Time
Meta Fragment filterCombines the running of
filter can be used to show the data time in a text
AMRContour, AMRFragmentIntegration, AMRDualContour and ExtractCTHParts
annotation.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 331: Line 373:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input dataset for which to
This property specifies the volume input of the
display the time.
filter.
|
|


|
|
Accepts input of following types:
* vtkNonOverlappingAMR
The dataset must contain a field array (cell)
with 1 component(s).


|-
|-
|'''Format''' (Format)
|'''SelectMaterialArrays''' (SelectMaterialArrays)
|
|
The value of this property is a format string used to
This property specifies the cell arrays from which the
display the input time. The format string is specified using printf
analysis will determine fragments
style.
|
|
Time: %f
 
|
|
 
An array of scalars is required.
|-
|-
|'''Shift''' (Shift)
|'''SelectMassArrays''' (SelectMassArrays)
|
|
The amount of time the input is shifted (after
This property specifies the cell arrays from which the
scaling).
analysis will determine fragment mass
|
|
0.0
 
|
|
 
An array of scalars is required.
|-
|-
|'''Scale''' (Scale)
|'''SelectVolumeWeightedArrays''' (SelectVolumeWeightedArrays)
|
This property specifies the cell arrays from which the
analysis will determine volume weighted average values
|
 
|
An array of scalars is required.
|-
|'''SelectMassWeightedArrays''' (SelectMassWeightedArrays)
|
This property specifies the cell arrays from which the
analysis will determine mass weighted average values
|
 
|
An array of scalars is required.
|-
|'''Volume Fraction Value''' (VolumeFractionSurfaceValue)
|
|
The factor by which the input time is
This property specifies the values at which to compute
scaled.
the isosurface.
|
|
1.0
0.1
|
|


|-
|'''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
|
1
|
Accepts boolean values (0 or 1).


|}
|}


==Append Attributes==
==Add Field Arrays==
 
Reads arrays from a file and adds them to the input data object.
Takes in an input data object and a filename. Opens the file
and adds any arrays it sees there to the input data.


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 392: Line 473:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input to the Append
The input.
Attributes filter.
|
 
|
|


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


|}
This property specifies the file to read to get arrays


==Append Datasets==
|


Takes an input of multiple datasets and output has only one unstructured grid.The Append
|
Datasets filter operates on multiple data sets of any type
The value(s) must be a filename (or filenames).
(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
==Angular Periodic Filter==
collected together, either as a result of a reader that
 
loads multiple parts (e.g., EnSight reader) or because the
This filter generate a periodic multiblock dataset.This filter generate a periodic
Group Parts filter has been run to form a collection of
multiblock dataset
data sets.


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


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


|}
|


==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"
|-
|-
| '''Property'''
|'''IterationMode''' (IterationMode)
| '''Description'''
|
| '''Default Value(s)'''
This property specifies the mode of iteration, either a user-provided number
| '''Restrictions'''
of periods, or the maximum number of periods to rotate to 360°.
|
1
|
The value(s) is an enumeration of the following:
* Manual (0)
* Maximum (1)
|-
|'''NumberOfPeriods''' (NumberOfPeriods)
|
This property specifies the number of iteration
|
3
|


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


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


|}
|-
|'''RotationArrayName''' (RotationArrayName)
|
Field array name that contains the rotation angle in radian.


==Balance==
|
 
periodic angle
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.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''Axis''' (Axis)
| '''Description'''
|
| '''Default Value(s)'''
This property specifies the axis of rotation
| '''Restrictions'''
|
 
0
|
The value(s) is an enumeration of the following:
* Axis X (0)
* Axis Y (1)
* Axis Z (2)
|-
|-
|'''Input''' (Input)
|'''Center''' (Center)
|
This property specifies the 3D coordinates for the
center of the rotation.
|
|
Set the input to the Balance filter.
0.0 0.0 0.0
|
|


|
Accepts input of following types:
* vtkPolyData


|}
|}


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


The 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"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 506: Line 617:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input to the Level Scalars
 
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.
 
|
|


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


|}
with 1 component(s).


==CTH Surface==
|-
|'''ArrayAssociation''' (ArrayAssociation)
|
Select the attribute to use to popular array names from.
|
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
|


Not finished yet.
|


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''ElementId''' (ElementId)
| '''Description'''
|
| '''Default Value(s)'''
 
| '''Restrictions'''
Set the element index to annotate with.


|-
|'''Input''' (Input)
|
|
This property specifies the input of the
0
filter.
|
|


|-
|'''ProcessId''' (ProcessId)
|
|
Accepts input of following types:
* vtkCompositeDataSet


|}
Set the process rank to extract element from.


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


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"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 559: Line 707:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
Set the input to the Update Suppressor
Set the input of the filter.
filter.
|
|


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


|-
|-
|'''CacheTime''' (CacheTime)
|'''SelectArrays''' (SelectArrays)
|
Choose arrays that is going to be
displayed
|
 
|
|


|-
|'''Prefix''' (Prefix)
|
|
0.0
Text that is used as a prefix to the field
value
|
Value is:
|
|


|-
|-
|'''CachingEnabled''' (CachingEnabled)
|'''Suffix''' (Suffix)
|
|
Toggle whether the caching is enabled.
Text that is used as a suffix to the field
value
|
|
1
 
|
|
Accepts boolean values (0 or 1).
 


|}
|}


==Calculator==
==Annotate Time Filter==


Compute new attribute arrays as function of existing arrays.The Calculator
Shows input data time as text annnotation in the view.The Annotate Time
filter computes a new data array or new point coordinates
filter can be used to show the data time in a text
as a function of existing scalar or vector arrays. If
annotation.
point-centered arrays are used in the computation of a new
data array, the resulting array will also be
point-centered. Similarly, computations using
cell-centered arrays will produce a new cell-centered
array. If the function is computing point coordinates, the
result of the function must be a three-component vector.
The Calculator interface operates similarly to a
scientific calculator. In creating the function to
evaluate, the standard order of operations applies. Each
of the calculator functions is described below. Unless
otherwise noted, enclose the operand in parentheses using
the ( and ) buttons. 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.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 660: Line 763:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input dataset to the
This property specifies the input dataset for which to
Calculator filter. The scalar and vector variables may be chosen from
display the time.
this dataset's arrays.
|
|


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


|-
|-
|'''AttributeMode''' (AttributeMode)
|'''Format''' (Format)
|
|
This property determines whether the computation is to
The value of this property is a format string used to
be performed on point-centered or cell-centered data.
display the input time. The format string is specified using printf
style.
|
|
1
Time: %f
|
The value(s) is an enumeration of the following:
* Point Data (1)
* Cell Data (2)
|-
|'''CoordinateResults''' (CoordinateResults)
|
The value of this property determines whether the
results of this computation should be used as point coordinates or as a
new array.
|
0
|
Accepts boolean values (0 or 1).
|-
|'''ResultArrayName''' (ResultArrayName)
|
This property contains the name for the output array
containing the result of this computation.
|
Result
|
|


|-
|-
|'''Function''' (Function)
|'''Shift''' (Shift)
|
|
This property contains the equation for computing the
The amount of time the input is shifted (after
new array.
scaling).
|
|
 
0.0
|
|


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


Line 731: Line 800:
|}
|}


==Cell Centers==
==Append Attributes==


Create a point (no geometry) at the center of each input cell.The Cell Centers
Copies geometry from first input. Puts all of the arrays into the output.
filter places a point at the center of each cell in the
The Append Attributes filter takes multiple input data
input data set. The center computed is the parametric
sets with the same geometry and merges their point and
center of the cell, not necessarily the geometric or
cell attributes to produce a single output containing all
bounding box center. The cell attributes of the input will
the point and cell attributes of the inputs. Any inputs
be associated with these newly created points of the
without the same number of points and cells as the first
output. You have the option of creating a vertex cell per
input are ignored. The input data sets must already be
point in the outpuut. This is useful because vertex cells
collected together, either as a result of a reader that
are rendered, but points are not. The points themselves
loads multiple parts (e.g., EnSight reader) or because the
could be used for placing glyphs (using the Glyph filter).
Group Parts filter has been run to form a collection of
The Cell Centers filter takes any type of data set as
data sets.
input and produces a polygonal data set as
output.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 757: Line 824:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input to the Cell Centers
This property specifies the input to the Append
filter.
Attributes filter.
|
|


Line 764: Line 831:
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkDataSet
|-
|'''VertexCells''' (VertexCells)
|
If set to 1, a vertex cell will be generated per point
in the output. Otherwise only points will be generated.
|
0
|
Accepts boolean values (0 or 1).


|}
|}


==Cell Data to Point Data==
==Append Datasets==


Create point attributes by averaging cell attributes.The Cell
Takes an input of multiple datasets and output has only one unstructured grid.The Append
Data to Point Data filter averages the values of the cell
Datasets filter operates on multiple data sets of any type
attributes of the cells surrounding a point to compute
(polygonal, structured, etc.). It merges their geometry
point attributes. The Cell Data to Point Data filter
into a single data set. Only the point and cell attributes
operates on any type of data set, and the output data set
that all of the input data sets have in common will appear
is of the same type as the input.
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 795: Line 857:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input to the Cell Data to
This property specifies the datasets to be merged into a
Point Data filter.
single dataset by the Append Datasets filter.
|
|


Line 802: Line 864:
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkDataSet
The dataset much contain a field array (cell)


|}
==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"
|-
|-
|'''PassCellData''' (PassCellData)
| '''Property'''
|
| '''Description'''
If this property is set to 1, then the input cell data
| '''Default Value(s)'''
is passed through to the output; otherwise, only the generated point
| '''Restrictions'''
data will be available in the output.
 
|
0
|
Accepts boolean values (0 or 1).
|-
|-
|'''PieceInvariant''' (PieceInvariant)
|'''Input''' (Input)
|
|
If the value of this property is set to 1, this filter
Set the input to the Append Geometry
will request ghost levels so that the values at boundary points match
filter.
across processes. NOTE: Enabling this option might cause multiple
executions of the data source because more information is needed to
remove internal surfaces.
|
|
0
 
|
|
Accepts boolean values (0 or 1).
Accepts input of following types:
* vtkPolyData


|}
|}


==Clean==
==Block Scalars==


Merge coincident points if they do not meet a feature edge criteria.The Clean filter
The Level Scalars filter uses colors to show levels of a multiblock dataset.The Level
takes polygonal data as input and generates polygonal data
Scalars filter uses colors to show levels of a multiblock
as output. This filter can merge duplicate points, remove
dataset.
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 848: Line 911:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
Set the input to the Clean filter.
This property specifies the input to the Level Scalars
filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkPolyData
* vtkMultiBlockDataSet
 
|}
 
==CTH Surface==
 
Not finished yet.
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|-
|'''PieceInvariant''' (PieceInvariant)
|'''Input''' (Input)
|
|
If this property is set to 1, the whole data set will be
This property specifies the input of the
processed at once so that cleaning the data set always produces the
filter.
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
 
|
|
Accepts boolean values (0 or 1).
Accepts input of following types:
* vtkCompositeDataSet
 
|}
 
==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"
|-
|-
|'''Tolerance''' (Tolerance)
| '''Property'''
|
| '''Description'''
If merging nearby points (see PointMerging property) and
| '''Default Value(s)'''
not using absolute tolerance (see ToleranceIsAbsolute property), this
| '''Restrictions'''
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)
|'''Input''' (Input)
|
|
If merging nearby points (see PointMerging property) and
Set the input to the Update Suppressor
using absolute tolerance (see ToleranceIsAbsolute property), this
filter.
property specifies the tolerance for performing merging in the spatial
units of the input data set.
|
|
1.0
 
|
|


|-
|-
|'''ToleranceIsAbsolute''' (ToleranceIsAbsolute)
|'''CacheTime''' (CacheTime)
|
|
This property determines whether to use absolute or
 
relative (a percentage of the bounding box) tolerance when performing
point merging.
|
|
0
0.0
|
|
Accepts boolean values (0 or 1).
 
|-
|-
|'''ConvertLinesToPoints''' (ConvertLinesToPoints)
|'''CachingEnabled''' (CachingEnabled)
|
|
If this property is set to 1, degenerate lines (a "line"
Toggle whether the caching is enabled.
whose endpoints are at the same spatial location) will be converted to
points.
|
1
|
Accepts boolean values (0 or 1).
|-
|'''ConvertPolysToLines''' (ConvertPolysToLines)
|
If this property is set to 1, degenerate polygons (a
"polygon" with only two distinct point coordinates) will be converted
to lines.
|
1
|
Accepts boolean values (0 or 1).
|-
|'''ConvertStripsToPolys''' (ConvertStripsToPolys)
|
If this property is set to 1, degenerate triangle strips
(a triangle "strip" containing only one triangle) will be converted to
triangles.
|
1
|
Accepts boolean values (0 or 1).
|-
|'''PointMerging''' (PointMerging)
|
If this property is set to 1, then points will be merged
if they are within the specified Tolerance or AbsoluteTolerance (see
the Tolerance and AbsoluteTolerance propertys), depending on the value
of the ToleranceIsAbsolute property. (See the ToleranceIsAbsolute
property.) If this property is set to 0, points will not be
merged.
|
|
1
1
Line 946: Line 987:
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).


|}
|}
 
==Calculator==
 
Compute new attribute arrays as function of existing arrays.
The Calculator filter computes a new data array or new point
coordinates as a function of existing scalar or vector arrays. If
point-centered arrays are used in the computation of a new data array,
the resulting array will also be point-centered. Similarly,
computations using cell-centered arrays will produce a new
cell-centered array. If the function is computing point coordinates,
the result of the function must be a three-component vector.
 
The Calculator interface operates similarly to a scientific
calculator. In creating the function to evaluate, the standard order
of operations applies. Each of the calculator functions is described
below. Unless otherwise noted, enclose the operand in parentheses
using the ( and ) buttons.


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


This filter merges cells and converts the data set to unstructured grid.Merges degenerate cells. Assumes
The operands are described below. The digits 0 - 9 and the decimal
the input grid does not contain duplicate points. You may
point are used to enter constant scalar values. **iHat**, **jHat**,
want to run vtkCleanUnstructuredGrid first to assert it.
and **kHat** are vector constants representing unit vectors in the X,
If duplicated cells are found they are removed in the
Y, and Z directions, respectively. The scalars menu lists the names of
output. The filter also handles the case, where a cell may
the scalar arrays and the components of the vector arrays of either
contain degenerate nodes (i.e. one and the same node is
the point-centered or cell-centered data. The vectors menu lists the
referenced by a cell more than once).
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 968: Line 1,066:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input to the Clean Cells to
This property specifies the input dataset to the
Grid filter.
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:
* vtkUnstructuredGrid
* vtkDataSet
 
The dataset must contain a field array ()
|}
 
==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"
|-
|-
| '''Property'''
|'''AttributeMode''' (AttributeMode)
| '''Description'''
|
| '''Default Value(s)'''
This property determines whether the computation is to
| '''Restrictions'''
be performed on point-centered or cell-centered data.
 
|
1
|
The value(s) is an enumeration of the following:
* Point Data (1)
* Cell Data (2)
|-
|-
|'''Input''' (Input)
|'''CoordinateResults''' (CoordinateResults)
|
|
This property specifies the input to the Clean to Grid
The value of this property determines whether the
filter.
results of this computation should be used as point coordinates or as a
new array.
|
|
 
0
|
|
Accepts input of following types:
Accepts boolean values (0 or 1).
* vtkDataSet
 
|}
 
==ClientServerMoveData==
 
 
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|-
|'''Input''' (Input)
|'''ResultNormals''' (ResultNormals)
|
|
Set the input to the Client Server Move Data
Set whether to output results as point/cell
filter.
normals. Outputing as normals is only valid with vector
results. Point or cell normals are selected using
AttributeMode.
|
|
 
0
|
|
 
Accepts boolean values (0 or 1).
|-
|-
|'''OutputDataType''' (OutputDataType)
|'''ResultTCoords''' (ResultTCoords)
|
|
 
Set whether to output results as point/cell
texture coordinates. Point or cell texture coordinates are
selected using AttributeMode. 2-component texture coordinates
cannot be generated at this time.
|
|
0
0
|
|
 
Accepts boolean values (0 or 1).
|-
|-
|'''WholeExtent''' (WholeExtent)
|'''ResultArrayName''' (ResultArrayName)
|
|
 
This property contains the name for the output array
containing the result of this computation.
|
|
0 -1 0 -1 0 -1
Result
|
|


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


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


==Clip==
|


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"
|-
|'''Replace Invalid Results''' (ReplaceInvalidValues)
|
This property determines whether invalid values in the
computation will be replaced with a specific value. (See the
ReplacementValue property.)
|
1
|
Accepts boolean values (0 or 1).
|-
|'''ReplacementValue''' (ReplacementValue)
|
If invalid values in the computation are to be replaced
with another value, this property contains that value.
|
0.0
|
 
 
|}
 
==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'''
| '''Property'''
Line 1,066: Line 1,187:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the dataset on which the Clip
This property specifies the input to the Cell Centers
filter will operate.
filter.
|
|


Line 1,073: Line 1,194:
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkDataSet
The dataset much contain a field array ()
with 1 component(s).
|-
|-
|'''Clip Type''' (ClipFunction)
|'''VertexCells''' (VertexCells)
|
|
This property specifies the parameters of the clip
If set to 1, a vertex cell will be generated per point
function (an implicit plane) used to clip the dataset.
in the output. Otherwise only points will be generated.
|
|
 
0
|
|
The value can be one of the following:
Accepts boolean values (0 or 1).
* Plane (implicit_functions)


* Box (implicit_functions)
|}


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


* Scalar (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
|'''InputBounds''' (InputBounds)
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.


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


|-
|-
|'''Scalars''' (SelectInputScalars)
|'''Input''' (Input)
|
|
If clipping with scalars, this property specifies the
This property specifies the input to the Cell Data to
name of the scalar array on which to perform the clip
Point Data filter.
operation.
|
|


|
|
An array of scalars is required.The value must be field array name.
Accepts input of following types:
* vtkDataSet
The dataset must contain a field array (cell)
 
|-
|-
|'''Value''' (Value)
|'''PassCellData''' (PassCellData)
|
|
If clipping with scalars, this property sets the scalar
If this property is set to 1, then the input cell data
value about which to clip the dataset based on the scalar array chosen.
is passed through to the output; otherwise, only the generated point
(See SelectInputScalars.) If clipping with a clip function, this
data will be available in the output.
property specifies an offset from the clip function to use in the
clipping operation. Neither functionality is currently available in
ParaView's user interface.
|
0.0
|
The value must lie within the range of the selected data array.
|-
|'''InsideOut''' (InsideOut)
|
If this property is set to 0, the clip filter will
return that portion of the dataset that lies within the clip function.
If set to 1, the portions of the dataset that lie outside the clip
function will be returned instead.
|
|
0
0
Line 1,137: Line 1,245:
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|-
|'''UseValueAsOffset''' (UseValueAsOffset)
|'''PieceInvariant''' (PieceInvariant)
|
|
If UseValueAsOffset is true, Value is used as an offset
If the value of this property is set to 1, this filter
parameter to the implicit function. Otherwise, Value is used only when
will request ghost levels so that the values at boundary points match
clipping using a scalar array.
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).
|-
 
|'''Crinkle clip''' (PreserveInputCells)
|}
|
 
This parameter controls whether to extract entire cells
==Clean==
in the given region or clip those cells so all of the output one stay
 
only inside that region.
Merge coincident points if they do not meet a feature edge criteria.The Clean filter
|
takes polygonal data as input and generates polygonal data
0
as output. This filter can merge duplicate points, remove
|
unused points, and transform degenerate cells into their
Accepts boolean values (0 or 1).
appropriate forms (e.g., a triangle is converted into a
 
line if two of its points are merged).
|}
 
==Clip Closed Surface==
 
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,175: Line 1,278:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the dataset on which the Clip
Set the input to the Clean filter.
filter will operate.
|
|


Line 1,182: Line 1,284:
Accepts input of following types:
Accepts input of following types:
* vtkPolyData
* vtkPolyData
The dataset much contain a field array (point)
with 1 component(s).
|-
|-
|'''Clipping Plane''' (ClippingPlane)
|'''PieceInvariant''' (PieceInvariant)
|
|
This property specifies the parameters of the clipping
If this property is set to 1, the whole data set will be
plane used to clip the polygonal data.
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
The value can be one of the following:
they would be if the Piece invariant option was on. Setting this option
* Plane (implicit_functions)
to 0 may produce seams in the output dataset when ParaView is run in
 
parallel.
|-
|'''GenerateFaces''' (GenerateFaces)
|
Generate polygonal faces in the output.
|
|
1
1
Line 1,206: Line 1,300:
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|-
|'''GenerateOutline''' (GenerateOutline)
|'''Tolerance''' (Tolerance)
|
|
Generate clipping outlines in the output wherever an
If merging nearby points (see PointMerging property) and
input face is cut by the clipping plane.
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.0
|
|
Accepts boolean values (0 or 1).
 
|-
|-
|'''Generate Cell Origins''' (GenerateColorScalars)
|'''AbsoluteTolerance''' (AbsoluteTolerance)
|
|
Generate (cell) data for coloring purposes such that the
If merging nearby points (see PointMerging property) and
newly generated cells (including capping faces and clipping outlines)
using absolute tolerance (see ToleranceIsAbsolute property), this
can be distinguished from the input cells.
property specifies the tolerance for performing merging in the spatial
units of the input data set.
|
1.0
|
 
|-
|'''ToleranceIsAbsolute''' (ToleranceIsAbsolute)
|
This property determines whether to use absolute or
relative (a percentage of the bounding box) tolerance when performing
point merging.
|
|
0
0
Line 1,225: Line 1,333:
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|-
|'''InsideOut''' (InsideOut)
|'''ConvertLinesToPoints''' (ConvertLinesToPoints)
|
|
If this flag is turned off, the clipper will return the
If this property is set to 1, degenerate lines (a "line"
portion of the data that lies within the clipping plane. Otherwise, the
whose endpoints are at the same spatial location) will be converted to
clipper will return the portion of the data that lies outside the
points.
clipping plane.
|
|
0
1
|
|
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|-
|'''Clipping Tolerance''' (Tolerance)
|'''ConvertPolysToLines''' (ConvertPolysToLines)
|
|
Specify the tolerance for creating new points. A small
If this property is set to 1, degenerate polygons (a
value might incur degenerate triangles.
"polygon" with only two distinct point coordinates) will be converted
to lines.
|
|
0.000001
1
|
|
 
Accepts boolean values (0 or 1).
|-
|-
|'''Base Color''' (BaseColor)
|'''ConvertStripsToPolys''' (ConvertStripsToPolys)
|
|
Specify the color for the faces from the
If this property is set to 1, degenerate triangle strips
input.
(a triangle "strip" containing only one triangle) will be converted to
triangles.
|
|
0.10 0.10 1.00
1
|
|
 
Accepts boolean values (0 or 1).
|-
|-
|'''Clip Color''' (ClipColor)
|'''PointMerging''' (PointMerging)
|
|
Specifiy the color for the capping faces (generated on
If this property is set to 1, then points will be merged
the clipping interface).
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.00 0.11 0.10
1
|
|
 
Accepts boolean values (0 or 1).


|}
|}


==Clip Generic Dataset==
==Clean Cells to Grid==


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.
This filter merges cells and converts the data set to unstructured grid.Merges degenerate cells. Assumes
The Generic Clip filter cuts away a portion of the input
the input grid does not contain duplicate points. You may
data set using a plane, a sphere, a box, or a scalar
want to run vtkCleanUnstructuredGrid first to assert it.
value. The menu in the Clip Function portion of the
If duplicated cells are found they are removed in the
interface allows the user to select which implicit
output. The filter also handles the case, where a cell may
function to use or whether to clip using a scalar value.
contain degenerate nodes (i.e. one and the same node is
Making this selection loads the appropriate user
referenced by a cell more than once).
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,300: Line 1,398:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
Set the input to the Generic Clip
This property specifies the input to the Clean Cells to
filter.
Grid filter.
|
|


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


|-
|}
|'''Clip Type''' (ClipFunction)
|
Set the parameters of the clip function.
|


|
==Clean to Grid==
The value can be one of the following:
* Plane (implicit_functions)


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


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


|-
|-
|'''InputBounds''' (InputBounds)
|'''Input''' (Input)
|
|
 
This property specifies the input to the Clean to Grid
filter.
|
|


|
|
Accepts input of following types:
* vtkDataSet


|}
==ClientServerMoveData==
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
|'''Scalars''' (SelectInputScalars)
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''Input''' (Input)
|
|
If clipping with scalars, this property specifies the
Set the input to the Client Server Move Data
name of the scalar array on which to perform the clip
filter.
operation.
|
|


|
|
An array of scalars is required.The value must be field array name.
 
|-
|-
|'''InsideOut''' (InsideOut)
|'''OutputDataType''' (OutputDataType)
|
|
Choose which portion of the dataset should be clipped
 
away.
|
|
0
0
|
|
Accepts boolean values (0 or 1).
 
|-
|-
|'''Value''' (Value)
|'''WholeExtent''' (WholeExtent)
|
|
If clipping with a scalar array, choose the clipping
 
value.
|
|
0.0
0 -1 0 -1 0 -1
|
|
The value must lie within the range of the selected data array.
 


|}
|}


==Compute Derivatives==
==Clip==


This filter computes derivatives of scalars and vectors.
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
CellDerivatives is a filter that computes derivatives of
cuts away a portion of the input data set using an
scalars and vectors at the center of cells. You can choose
implicit plane. This filter operates on all types of data
to generate different output including the scalar gradient
sets, and it returns unstructured grid data on
(a vector), computed tensor vorticity (a vector), gradient
output.
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,385: Line 1,496:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input to the
This property specifies the dataset on which the Clip
filter.
filter will operate.
|
|


Line 1,392: Line 1,503:
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkDataSet
The dataset much contain a field array (point)
The dataset must contain a field array ()


with 1 component(s).
with 1 component(s).
The dataset much contain a field array (point)
with 3 component(s).


|-
|-
|'''Scalars''' (SelectInputScalars)
|'''Clip Type''' (ClipFunction)
|
|
This property indicates the name of the scalar array to
This property specifies the parameters of the clip
differentiate.
function (an implicit plane) used to clip the dataset.
|
|


|
|
An array of scalars is required.
The value can be one of the following:
* Plane (implicit_functions)
 
* Box (implicit_functions)
 
* Sphere (implicit_functions)
 
* Cylinder (implicit_functions)
 
* Scalar (implicit_functions)
 
|-
|-
|'''Vectors''' (SelectInputVectors)
|'''InputBounds''' (InputBounds)
|
|
This property indicates the name of the vector array to
 
differentiate.
|
|
1
 
|
|
An array of vectors is required.
 
|-
|-
|'''OutputVectorType''' (OutputVectorType)
|'''Scalars''' (SelectInputScalars)
|
|
This property Controls how the filter works to generate
If clipping with scalars, this property specifies the
vector cell data. You can choose to compute the gradient of the input
name of the scalar array on which to perform the clip
scalars, or extract the vorticity of the computed vector gradient
operation.
tensor. By default, the filter will take the gradient of the input
scalar data.
|
|
1
 
|
|
The value(s) is an enumeration of the following:
An array of scalars is required.The value must be field array name.
* Nothing (0)
* Scalar Gradient (1)
* Vorticity (2)
|-
|-
|'''OutputTensorType''' (OutputTensorType)
|'''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.
|
|
This property controls how the filter works to generate
0.0
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
The value must lie within the range of the selected data array.
|-
|'''InsideOut''' (InsideOut)
|
|
The value(s) is an enumeration of the following:
If this property is set to 0, the clip filter will
* Nothing (0)
return that portion of the dataset that lies within the clip function.
* Vector Gradient (1)
If set to 1, the portions of the dataset that lie outside the clip
* Strain (2)
function will be returned instead.
 
|
|}
0
 
|
==Connectivity==
Accepts boolean values (0 or 1).
|-
|'''UseValueAsOffset''' (UseValueAsOffset)
|
If UseValueAsOffset is true, Value is used as an offset
parameter to the implicit function. Otherwise, Value is used only when
clipping using a scalar array.
|
0
|
Accepts boolean values (0 or 1).
|-
|'''Crinkle clip''' (PreserveInputCells)
|
This parameter controls whether to extract entire cells
in the given region or clip those cells so all of the output one stay
only inside that region.
|
0
|
Accepts boolean values (0 or 1).
 
|}
 
==Clip Closed Surface==


Mark connected components with integer point attribute array.The Connectivity
Clip a polygonal dataset with a plane to produce closed surfaces
filter assigns a region id to connected components of the
This clip filter cuts away a portion of the input polygonal dataset using
input data set. (The region id is assigned as a point
a plane to generate a new polygonal dataset.
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,470: Line 1,607:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input to the Connectivity
This property specifies the dataset on which the Clip
filter.
filter will operate.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkPolyData
The dataset must contain a field array (point)
 
with 1 component(s).
 
|-
|-
|'''ExtractionMode''' (ExtractionMode)
|'''Clipping Plane''' (ClippingPlane)
|
|
Controls the extraction of connected
This property specifies the parameters of the clipping
surfaces.
plane used to clip the polygonal data.
|
|
5
 
|
|
The value(s) is an enumeration of the following:
The value can be one of the following:
* Extract Point Seeded Regions (1)
* Plane (implicit_functions)
* Extract Cell Seeded Regions (2)
 
* Extract Specified Regions (3)
* Extract Largest Region (4)
* Extract All Regions (5)
* Extract Closes Point Region (6)
|-
|-
|'''ColorRegions''' (ColorRegions)
|'''GenerateFaces''' (GenerateFaces)
|
|
Controls the coloring of the connected
Generate polygonal faces in the output.
regions.
|
|
1
1
|
|
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|}
==Contingency Statistics==
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"
|-
|-
| '''Property'''
|'''GenerateOutline''' (GenerateOutline)
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''Input''' (Input)
|
|
The input to the filter. Arrays from this dataset will
Generate clipping outlines in the output wherever an
be used for computing statistics and/or assessed by a statistical
input face is cut by the clipping plane.
model.
|
|
 
0
|
|
Accepts input of following types:
Accepts boolean values (0 or 1).
* vtkImageData
* vtkStructuredGrid
* vtkPolyData
* vtkUnstructuredGrid
* vtkTable
* vtkGraph
The dataset much contain a field array ()
 
|-
|-
|'''ModelInput''' (ModelInput)
|'''Generate Cell Origins''' (ScalarMode)
|
|
A previously-calculated model with which to assess a
Generate (cell) data for coloring purposes such that the
separate dataset. This input is optional.
newly generated cells (including capping faces and clipping outlines)
can be distinguished from the input cells.
|
|
 
0
|
|
Accepts input of following types:
The value(s) is an enumeration of the following:
* vtkTable
* None (0)
* vtkMultiBlockDataSet
* Color (1)
* Label (2)
|-
|-
|'''AttributeMode''' (AttributeMode)
|'''InsideOut''' (InsideOut)
|
|
Specify which type of field data the arrays will be
If this flag is turned off, the clipper will return the
drawn from.
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
|
|
The value must be field array name.
Accepts boolean values (0 or 1).
|-
|-
|'''Variables of Interest''' (SelectArrays)
|'''Clipping Tolerance''' (Tolerance)
|
|
Choose arrays whose entries will be used to form
Specify the tolerance for creating new points. A small
observations for statistical analysis.
value might incur degenerate triangles.
|
|
 
0.000001
|
|


|-
|-
|'''Task''' (Task)
|'''Base Color''' (BaseColor)
|
|
Specify the task to be performed: modeling and/or
Specify the color for the faces from the
assessment. <ol> <li> "Detailed model of input data,"
input.
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
0.10 0.10 1.00
|
|
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)
|'''Clip Color''' (ClipColor)
|
|
Specify the fraction of values from the input dataset to
Specifiy the color for the capping faces (generated on
be used for model fitting. The exact set of values is chosen at random
the clipping interface).
from the dataset.
|
|
0.1
1.00 0.11 0.10
|
|


Line 1,615: Line 1,700:
|}
|}


==Contour==
==Clip Generic Dataset==


Generate isolines or isosurfaces using point scalars.The Contour
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.
filter computes isolines or isosurfaces using a selected
The Generic Clip filter cuts away a portion of the input
point-centered scalar array. The Contour filter operates
data set using a plane, a sphere, a box, or a scalar
on any type of data set, but the input is required to have
value. The menu in the Clip Function portion of the
at least one point-centered scalar (single-component)
interface allows the user to select which implicit
array. The output of this filter is
function to use or whether to clip using a scalar value.
polygonal.
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,635: Line 1,735:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input dataset to be used by
Set the input to the Generic Clip
the contour filter.
filter.
|
|


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


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


|
|
An array of scalars is required.The value must be field array name.
The value can be one of the following:
* Plane (implicit_functions)
 
* Box (implicit_functions)
 
* Sphere (implicit_functions)
 
* Scalar (implicit_functions)
 
|-
|-
|'''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 this property is set to 1, a scalar array containing
If clipping with scalars, this property specifies the
a normal value at each point in the isosurface or isoline will be
name of the scalar array on which to perform the clip
created by the contour filter; otherwise an array of normals will not
operation.
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).
An array of scalars is required.The value must be field array name.
|-
|-
|'''ComputeGradients''' (ComputeGradients)
|'''InsideOut''' (InsideOut)
|
|
If this property is set to 1, a scalar array containing
Choose which portion of the dataset should be clipped
a gradient value at each point in the isosurface or isoline will be
away.
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
Line 1,699: Line 1,788:
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|-
|'''ComputeScalars''' (ComputeScalars)
|'''Value''' (Value)
|
|
If this property is set to 1, an array of scalars
If clipping with a scalar array, choose the clipping
(containing the contour value) will be added to the output dataset. If
value.
set to 0, the output will not contain this array.
|
|
0
0.0
|
|
Accepts boolean values (0 or 1).
The value must lie within the range of the selected data array.
 
|}
 
==Color By Array==
 
This filter generate a color based image data based on a selected data scalar
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|-
|'''Point Merge Method''' (Locator)
|'''Input''' (Input)
|
|
This property specifies an incremental point locator for
 
merging duplicate / coincident points.
|
|


|
|
The value can be one of the following:
Accepts input of following types:
* MergePoints (incremental_point_locators)
* vtkImageData
The dataset must contain a field array (point)


* IncrementalOctreeMergePoints (incremental_point_locators)
with 1 component(s).


* NonMergingPointLocator (incremental_point_locators)
|-
|'''LookupTable''' (LookupTable)
|


|


|}
|


==Contour Generic Dataset==
|-
|'''Color By''' (SelectInputScalars)
|
This property specifies the name of the scalar array
from which we will color by.
|


Generate isolines or isosurfaces using point scalars.The Generic
|
Contour filter computes isolines or isosurfaces using a
An array of scalars is required.The value must be field array name.
selected point-centered scalar array. The available scalar
|-
arrays are listed in the Scalars menu. The scalar range of
|'''RGBA NaN Color''' (NaNColor)
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
0 0 0 255
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
|'''OutputFormat''' (OutputFormat)
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
3
will be added to the Contour Values list. To delete a
|
value from the Contour Values list, select the value and
The value(s) is an enumeration of the following:
click the Delete button. (If no value is selected, the
* Luminance (1)
last value in the list will be removed.) Clicking the
* Luminance Alpha (2)
Delete All button removes all the values in the list. If
* RGB (3)
no values are in the Contour Values list when Accept is
* RGBA (4)
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
==Compute Derivatives==
selected, the appropriate computation will be performed,
 
and a corresponding point-centered array will be added to
This filter computes derivatives of scalars and vectors.
the output. The Generic Contour filter operates on a
CellDerivatives is a filter that computes derivatives of
generic data set, but the input is required to have at
scalars and vectors at the center of cells. You can choose
least one point-centered scalar (single-component) array.
to generate different output including the scalar gradient
The output of this filter is polygonal.
(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,771: Line 1,884:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
Set the input to the Generic Contour
This property specifies the input to the
filter.
filter.
|
|
Line 1,777: Line 1,890:
|
|
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 (point)


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


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


|
|
An array of scalars is required.The value must be field array name.
An array of scalars is required.
|-
|-
|'''Isosurfaces''' (ContourValues)
|'''Vectors''' (SelectInputVectors)
|
|
This property specifies the values at which to compute
This property indicates the name of the vector array to
isosurfaces/isolines and also the number of such
differentiate.
values.
|
|
 
1
|
|
The value must lie within the range of the selected data array.
An array of vectors is required.
|-
|-
|'''ComputeNormals''' (ComputeNormals)
|'''OutputVectorType''' (OutputVectorType)
|
|
Select whether to compute normals.
This property Controls how the filter works to generate
vector cell data. You can choose to compute the gradient of the input
scalars, or extract the vorticity of the computed vector gradient
tensor. By default, the filter will take the gradient of the input
scalar data.
|
|
1
1
|
|
Accepts boolean values (0 or 1).
The value(s) is an enumeration of the following:
* Nothing (0)
* Scalar Gradient (1)
* Vorticity (2)
|-
|-
|'''ComputeGradients''' (ComputeGradients)
|'''OutputTensorType''' (OutputTensorType)
|
|
Select whether to compute gradients.
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.
|
|
0
1
|
|
Accepts boolean values (0 or 1).
The value(s) is an enumeration of the following:
|-
* Nothing (0)
|'''ComputeScalars''' (ComputeScalars)
* Vector Gradient (1)
|
* Strain (2)
Select whether to compute scalars.
|
0
|
Accepts boolean values (0 or 1).
|-
|'''Point Merge Method''' (Locator)
|
This property specifies an incremental point locator for
merging duplicate / coincident points.
|
 
|
The value can be one of the following:
* MergePoints (incremental_point_locators)
 
* IncrementalOctreeMergePoints (incremental_point_locators)
 
* NonMergingPointLocator (incremental_point_locators)
 


|}
|}


==Convert AMR dataset to Multi-block==
==Compute Quartiles==


Convert AMR to Multiblock
Compute the quartiles table from a dataset or table.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,858: Line 1,964:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input for this
This property specifies the input to the
filter.
filter.
|
|
Line 1,864: Line 1,970:
|
|
Accepts input of following types:
Accepts input of following types:
* vtkOverlappingAMR
* vtkDataObject


|}
|}


==ConvertSelection==
==Connectivity==


Converts a selection from one type to
Mark connected components with integer point attribute array.The Connectivity
another.
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,880: Line 1,990:
| '''Restrictions'''
| '''Restrictions'''


|-
|'''DataInput''' (DataInput)
|
Set the vtkDataObject input used to convert the
selection.
|
|
Accepts input of following types:
* vtkDataObject
|-
|-
|'''Input''' (Input)
|'''Input''' (Input)
|
|
Set the selection to convert.
This property specifies the input to the Connectivity
filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkSelection
* vtkDataSet
|-
|-
|'''OutputType''' (OutputType)
|'''ExtractionMode''' (ExtractionMode)
|
|
Set the ContentType for the output.
Controls the extraction of connected
surfaces.
|
|
5
5
|
|
The value(s) is an enumeration of the following:
The value(s) is an enumeration of the following:
* SELECTIONS (0)
* Extract Point Seeded Regions (1)
* GLOBALIDs (1)
* Extract Cell Seeded Regions (2)
* PEDIGREEIDS (2)
* Extract Specified Regions (3)
* VALUES (3)
* Extract Largest Region (4)
* INDICES (4)
* Extract All Regions (5)
* FRUSTUM (5)
* Extract Closes Point Region (6)
* LOCATION (6)
* THRESHOLDS (7)
|-
|-
|'''ArrayNames''' (ArrayNames)
|'''ColorRegions''' (ColorRegions)
|
|
 
Controls the coloring of the connected
regions.
|
|
 
1
|
 
|-
|'''MatchAnyValues''' (MatchAnyValues)
|
 
|
0
|
|
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
Line 1,934: Line 2,027:
|}
|}


==Crop==
==Contingency Statistics==


Efficiently extract an area/volume of interest from a 2-d image or 3-d volume.The Crop filter
Compute a statistical model of a dataset and/or assess the dataset with a statistical model.
extracts an area/volume of interest from a 2D image or a
This filter either computes a statistical model of a dataset or takes
3D volume by allowing the user to specify the minimum and
such a model as its second input. Then, the model (however it is
maximum extents of each dimension of the data. Both the
obtained) may optionally be used to assess the input dataset. This filter
input and output of this filter are uniform rectilinear
computes contingency tables between pairs of attributes. This result is a
data.
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 1,953: Line 2,052:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input to the Crop
The input to the filter. Arrays from this dataset will
filter.
be used for computing statistics and/or assessed by a statistical
model.
|
|


Line 1,960: Line 2,060:
Accepts input of following types:
Accepts input of following types:
* vtkImageData
* vtkImageData
|-
* vtkStructuredGrid
|'''OutputWholeExtent''' (OutputWholeExtent)
* vtkPolyData
|
* vtkUnstructuredGrid
This property gives the minimum and maximum point index
* vtkTable
(extent) in each dimension for the output dataset.
* vtkGraph
|
The dataset must contain a field array ()
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.
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''ModelInput''' (ModelInput)
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''Input''' (Input)
|
|
This property specifies the input to the Curvature
A previously-calculated model with which to assess a
filter.
separate dataset. This input is optional.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkPolyData
* vtkTable
* vtkMultiBlockDataSet
|-
|-
|'''InvertMeanCurvature''' (InvertMeanCurvature)
|'''AttributeMode''' (AttributeMode)
|
|
If this property is set to 1, the mean curvature
Specify which type of field data the arrays will be
calculation will be inverted. This is useful for meshes with
drawn from.
inward-pointing normals.
|
|
0
0
|
|
Accepts boolean values (0 or 1).
The value must be field array name.
|-
|-
|'''CurvatureType''' (CurvatureType)
|'''Variables of Interest''' (SelectArrays)
|
|
This propery specifies which type of curvature to
Choose arrays whose entries will be used to form
compute.
observations for statistical analysis.
|
|
0
 
|
|
The value(s) is an enumeration of the following:
* Gaussian (0)
* Mean (1)


|}
==D3==
Repartition a data set into load-balanced spatially convex regions. Create ghost cells if requested.The D3 filter is
available when ParaView is run in parallel. It operates on
any type of data set to evenly divide it across the
processors into spatially contiguous regions. The output
of this filter is of type unstructured
grid.
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''Task''' (Task)
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''Input''' (Input)
|
|
This property specifies the input to the D3
Specify the task to be performed: modeling and/or
filter.
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
|
|
Accepts input of following types:
The value(s) is an enumeration of the following:
* vtkDataSet
* 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)
|-
|-
|'''BoundaryMode''' (BoundaryMode)
|'''TrainingFraction''' (TrainingFraction)
|
|
This property determines how cells that lie on processor
Specify the fraction of values from the input dataset to
boundaries are handled. The "Assign cells uniquely" option assigns each
be used for model fitting. The exact set of values is chosen at random
boundary cell to exactly one process, which is useful for isosurfacing.
from the dataset.
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
0.1
|
|
The value(s) is an enumeration of the following:
 
* Assign cells uniquely (0)
* Duplicate cells (1)
* Divide cells (2)
|-
|'''Minimal Memory''' (UseMinimalMemory)
|
If this property is set to 1, the D3 filter requires
communication routines to use minimal memory than without this
restriction.
|
0
|
Accepts boolean values (0 or 1).


|}
|}


==Decimate==
==Contour==


Simplify a polygonal model using an adaptive edge collapse algorithm. This filter works with triangles only.
Generate isolines or isosurfaces using point scalars.The Contour
The Decimate filter reduces the number of triangles in a
filter computes isolines or isosurfaces using a selected
polygonal data set. Because this filter only operates on
point-centered scalar array. The Contour filter operates
triangles, first run the Triangulate filter on a dataset
on any type of data set, but the input is required to have
that contains polygons other than
at least one point-centered scalar (single-component)
triangles.
array. The output of this filter is
polygonal.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,097: Line 2,158:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input to the Decimate
This property specifies the input dataset to be used by
filter.
the contour 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).
 
|-
|-
|'''TargetReduction''' (TargetReduction)
|'''Contour By''' (SelectInputScalars)
|
|
This property specifies the desired reduction in the
This property specifies the name of the scalar array
total number of polygons in the output dataset. For example, if the
from which the contour filter will compute isolines and/or
TargetReduction value is 0.9, the Decimate filter will attempt to
isosurfaces.
produce an output dataset that is 10% the size of the
input.)
|
|
0.9
 
|
|
 
An array of scalars is required.The value must be field array name.
|-
|-
|'''PreserveTopology''' (PreserveTopology)
|'''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, decimation will not split
If this property is set to 1, a scalar array containing
the dataset or produce holes, but it may keep the filter from reaching
a gradient value at each point in the isosurface or isoline will be
the reduction target. If it is set to 0, better reduction can occur
created by this filter; otherwise an array of gradients will not be
(reaching the reduction target), but holes in the model may be
computed. This operation is fairly expensive both in terms of
produced.
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
Line 2,129: Line 2,212:
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|-
|'''FeatureAngle''' (FeatureAngle)
|'''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.
|
|
The value of this property is used in determining where
0
the data set may be split. If the angle between two adjacent triangles
is greater than or equal to the FeatureAngle value, then their boundary
is considered a feature edge where the dataset can be
split.
|
|
15.0
Accepts boolean values (0 or 1).
|-
|'''OutputPointsPrecision''' (OutputPointsPrecision)
|
|


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)
|-
|-
|'''BoundaryVertexDeletion''' (BoundaryVertexDeletion)
|'''GenerateTriangles''' (GenerateTriangles)
|
|
If this property is set to 1, then vertices on the
This parameter controls whether to produce triangles in the output.
boundary of the dataset can be removed. Setting the value of this
Warning: Many filters do not properly handle non-trianglular polygons.
property to 0 preserves the boundary of the dataset, but it may cause
 
the filter not to reach its reduction target.
|
|
1
1
|
|
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
 
|-
|}
|'''Isosurfaces''' (ContourValues)
 
==Delaunay 2D==
 
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"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''Input''' (Input)
|
|
This property specifies the input dataset to the
This property specifies the values at which to compute
Delaunay 2D filter.
isosurfaces/isolines and also the number of such
values.
|
|


|
|
Accepts input of following types:
The value must lie within the range of the selected data array.
* vtkPointSet
|-
|-
|'''ProjectionPlaneMode''' (ProjectionPlaneMode)
|'''Point Merge Method''' (Locator)
|
|
This property determines type of projection plane to use
This property specifies an incremental point locator for
in performing the triangulation.
merging duplicate / coincident points.
|
|
0
 
|
The value(s) is an enumeration of the following:
* XY Plane (0)
* Best-Fitting Plane (2)
|-
|'''Alpha''' (Alpha)
|
The value of this property controls the output of this
filter. For a non-zero alpha value, only edges or triangles contained
within a sphere centered at mesh vertices will be output. Otherwise,
only triangles will be output.
|
0.0
|
|
The value can be one of the following:
* MergePoints (incremental_point_locators)


|-
* IncrementalOctreeMergePoints (incremental_point_locators)
|'''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
|


|-
* NonMergingPointLocator (incremental_point_locators)
|'''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).


|}
|}


==Delaunay 3D==
==Contour Generic Dataset==


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
Generate isolines or isosurfaces using point scalars.The Generic
a 3D Delaunay triangulation from a list of input points. These points may be
Contour filter computes isolines or isosurfaces using a
represented by any dataset of type vtkPointSet and subclasses. The output of
selected point-centered scalar array. The available scalar
the filter is an unstructured grid dataset. Usually the output is a tetrahedral
arrays are listed in the Scalars menu. The scalar range of
mesh, but if a non-zero alpha distance value is specified (called the "alpha"
the selected array will be displayed. The interface for
value), then only tetrahedra, triangles, edges, and vertices lying within the
adding contour values is very similar to the one for
alpha radius are output. In other words, non-zero alpha values may result in
selecting cut offsets (in the Cut filter). To add a single
arbitrary combinations of tetrahedra, triangles, lines, and vertices. (The
contour value, select the value from the New Value slider
notion of alpha value is derived from Edelsbrunner's work on "alpha shapes".)
in the Add value portion of the interface and click the
The 3D Delaunay triangulation is defined as the triangulation that satisfies
Add button, or press Enter. To instead add several evenly
the Delaunay criterion for n-dimensional simplexes (in this case n=3 and the
spaced contours, use the controls in the Generate range of
simplexes are tetrahedra). This criterion states that a circumsphere of each
values section. Select the number of contour values to
simplex in a triangulation contains only the n+1 defining points of the
generate using the Number of Values slider. The Range
simplex. (See text for more information.) While in two dimensions this
slider controls the interval in which to generate the
translates into an "optimal" triangulation, this is not true in 3D, since a
contour values. Once the number of values and range have
measurement for optimality in 3D is not agreed on. Delaunay triangulations are
been selected, click the Generate button. The new values
used to build topological structures from unorganized (or unstructured) points.
will be added to the Contour Values list. To delete a
The input to this filter is a list of points specified in 3D. (If you wish to
value from the Contour Values list, select the value and
create 2D triangulations see Delaunay2D.) The output is an unstructured grid.
click the Delete button. (If no value is selected, the
The Delaunay triangulation can be numerically sensitive. To prevent problems,
last value in the list will be removed.) Clicking the
try to avoid injecting points that will result in triangles with bad aspect
Delete All button removes all the values in the list. If
ratios (1000:1 or greater). In practice this means inserting points that are
no values are in the Contour Values list when Accept is
"widely dispersed", and enables smooth transition of triangle sizes throughout
pressed, the current value of the New Value slider will be
the mesh. (You may even want to add extra points to create a better point
used. In addition to selecting contour values, you can
distribution.) If numerical problems are present, you will see a warning
also select additional computations to perform. If any of
message to this effect at the end of the triangulation process. Warning: Points
Compute Normals, Compute Gradients, or Compute Scalars is
arranged on a regular lattice (termed degenerate cases) can be triangulated in
selected, the appropriate computation will be performed,
more than one way (at least according to the Delaunay criterion). The choice of
and a corresponding point-centered array will be added to
triangulation (as implemented by this algorithm) depends on the order of the
the output. The Generic Contour filter operates on a
input points. The first four points will form a tetrahedron; other degenerate
generic data set, but the input is required to have at
points (relative to this initial tetrahedron) will not break it. Points that
least one point-centered scalar (single-component) array.
are coincident (or nearly so) may be discarded by the algorithm. This is
The output of this filter is polygonal.
because the Delaunay triangulation requires unique input points. You can
 
control the definition of coincidence with the "Tolerance" instance variable.
{| class="PropertiesTable" border="1" cellpadding="5"
The output of the Delaunay triangulation is supposedly a convex hull. In
|-
certain cases this implementation may not generate the convex hull. This
| '''Property'''
behavior can be controlled by the Offset instance variable. Offset is a
| '''Description'''
multiplier used to control the size of the initial triangulation. The larger
| '''Default Value(s)'''
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"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''


Line 2,339: Line 2,321:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input dataset to the
Set the input to the Generic Contour
Delaunay 3D filter.
filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkPointSet
* vtkGenericDataSet
The dataset must contain a field array (point)
 
with 1 component(s).
 
|-
|-
|'''Alpha''' (Alpha)
|'''Contour By''' (SelectInputScalars)
|
|
This property specifies the alpha (or distance) value to
This property specifies the name of the scalar array
control the output of this filter. For a non-zero alpha value, only
from which the contour filter will compute isolines and/or
edges, faces, or tetra contained within the circumsphere (of radius
isosurfaces.
alpha) will be output. Otherwise, only tetrahedra will be
output.
|
0.0
|
|


|-
|'''Tolerance''' (Tolerance)
|
|
This property specifies a tolerance to control
An array of scalars is required.The value must be field array name.
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
|
 
|-
|-
|'''Offset''' (Offset)
|'''ComputeNormals''' (ComputeNormals)
|
|
This property specifies a multiplier to control the size
Select whether to compute normals.
of the initial, bounding Delaunay triangulation.
|
|
2.5
1
|
|
 
Accepts boolean values (0 or 1).
|-
|-
|'''BoundingTriangulation''' (BoundingTriangulation)
|'''ComputeGradients''' (ComputeGradients)
|
|
This boolean controls whether bounding triangulation
Select whether to compute gradients.
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
|
|
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|'''ComputeScalars''' (ComputeScalars)
|
Select whether to compute scalars.
|
0
|
Accepts boolean values (0 or 1).
|-
|'''Isosurfaces''' (ContourValues)
|
This property specifies the values at which to compute
isosurfaces/isolines and also the number of such
values.
|
|
The value must 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 can be one of the following:
* MergePoints (incremental_point_locators)
* IncrementalOctreeMergePoints (incremental_point_locators)
* NonMergingPointLocator (incremental_point_locators)


|}
|}


==Descriptive Statistics==
==Convert AMR dataset to Multi-block==


Compute a statistical model of a dataset and/or assess the dataset with a statistical model.
Convert AMR to Multiblock
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,417: Line 2,408:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
The input to the filter. Arrays from this dataset will
This property specifies the input for this
be used for computing statistics and/or assessed by a statistical
filter.
model.
|
|


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


|-
|}
|'''ModelInput''' (ModelInput)
 
|
==ConvertSelection==
A previously-calculated model with which to assess a
 
separate dataset. This input is optional.
Converts a selection from one type to
|
another.
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''DataInput''' (DataInput)
|
Set the vtkDataObject input used to convert the
selection.
|
 
|
Accepts input of following types:
* vtkDataObject
|-
|'''Input''' (Input)
|
Set the selection to convert.
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkTable
* vtkSelection
* vtkMultiBlockDataSet
|-
|-
|'''AttributeMode''' (AttributeMode)
|'''OutputType''' (OutputType)
|
|
Specify which type of field data the arrays will be
Set the ContentType for the output.
drawn from.
|
|
0
5
|
|
The value must be field array name.
The value(s) is an enumeration of the following:
* SELECTIONS (0)
* GLOBALIDs (1)
* PEDIGREEIDS (2)
* VALUES (3)
* INDICES (4)
* FRUSTUM (5)
* LOCATION (6)
* THRESHOLDS (7)
|-
|-
|'''Variables of Interest''' (SelectArrays)
|'''ArrayNames''' (ArrayNames)
|
|
Choose arrays whose entries will be used to form
 
observations for statistical analysis.
|
|


Line 2,462: Line 2,474:


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


|}
|}


==Elevation==
==Crop==


Create point attribute array by projecting points onto an elevation vector.
Efficiently extract an area/volume of interest from a 2-d image or 3-d volume.The Crop filter
The Elevation filter generates point scalar values for an
extracts an area/volume of interest from a 2D image or a
input dataset along a specified direction vector. The
3D volume by allowing the user to specify the minimum and
Input menu allows the user to select the data set to which
maximum extents of each dimension of the data. Both the
this filter will be applied. Use the Scalar range entry
input and output of this filter are uniform rectilinear
boxes to specify the minimum and maximum scalar value to
data.
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,540: Line 2,503:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input dataset to the
This property specifies the input to the Crop
Elevation filter.
filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkImageData
|-
|-
|'''ScalarRange''' (ScalarRange)
|'''OutputWholeExtent''' (OutputWholeExtent)
|
|
This property determines the range into which scalars
This property gives the minimum and maximum point index
will be mapped.
(extent) in each dimension for the output dataset.
|
|
0 1
0 0 0 0 0 0
|
|
 
The value(s) must lie within the structured-extents of the input dataset.
|-
|'''Low Point''' (LowPoint)
|
This property defines one end of the direction vector
(small scalar values).
|
0 0 0
|
 
The value must lie within the bounding box of the dataset.
 
It will default to the min in each dimension.
 
|-
|'''High Point''' (HighPoint)
|
This property defines the other end of the direction
vector (large scalar values).
|
0 0 1
|
 
The value must lie within the bounding box of the dataset.
 
It will default to the max in each dimension.
 


|}
|}


==Extract AMR Blocks==
==Curvature==


This filter extracts a list of datasets from hierarchical datasets.This filter extracts a list
This filter will compute the Gaussian or mean curvature of the mesh at each point.The
of datasets from hierarchical datasets.
Curvature filter computes the curvature at each point in a
polygonal data set. This filter supports both Gaussian and
mean curvatures. ; the type can be selected from the
Curvature type menu button.


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


|
|
Accepts input of following types:
Accepts input of following types:
* vtkUniformGridAMR
* vtkPolyData
|-
|-
|'''SelectedDataSets''' (SelectedDataSets)
|'''InvertMeanCurvature''' (InvertMeanCurvature)
|
If this property is set to 1, the mean curvature
calculation will be inverted. This is useful for meshes with
inward-pointing normals.
|
|
This property provides a list of datasets to
0
extract.
|
|
 
Accepts boolean values (0 or 1).
|-
|'''CurvatureType''' (CurvatureType)
|
|
This propery specifies which type of curvature to
compute.
|
0
|
The value(s) is an enumeration of the following:
* Gaussian (0)
* Mean (1)
|}


 
==D3==
|}
 
 
Repartition a data set into load-balanced spatially convex regions. Create ghost cells if requested.The D3 filter is
==Extract Attributes==
available when ParaView is run in parallel. It operates on
 
any type of data set to evenly divide it across the
Extract attribute data as a table.This is a
processors into spatially contiguous regions. The output
filter that produces a vtkTable from the chosen attribute
of this filter is of type unstructured
in the input dataobject. This filter can accept composite
grid.
datasets. If the input is a composite dataset, the output
is a multiblock with vtkTable leaves.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,637: Line 2,590:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input of the
This property specifies the input to the D3
filter.
filter.
|
|
Line 2,643: Line 2,596:
|
|
Accepts input of following types:
Accepts input of following types:
* vtkDataObject
* vtkDataSet
|-
|-
|'''FieldAssociation''' (FieldAssociation)
|'''BoundaryMode''' (BoundaryMode)
|
|
Select the attribute data to pass.
This property determines how cells that lie on processor
boundaries are handled. The "Assign cells uniquely" option assigns each
boundary cell to exactly one process, which is useful for isosurfacing.
Selecting "Duplicate cells" causes the cells on the boundaries to be
copied to each process that shares that boundary. The "Divide cells"
option breaks cells across process boundary lines so that pieces of the
cell lie in different processes. This option is useful for volume
rendering.
|
|
0
0
|
|
The value(s) is an enumeration of the following:
The value(s) is an enumeration of the following:
* Points (0)
* Assign cells uniquely (0)
* Cells (1)
* Duplicate cells (1)
* Field Data (2)
* Divide cells (2)
* Vertices (4)
* Edges (5)
* Rows (6)
|-
|-
|'''AddMetaData''' (AddMetaData)
|'''Minimal Memory''' (UseMinimalMemory)
|
|
It is possible for this filter to add additional
If this property is set to 1, the D3 filter requires
meta-data to the field data such as point coordinates (when point
communication routines to use minimal memory than without this
attributes are selected and input is pointset) or structured
restriction.
coordinates etc. To enable this addition of extra information, turn
this flag on. Off by default.
|
|
0
0
Line 2,673: Line 2,628:
|}
|}


==Extract Block==
==Decimate==


This filter extracts a range of blocks from a multiblock dataset.This filter extracts a range
Simplify a polygonal model using an adaptive edge collapse algorithm. This filter works with triangles only.
of groups from a multiblock dataset
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,688: Line 2,647:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input to the Extract Group
This property specifies the input to the Decimate
filter.
filter.
|
|
Line 2,694: Line 2,653:
|
|
Accepts input of following types:
Accepts input of following types:
* vtkMultiBlockDataSet
* vtkPolyData
|-
|-
|'''BlockIndices''' (BlockIndices)
|'''TargetReduction''' (TargetReduction)
|
|
This property lists the ids of the blocks to extract
This property specifies the desired reduction in the
from the input multiblock dataset.
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
|
|


|-
|-
|'''PruneOutput''' (PruneOutput)
|'''PreserveTopology''' (PreserveTopology)
|
|
When set, the output mutliblock dataset will be pruned
If this property is set to 1, decimation will not split
to remove empty nodes. On by default.
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.
|
|
1
0
|
|
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|-
|'''MaintainStructure''' (MaintainStructure)
|'''FeatureAngle''' (FeatureAngle)
|
The value of this property is used in determining where
the data set may be split. If the angle between two adjacent triangles
is greater than or equal to the FeatureAngle value, then their boundary
is considered a feature edge where the dataset can be
split.
|
15.0
|
 
|-
|'''BoundaryVertexDeletion''' (BoundaryVertexDeletion)
|
|
This is used only when PruneOutput is ON. By default,
If this property is set to 1, then vertices on the
when pruning the output i.e. remove empty blocks, if node has only 1
boundary of the dataset can be removed. Setting the value of this
non-null child block, then that node is removed. To preserve these
property to 0 preserves the boundary of the dataset, but it may cause
parent nodes, set this flag to true.
the filter not to reach its reduction target.
|
|
0
1
|
|
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
Line 2,727: Line 2,704:
|}
|}


==Extract CTH Parts==
==Delaunay 2D==


Create a surface from a CTH volume fraction.Extract
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.
CTH Parts is a specialized filter for visualizing the data
Delaunay2D is a filter that constructs a 2D Delaunay
from a CTH simulation. It first converts the selected
triangulation from a list of input points. These points
cell-centered arrays to point-centered ones. It then
may be represented by any dataset of type vtkPointSet and
contours each array at a value of 0.5. The user has the
subclasses. The output of the filter is a polygonal
option of clipping the resulting surface(s) with a plane.
dataset containing a triangle mesh. The 2D Delaunay
This filter only operates on unstructured data. It
triangulation is defined as the triangulation that
produces polygonal output.
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,748: Line 2,765:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input to the Extract CTH
This property specifies the input dataset to the
Parts filter.
Delaunay 2D filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkPointSet
The dataset much contain a field array (cell)
 
with 1 component(s).
 
|-
|-
|'''Clip Type''' (ClipPlane)
|'''ProjectionPlaneMode''' (ProjectionPlaneMode)
|
|
This property specifies whether to clip the dataset, and
This property determines type of projection plane to use
if so, it also specifies the parameters of the plane with which to
in performing the triangulation.
clip.
|
|
 
0
|
|
The value can be one of the following:
The value(s) is an enumeration of the following:
* None (implicit_functions)
* XY Plane (0)
 
* Best-Fitting Plane (2)
* Plane (implicit_functions)
 
* Box (implicit_functions)
 
* Sphere (implicit_functions)
 
|-
|-
|'''Double Volume Arrays''' (AddDoubleVolumeArrayName)
|'''Alpha''' (Alpha)
|
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.
|
|
This property specifies the name(s) of the volume
0.0
fraction array(s) for generating parts.
|
|


|-
|'''Tolerance''' (Tolerance)
|
|
An array of scalars is required.
This property specifies a tolerance to control
|-
discarding of closely spaced points. This tolerance is specified as a
|'''Float Volume Arrays''' (AddFloatVolumeArrayName)
fraction of the diagonal length of the bounding box of the
points.
|
|
This property specifies the name(s) of the volume
0.00001
fraction array(s) for generating parts.
|
|


|-
|'''Offset''' (Offset)
|
|
An array of scalars is required.
This property is a multiplier to control the size of the
|-
initial, bounding Delaunay triangulation.
|'''Unsigned Character Volume Arrays''' (AddUnsignedCharVolumeArrayName)
|
|
This property specifies the name(s) of the volume
1.0
fraction array(s) for generating parts.
|
|


|
An array of scalars is required.
|-
|-
|'''Volume Fraction Value''' (VolumeFractionSurfaceValue)
|'''BoundingTriangulation''' (BoundingTriangulation)
|
|
The value of this property is the volume fraction value
If this property is set to 1, bounding triangulation
for the surface.
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.1
0
|
|
 
Accepts boolean values (0 or 1).


|}
|}


==Extract Cells By Region==
==Delaunay 3D==


This filter extracts cells that are inside/outside a region or at a region boundary.
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
This filter extracts from its input dataset all cells that are either
a 3D Delaunay triangulation from a list of input points. These points may be
completely inside or outside of a specified region (implicit function).
represented by any dataset of type vtkPointSet and subclasses. The output of
On output, the filter generates an unstructured grid. To use this filter
the filter is an unstructured grid dataset. Usually the output is a tetrahedral
you must specify a region (implicit function). You must also specify
mesh, but if a non-zero alpha distance value is specified (called the "alpha"
whethter to extract cells lying inside or outside of the region. An
value), then only tetrahedra, triangles, edges, and vertices lying within the
option exists to extract cells that are neither inside or outside (i.e.,
alpha radius are output. In other words, non-zero alpha values may result in
boundary).
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,837: Line 2,889:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input to the Slice
This property specifies the input dataset to the
filter.
Delaunay 3D filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkPointSet
|-
|-
|'''Intersect With''' (ImplicitFunction)
|'''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.
|
|
This property sets the region used to extract
0.0
cells.
|
|


|-
|'''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.001
|
|
The value can be one of the following:
* Plane (implicit_functions)
* Box (implicit_functions)


* Sphere (implicit_functions)
|-
|'''Offset''' (Offset)
|
This property specifies a multiplier to control the size
of the initial, bounding Delaunay triangulation.
|
2.5
|


|-
|-
|'''InputBounds''' (InputBounds)
|'''BoundingTriangulation''' (BoundingTriangulation)
|
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
|
Accepts boolean values (0 or 1).
|-
|'''AlphaTets''' (AlphaTets)
|
|
 
This boolean controls whether tetrahedrons which satisfy
the alpha criterion output when alpha is non-zero.
|
|
 
1
|
|
 
Accepts boolean values (0 or 1).
|-
|-
|'''Extraction Side''' (ExtractInside)
|'''AlphaTris''' (AlphaTris)
|
|
This parameter controls whether to extract cells that
This boolean controls whether triangles which satisfy
are inside or outside the region.
the alpha criterion output when alpha is non-zero.
|
|
1
1
|
|
The value(s) is an enumeration of the following:
Accepts boolean values (0 or 1).
* outside (0)
* inside (1)
|-
|-
|'''Extract only intersected''' (Extract only intersected)
|'''AlphaLines''' (AlphaLines)
|
|
This parameter controls whether to extract only cells
This boolean controls whether lines which satisfy the
that are on the boundary of the region. If this parameter is set, the
alpha criterion output when alpha is non-zero.
Extraction Side parameter is ignored. If Extract Intersected is off,
this parameter has no effect.
|
|
0
0
Line 2,890: Line 2,967:
Accepts boolean values (0 or 1).
Accepts boolean values (0 or 1).
|-
|-
|'''Extract intersected''' (Extract intersected)
|'''AlphaVerts''' (AlphaVerts)
|
|
This parameter controls whether to extract cells that
This boolean controls whether vertices which satisfy the
are on the boundary of the region.
alpha criterion are output when alpha is non-zero.
|
|
0
0
Line 2,901: Line 2,978:
|}
|}


==Extract Edges==
==Descriptive Statistics==


Extract edges of 2D and 3D cells as lines.The Extract Edges
Compute a statistical model of a dataset and/or assess the dataset with a statistical model.
filter produces a wireframe version of the input dataset
This filter either computes a statistical model of a dataset or takes
by extracting all the edges of the dataset's cells as
such a model as its second input. Then, the model (however it is
lines. This filter operates on any type of data set and
obtained) may optionally be used to assess the input dataset.<p>
produces polygonal output.
This filter computes the min, max, mean, raw moments M2 through M4,
 
standard deviation, skewness, and kurtosis for each array you
{| class="PropertiesTable" border="1" cellpadding="5"
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"
|-
|-
| '''Property'''
| '''Property'''
Line 2,919: Line 3,003:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input to the Extract Edges
The input to the filter. Arrays from this dataset will
filter.
be used for computing statistics and/or assessed by a statistical
model.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkImageData
 
* vtkStructuredGrid
|}
* vtkPolyData
 
* vtkUnstructuredGrid
==Extract Generic Dataset Surface==
* vtkTable
 
* vtkGraph
Extract geometry from a higher-order dataset
The dataset must contain a field array ()
Extract geometry from a higher-order
dataset.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''ModelInput''' (ModelInput)
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''Input''' (Input)
|
|
Set the input to the Generic Geometry
A previously-calculated model with which to assess a
Filter.
separate dataset. This input is optional.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkGenericDataSet
* vtkTable
* vtkMultiBlockDataSet
|-
|-
|'''PassThroughCellIds''' (PassThroughCellIds)
|'''AttributeMode''' (AttributeMode)
|
Specify which type of field data the arrays will be
drawn from.
|
0
|
|
Select whether to forward original ids.
The value must be field array name.
|-
|'''Variables of Interest''' (SelectArrays)
|
|
1
Choose arrays whose entries will be used to form
observations for statistical analysis.
|
|
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'''
|'''Task''' (Task)
| '''Description'''
|
| '''Default Value(s)'''
Specify the task to be performed: modeling and/or
| '''Restrictions'''
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)
|-
|-
|'''Input''' (Input)
|'''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.
|
|
This property specifies the input to the Extract Group
0.1
filter.
|
|


|
Accepts input of following types:
* vtkUniformGridAMR
|-
|-
|'''Levels''' (Levels)
|'''Deviations should be''' (SignedDeviations)
|
|
This property lists the levels to extract from the input
Should the assessed values be signed deviations or
hierarchical dataset.
unsigned?
|
|
 
0
|
|
 
The value(s) is an enumeration of the following:
* Unsigned (0)
* Signed (1)


|}
|}


==Extract Selection==
==Elevation==


Extract different type of selections.This
Create point attribute array by projecting points onto an elevation vector.
filter extracts a set of cells/points given a selection.
The Elevation filter generates point scalar values for an
The selection can be obtained from a rubber-band selection
input dataset along a specified direction vector. The
(either cell, visible or in a frustum) or threshold
Input menu allows the user to select the data set to which
selection and passed to the filter or specified by
this filter will be applied. Use the Scalar range entry
providing an ID list.
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 3,016: Line 3,126:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input from which the
This property specifies the input dataset to the
selection is extracted.
Elevation filter.
|
|


Line 3,023: Line 3,133:
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkDataSet
* vtkTable
|-
|-
|'''Selection''' (Selection)
|'''ScalarRange''' (ScalarRange)
|
This property determines the range into which scalars
will be mapped.
|
|
The input that provides the selection
0 1
object.
|
|


|
Accepts input of following types:
* vtkSelection
|-
|-
|'''PreserveTopology''' (PreserveTopology)
|'''Low Point''' (LowPoint)
|
|
If this property is set to 1 the output preserves the
This property defines one end of the direction vector
topology of its input and adds an insidedness array to mark which cells
(small scalar values).
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 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.
 
|-
|-
|'''ShowBounds''' (ShowBounds)
|'''High Point''' (HighPoint)
|
|
For frustum selection, if this property is set to 1 the
This property defines the other end of the direction
output is the outline of the frustum instead of the contents of the
vector (large scalar values).
input that lie within the frustum.
|
|
0
0 0 1
|
|
Accepts boolean values (0 or 1).
 
The value must lie within the bounding box of the dataset.
 
It will default to the max in each dimension.
 


|}
|}


==Extract Selection (internal)==
==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.


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"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 3,076: Line 3,188:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
The input from which the selection is
Set the input of the filter.
extracted.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkDataObject
|-
|'''DisplayUserName''' (DisplayUserName)
|
 
Toggle User Name Visibility.
 
|
0
|
Accepts boolean values (0 or 1).
|-
|'''DisplaySystemName''' (DisplaySystemName)
|
 
Toggle System Name Visibility.
 
|
0
|
Accepts boolean values (0 or 1).
|-
|'''DisplayDate''' (DisplayDate)
|
 
Toggle Date/Time Visibility.
 
|
0
|
Accepts boolean values (0 or 1).
|-
|'''DisplayFileName''' (DisplayFileName)
|
 
Toggle File Name Visibility.
 
|
0
|
Accepts boolean values (0 or 1).
|-
|-
|'''Selection''' (Selection)
|'''FileName''' (FileName)
|
|
The input that provides the selection
Annotation of file name.
object.
|
|


|
|
Accepts input of following types:
 
* vtkSelection


|}
|}


==Extract Subset==
==Extract AMR Blocks==


Extract a subgrid from a structured grid with the option of setting subsample strides.The Extract
This filter extracts a list of datasets from hierarchical datasets.This filter extracts a list
Grid filter returns a subgrid of a structured input data
of datasets from hierarchical datasets.
set (uniform rectilinear, curvilinear, or nonuniform
rectilinear). The output data set type of this filter is
the same as the input type.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 3,114: Line 3,260:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input to the Extract Grid
This property specifies the input to the Extract
filter.
Datasets filter.
|
|


|
|
Accepts input of following types:
Accepts input of following types:
* vtkImageData
* vtkUniformGridAMR
* vtkRectilinearGrid
* vtkStructuredPoints
* vtkStructuredGrid
|-
|-
|'''VOI''' (VOI)
|'''SelectedDataSets''' (SelectedDataSets)
|
|
This property specifies the minimum and maximum point
This property provides a list of datasets to
indices along each of the I, J, and K axes; these values indicate the
extract.
volume of interest (VOI). The output will have the (I,J,K) extent
specified here.
|
0 0 0 0 0 0
|
The value(s) must lie within the structured-extents of the input dataset.
|-
|'''SampleRateI''' (SampleRateI)
|
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)
|
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.
|
1
|
|-
|'''SampleRateK''' (SampleRateK)
|
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.
|
1
|
|


|-
|'''IncludeBoundary''' (IncludeBoundary)
|
If the value of this property is 1, then if the sample
rate in any dimension is greater than 1, the boundary indices of the
input dataset will be passed to the output even if the boundary extent
is not an even multiple of the sample rate in a given
dimension.
|
0
|
Accepts boolean values (0 or 1).


|}
|}


==Extract Surface==
==Extract Attributes==


Extract a 2D boundary surface using neighbor relations to eliminate internal faces.The Extract
Extract attribute data as a table.This is a
Surface filter extracts the polygons forming the outer
filter that produces a vtkTable from the chosen attribute
surface of the input dataset. This filter operates on any
in the input dataobject. This filter can accept composite
type of data and produces polygonal data as
datasets. If the input is a composite dataset, the output
output.
is a multiblock with vtkTable leaves.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 3,198: Line 3,297:
|'''Input''' (Input)
|'''Input''' (Input)
|
|
This property specifies the input to the Extract Surface
This property specifies the input of the
filter.
filter.
|
|
Line 3,204: Line 3,303:
|
|
Accepts input of following types:
Accepts input of following types:
* vtkDataSet
* vtkDataObject
|-
|-
|'''PieceInvariant''' (PieceInvariant)
|'''FieldAssociation''' (FieldAssociation)
|
Select the attribute data to pass.
|
|
If the value of this property is set to 1, internal
0
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.
|
|