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

From KitwarePublic

< ParaView

Jump to navigationJump to search
Jpouderoux (talk | contribs) |
|||

(3 intermediate revisions by 2 users 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 | 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 | The dataset must contain a field array (cell) | ||

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

Line 232: | Line 294: | ||

|} | |} | ||

== | ==AMR Fragment Integration== | ||

Fragment Integration | |||

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 252: | Line 308: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies the volume input of the | |||

filter. | |||

| | | | ||

| | | | ||

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

|- | |- | ||

| ''' | |'''SelectMassArrays''' (SelectMassArrays) | ||

| | | | ||

This property specifies the cell arrays from which the | |||

analysis will determine fragment mass | |||

| | | | ||

| | | | ||

An array of scalars is required. | |||

|- | |- | ||

|''' | |'''SelectVolumeWeightedArrays''' (SelectVolumeWeightedArrays) | ||

| | | | ||

This property specifies the cell arrays from which the | |||

analysis will determine volume weighted average values | |||

| | | | ||

| | | | ||

An array of scalars is required. | |||

|- | |- | ||

|''' | |'''SelectMassWeightedArrays''' (SelectMassWeightedArrays) | ||

| | | | ||

This property specifies the cell arrays from which the | |||

analysis will determine mass weighted average values | |||

| | | | ||

| | | | ||

An array of scalars is required. | |||

|} | |} | ||

== | ==AMR Fragments Filter== | ||

Meta Fragment filterCombines the running of | |||

AMRContour, AMRFragmentIntegration, AMRDualContour and ExtractCTHParts | |||

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

|- | |- | ||

|''' | |'''SelectMassArrays''' (SelectMassArrays) | ||

| | | | ||

This property specifies the cell arrays from which the | |||

analysis will determine fragment mass | |||

| | | | ||

| | | | ||

An array of scalars is required. | |||

|- | |- | ||

|''' | |'''SelectVolumeWeightedArrays''' (SelectVolumeWeightedArrays) | ||

| | |||

This property specifies the cell arrays from which the | |||

analysis will determine volume weighted average values | |||

| | |||

| | |||

An array of scalars is required. | |||

|- | |||

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

| | | | ||

This property specifies the values at which to compute | |||

the isosurface. | |||

| | | | ||

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

|} | |} | ||

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

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 392: | Line 473: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

The input. | |||

| | |||

| | | | ||

|- | |||

|'''FileName''' (FileName) | |||

| | | | ||

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

| | |||

| | |||

The value(s) must be a filename (or filenames). | |||

( | |||

|} | |||

==Angular Periodic Filter== | |||

This filter generate a periodic multiblock dataset.This filter generate a periodic | |||

multiblock dataset | |||

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 425: | Line 506: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies the | This property specifies the input to the Periodic 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. | |||

| | |||

| | | | ||

|- | |- | ||

| ''' | |'''IterationMode''' (IterationMode) | ||

| | | | ||

| | This property specifies the mode of iteration, either a user-provided number | ||

| ''' | of periods, or the maximum number of periods to rotate to 360°. | ||

| | |||

1 | |||

| | |||

The value(s) is an enumeration of the following: | |||

* Manual (0) | |||

* Maximum (1) | |||

|- | |||

|'''NumberOfPeriods''' (NumberOfPeriods) | |||

| | |||

This property specifies the number of iteration | |||

| | |||

3 | |||

| | |||

|- | |- | ||

|''' | |'''RotationMode''' (RotationMode) | ||

| | |||

This property specifies the mode of rotation, either from a user provided | |||

angle or from an array in the data. | |||

| | |||

0 | |||

| | | | ||

The value(s) is an enumeration of the following: | |||

* Direct Angle (0) | |||

* Array Value (1) | |||

|- | |||

|'''RotationAngle''' (RotationAngle) | |||

| | | | ||

Rotation angle in degree. | |||

| | | | ||

10 | |||

| | |||

| | |- | ||

|'''RotationArrayName''' (RotationArrayName) | |||

| | |||

Field array name that contains the rotation angle in radian. | |||

| | |||

periodic angle | |||

| | |||

|- | |- | ||

| ''' | |'''Axis''' (Axis) | ||

| | | | ||

| | This property specifies the axis of rotation | ||

| | |||

0 | |||

| | |||

The value(s) is an enumeration of the following: | |||

* Axis X (0) | |||

* Axis Y (1) | |||

* Axis Z (2) | |||

|- | |- | ||

|''' | |'''Center''' (Center) | ||

| | |||

This property specifies the 3D coordinates for the | |||

center of the rotation. | |||

| | | | ||

0.0 0.0 0.0 | |||

| | | | ||

|} | |} | ||

== | ==Annotate Attribute Data== | ||

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

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 506: | Line 617: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

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

* | * vtkDataSet | ||

* vtkTable | |||

The dataset must contain a field array (any) | |||

with 1 component(s). | |||

|- | |||

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

| | |||

| | |||

|- | |- | ||

| ''' | |'''ElementId''' (ElementId) | ||

| | | | ||

Set the element index to annotate with. | |||

| | | | ||

0 | |||

| | | | ||

|- | |||

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

| | | | ||

Set the process rank to extract element from. | |||

== | | | ||

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

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 559: | Line 707: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

Set the input | 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). | |||

|- | |- | ||

|''' | |'''SelectArrays''' (SelectArrays) | ||

| | |||

Choose arrays that is going to be | |||

displayed | |||

| | |||

| | | | ||

|- | |||

|'''Prefix''' (Prefix) | |||

| | | | ||

Text that is used as a prefix to the field | |||

value | |||

| | |||

Value is: | |||

| | | | ||

|- | |- | ||

|''' | |'''Suffix''' (Suffix) | ||

| | | | ||

Text that is used as a suffix to the field | |||

value | |||

| | | | ||

| | | | ||

|} | |} | ||

== | ==Annotate Time Filter== | ||

Shows input data time as text annnotation in the view.The Annotate Time | |||

filter can be used to show the data time in a text | |||

as | annotation. | ||

be | |||

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

display the time. | |||

| | | | ||

| | | | ||

|- | |- | ||

|''' | |'''Format''' (Format) | ||

| | | | ||

The value of this property is a format string used to | |||

display the input time. The format string is specified using printf | |||

style. | |||

| | | | ||

Time: %f | |||

| | | | ||

|- | |- | ||

|''' | |'''Shift''' (Shift) | ||

| | | | ||

The amount of time the input is shifted (after | |||

scaling). | |||

| | | | ||

0.0 | |||

| | | | ||

|- | |- | ||

|''' | |'''Scale''' (Scale) | ||

| | | | ||

The factor by which the input time is | |||

scaled. | |||

| | | | ||

1 | 1.0 | ||

| | | | ||

Line 731: | Line 800: | ||

|} | |} | ||

== | ==Append Attributes== | ||

Copies geometry from first input. Puts all of the arrays into the output. | |||

The Append Attributes filter takes multiple input data | |||

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 757: | Line 824: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies the input to the | 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 | ||

|} | |} | ||

== | ==Append Datasets== | ||

Takes an input of multiple datasets and output has only one unstructured grid.The Append | |||

Datasets filter operates on multiple data sets of any type | |||

(polygonal, structured, etc.). It merges their geometry | |||

into a single data set. Only the point and cell attributes | |||

that all of the input data sets have in common will appear | |||

in the output. The input data sets must already be | |||

collected together, either as a result of a reader that | |||

loads multiple parts (e.g., EnSight reader) or because the | |||

Group Parts filter has been run to form a collection of | |||

data sets. | |||

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 795: | Line 857: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies the | This property specifies the datasets to be merged into a | ||

single dataset by the Append Datasets filter. | |||

| | | | ||

Line 802: | Line 864: | ||

Accepts input of following types: | Accepts input of following types: | ||

* vtkDataSet | * vtkDataSet | ||

|} | |||

==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''' | ||

| | | '''Description''' | ||

| '''Default Value(s)''' | |||

| '''Restrictions''' | |||

| | |||

| | |||

|- | |- | ||

|''' | |'''Input''' (Input) | ||

| | | | ||

Set the input to the Append Geometry | |||

filter. | |||

| | | | ||

| | | | ||

Accepts | Accepts input of following types: | ||

* vtkPolyData | |||

|} | |} | ||

== | ==Block Scalars== | ||

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

Scalars filter uses colors to show levels of a multiblock | |||

dataset. | |||

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 848: | Line 911: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies the input to the Level Scalars | |||

filter. | |||

| | | | ||

| | | | ||

Accepts input of following types: | Accepts input of following types: | ||

* | * vtkMultiBlockDataSet | ||

|} | |||

==CTH Surface== | |||

Not finished yet. | |||

{| class="PropertiesTable" border="1" cellpadding="5" | |||

|- | |||

| '''Property''' | |||

| '''Description''' | |||

| '''Default Value(s)''' | |||

| '''Restrictions''' | |||

|- | |- | ||

|''' | |'''Input''' (Input) | ||

| | | | ||

This property specifies the input of the | |||

filter. | |||

| | | | ||

| | | | ||

Accepts | 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" | |||

|- | |- | ||

|''' | | '''Property''' | ||

| | | '''Description''' | ||

| '''Default Value(s)''' | |||

| '''Restrictions''' | |||

| | |||

|- | |- | ||

|''' | |'''Input''' (Input) | ||

| | | | ||

Set the input to the Update Suppressor | |||

filter. | |||

| | | | ||

| | | | ||

|- | |- | ||

|''' | |'''CacheTime''' (CacheTime) | ||

| | | | ||

| | | | ||

0 | 0.0 | ||

| | | | ||

|- | |- | ||

|''' | |'''CachingEnabled''' (CachingEnabled) | ||

| | | | ||

Toggle whether the caching is enabled. | |||

| | | | ||

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

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

the | 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 968: | Line 1,066: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies the input to the | This property specifies the input dataset to the | ||

Calculator filter. The scalar and vector variables may be chosen from | |||

this dataset's arrays. | |||

| | | | ||

| | | | ||

Accepts input of following types: | Accepts input of following types: | ||

* | * vtkDataSet | ||

The dataset must contain a field array () | |||

|- | |- | ||

| ''' | |'''AttributeMode''' (AttributeMode) | ||

| | | | ||

| | This property determines whether the computation is to | ||

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

|- | |- | ||

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

|- | |- | ||

|''' | |'''ResultNormals''' (ResultNormals) | ||

| | | | ||

Set | Set whether to output results as point/cell | ||

normals. Outputing as normals is only valid with vector | |||

results. Point or cell normals are selected using | |||

AttributeMode. | |||

| | | | ||

0 | |||

| | | | ||

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

|- | |- | ||

|''' | |'''ResultTCoords''' (ResultTCoords) | ||

| | | | ||

Set whether to output results as point/cell | |||

texture coordinates. Point or cell texture coordinates are | |||

selected using AttributeMode. 2-component texture coordinates | |||

cannot be generated at this time. | |||

| | | | ||

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

| | |||

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

array. | |||

| | |||

| | |||

{| 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 | This property specifies the input to the Cell Centers | ||

filter | filter. | ||

| | | | ||

Line 1,073: | Line 1,194: | ||

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

Create point attributes by averaging cell attributes.The Cell | |||

Data to Point Data filter averages the values of the cell | |||

attributes of the cells surrounding a point to compute | |||

point attributes. The Cell Data to Point Data filter | |||

operates on any type of data set, and the output data set | |||

is of the same type as the input. | |||

| | {| class="PropertiesTable" border="1" cellpadding="5" | ||

|- | |||

| | | '''Property''' | ||

| '''Description''' | |||

| '''Default Value(s)''' | |||

| '''Restrictions''' | |||

|- | |- | ||

|''' | |'''Input''' (Input) | ||

| | | | ||

This property specifies the input to the Cell Data to | |||

Point Data filter. | |||

| | | | ||

| | | | ||

Accepts input of following types: | |||

* vtkDataSet | |||

The dataset must contain a field array (cell) | |||

|- | |- | ||

|''' | |'''PassCellData''' (PassCellData) | ||

| | | | ||

If | If this property is set to 1, then the input cell data | ||

is passed through to the output; otherwise, only the generated point | |||

data will be available in the output. | |||

| | | | ||

0 | 0 | ||

Line 1,137: | Line 1,245: | ||

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

|- | |- | ||

|''' | |'''PieceInvariant''' (PieceInvariant) | ||

| | | | ||

If | If the value of this property is set to 1, this filter | ||

will request ghost levels so that the values at boundary points match | |||

across processes. NOTE: Enabling this option might cause multiple | |||

executions of the data source because more information is needed to | |||

remove internal surfaces. | |||

| | | | ||

0 | 0 | ||

| | | | ||

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

|} | |||

==Clean== | |||

Merge coincident points if they do not meet a feature edge criteria.The Clean filter | |||

takes polygonal data as input and generates polygonal data | |||

as output. This filter can merge duplicate points, remove | |||

unused points, and transform degenerate cells into their | |||

appropriate forms (e.g., a triangle is converted into a | |||

line if two of its points are merged). | |||

|} | |||

== | |||

This | |||

a | |||

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 1,175: | Line 1,278: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

Set the input to the Clean filter. | |||

filter | |||

| | | | ||

Line 1,182: | Line 1,284: | ||

Accepts input of following types: | Accepts input of following types: | ||

* vtkPolyData | * vtkPolyData | ||

|- | |- | ||

|''' | |'''PieceInvariant''' (PieceInvariant) | ||

| | | | ||

If this property is set to 1, the whole data set will be | |||

processed at once so that cleaning the data set always produces the | |||

same results. If it is set to 0, the data set can be processed one | |||

piece at a time, so it is not necessary for the entire data set to fit | |||

into memory; however the results are not guaranteed to be the same as | |||

they would be if the Piece invariant option was on. Setting this option | |||

to 0 may produce seams in the output dataset when ParaView is run in | |||

parallel. | |||

| | | | ||

1 | 1 | ||

Line 1,206: | Line 1,300: | ||

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

|- | |- | ||

|''' | |'''Tolerance''' (Tolerance) | ||

| | | | ||

If merging nearby points (see PointMerging property) and | |||

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

| | | | ||

|- | |- | ||

|''' | |'''AbsoluteTolerance''' (AbsoluteTolerance) | ||

| | | | ||

If merging nearby points (see PointMerging property) and | |||

using absolute tolerance (see ToleranceIsAbsolute property), this | |||

property specifies the tolerance for performing merging in the spatial | |||

units of the input data set. | |||

| | |||

1.0 | |||

| | |||

|- | |||

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

|- | |- | ||

|''' | |'''ConvertLinesToPoints''' (ConvertLinesToPoints) | ||

| | | | ||

If this | If this property is set to 1, degenerate lines (a "line" | ||

whose endpoints are at the same spatial location) will be converted to | |||

points. | |||

| | | | ||

1 | |||

| | | | ||

Accepts boolean values (0 or 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 | |||

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

| | | | ||

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

|} | |} | ||

== | ==Clean Cells to Grid== | ||

This filter merges cells and converts the data set to unstructured grid.Merges degenerate cells. Assumes | |||

the input grid does not contain duplicate points. You may | |||

want to run vtkCleanUnstructuredGrid first to assert it. | |||

If duplicated cells are found they are removed in the | |||

output. The filter also handles the case, where a cell may | |||

contain degenerate nodes (i.e. one and the same node is | |||

referenced by a cell more than once). | |||

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 1,300: | Line 1,398: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies the input to the Clean Cells to | |||

filter. | Grid filter. | ||

| | | | ||

| | | | ||

Accepts input of following types: | Accepts input of following types: | ||

* | * vtkUnstructuredGrid | ||

| | |} | ||

==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''' | |||

| '''Description''' | |||

| '''Default Value(s)''' | |||

| '''Restrictions''' | |||

|- | |- | ||

|''' | |'''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" | |||

|- | |- | ||

|''' | | '''Property''' | ||

| '''Description''' | |||

| '''Default Value(s)''' | |||

| '''Restrictions''' | |||

|- | |||

|'''Input''' (Input) | |||

| | | | ||

Set the input to the Client Server Move Data | |||

filter. | |||

| | | | ||

| | | | ||

|- | |- | ||

|''' | |'''OutputDataType''' (OutputDataType) | ||

| | | | ||

| | | | ||

0 | 0 | ||

| | | | ||

|- | |- | ||

|''' | |'''WholeExtent''' (WholeExtent) | ||

| | | | ||

| | | | ||

0 | 0 -1 0 -1 0 -1 | ||

| | | | ||

|} | |} | ||

== | ==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" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 1,385: | Line 1,496: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies 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 | The dataset must contain a field array () | ||

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

|- | |- | ||

|''' | |'''Clip Type''' (ClipFunction) | ||

| | | | ||

This property | This property specifies the parameters of the clip | ||

function (an implicit plane) used to clip the dataset. | |||

| | | | ||

| | | | ||

The value can be one of the following: | |||

* Plane (implicit_functions) | |||

* Box (implicit_functions) | |||

* Sphere (implicit_functions) | |||

* Cylinder (implicit_functions) | |||

* Scalar (implicit_functions) | |||

|- | |- | ||

|''' | |'''InputBounds''' (InputBounds) | ||

| | | | ||

| | | | ||

| | | | ||

|- | |- | ||

|''' | |'''Scalars''' (SelectInputScalars) | ||

| | | | ||

If clipping with scalars, this property specifies the | |||

name of the scalar array on which to perform the clip | |||

operation. | |||

| | | | ||

| | | | ||

The value | An array of scalars is required.The value must be field array name. | ||

|- | |- | ||

|''' | |'''Value''' (Value) | ||

| | |||

If clipping with scalars, this property sets the scalar | |||

value about which to clip the dataset based on the scalar array chosen. | |||

(See SelectInputScalars.) If clipping with a clip function, this | |||

property specifies an offset from the clip function to use in the | |||

clipping operation. Neither functionality is currently available in | |||

ParaView's user interface. | |||

| | | | ||

0.0 | |||

| | | | ||

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

| | |||

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

Clip a polygonal dataset with a plane to produce closed surfaces | |||

filter | 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,470: | Line 1,607: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies the | This property specifies the dataset on which the Clip | ||

filter. | filter will operate. | ||

| | | | ||

| | | | ||

Accepts input of following types: | Accepts input of following types: | ||

* | * vtkPolyData | ||

The dataset must contain a field array (point) | |||

with 1 component(s). | |||

|- | |- | ||

|''' | |'''Clipping Plane''' (ClippingPlane) | ||

| | | | ||

This property specifies the parameters of the clipping | |||

plane used to clip the polygonal data. | |||

| | | | ||

| | | | ||

The value | The value can be one of the following: | ||

* | * Plane (implicit_functions) | ||

|- | |- | ||

|''' | |'''GenerateFaces''' (GenerateFaces) | ||

| | | | ||

Generate polygonal faces in the output. | |||

| | | | ||

1 | 1 | ||

| | | | ||

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

|- | |- | ||

| ''' | |'''GenerateOutline''' (GenerateOutline) | ||

| | | | ||

Generate clipping outlines in the output wherever an | |||

input face is cut by the clipping plane. | |||

| | | | ||

0 | |||

| | | | ||

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

|- | |- | ||

|''' | |'''Generate Cell Origins''' (ScalarMode) | ||

| | | | ||

Generate (cell) data for coloring purposes such that the | |||

newly generated cells (including capping faces and clipping outlines) | |||

can be distinguished from the input cells. | |||

| | | | ||

0 | |||

| | | | ||

The value(s) is an enumeration of the following: | |||

* | * None (0) | ||

* | * Color (1) | ||

* Label (2) | |||

|- | |- | ||

|''' | |'''InsideOut''' (InsideOut) | ||

| | | | ||

If this flag is turned off, the clipper will return the | |||

portion of the data that lies within the clipping plane. Otherwise, the | |||

clipper will return the portion of the data that lies outside the | |||

clipping plane. | |||

| | | | ||

0 | 0 | ||

| | | | ||

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

|- | |- | ||

|''' | |'''Clipping Tolerance''' (Tolerance) | ||

| | | | ||

Specify the tolerance for creating new points. A small | |||

value might incur degenerate triangles. | |||

| | | | ||

0.000001 | |||

| | | | ||

|- | |- | ||

|''' | |'''Base Color''' (BaseColor) | ||

| | | | ||

Specify the | Specify the color for the faces from the | ||

input. | |||

| | | | ||

0.10 0.10 1.00 | |||

| | | | ||

|- | |- | ||

|''' | |'''Clip Color''' (ClipColor) | ||

| | | | ||

Specifiy the color for the capping faces (generated on | |||

the clipping interface). | |||

| | | | ||

0. | 1.00 0.11 0.10 | ||

| | | | ||

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

|} | |} | ||

== | ==Clip Generic Dataset== | ||

Clip with an implicit plane, sphere or with scalars. Clipping does not reduce the dimensionality of the data set. This output data type of this filter is always an unstructured grid. | |||

The Generic Clip filter cuts away a portion of the input | |||

data set using a plane, a sphere, a box, or a scalar | |||

value. The menu in the Clip Function portion of the | |||

interface allows the user to select which implicit | |||

function to use or whether to clip using a scalar value. | |||

Making this selection loads the appropriate user | |||

interface. For the implicit functions, the appropriate 3D | |||

widget (plane, sphere, or box) is also displayed. The use | |||

of these 3D widgets, including their user interface | |||

components, is discussed in section 7.4. If an implicit | |||

function is selected, the clip filter returns that portion | |||

of the input data set that lies inside the function. If | |||

Scalars is selected, then the user must specify a scalar | |||

array to clip according to. The clip filter will return | |||

the portions of the data set whose value in the selected | |||

Scalars array is larger than the Clip value. Regardless of | |||

the selection from the Clip Function menu, if the Inside | |||

Out option is checked, the opposite portions of the data | |||

set will be returned. This filter operates on all types of | |||

data sets, and it returns unstructured grid data on | |||

output. | |||

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 1,635: | Line 1,735: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

Set the input to the Generic Clip | |||

filter. | |||

| | | | ||

| | | | ||

Accepts input of following types: | Accepts input of following types: | ||

* | * vtkGenericDataSet | ||

The dataset | The dataset must contain a field array (point) | ||

|- | |- | ||

|''' | |'''Clip Type''' (ClipFunction) | ||

| | | | ||

Set the parameters of the clip function. | |||

| | | | ||

| | | | ||

The value can be one of the following: | |||

* Plane (implicit_functions) | |||

* Box (implicit_functions) | |||

* Sphere (implicit_functions) | |||

* Scalar (implicit_functions) | |||

|- | |- | ||

|''' | |'''InputBounds''' (InputBounds) | ||

| | | | ||

| | | | ||

| | | | ||

|- | |- | ||

|''' | |'''Scalars''' (SelectInputScalars) | ||

| | | | ||

If this property | If clipping with scalars, this property specifies the | ||

name of the scalar array on which to perform the clip | |||

operation. | |||

| | | | ||

| | | | ||

An array of scalars is required.The value must be field array name. | |||

|- | |- | ||

|''' | |'''InsideOut''' (InsideOut) | ||

| | | | ||

Choose which portion of the dataset should be clipped | |||

away. | |||

dataset | |||

| | | | ||

0 | 0 | ||

Line 1,699: | Line 1,788: | ||

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

|- | |- | ||

|''' | |'''Value''' (Value) | ||

| | | | ||

If | If clipping with a scalar array, choose the clipping | ||

value. | |||

| | | | ||

0 | 0.0 | ||

| | | | ||

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

|- | |- | ||

|''' | |'''Input''' (Input) | ||

| | | | ||

| | | | ||

| | | | ||

Accepts input of following types: | |||

* | * vtkImageData | ||

The dataset must contain a field array (point) | |||

with 1 component(s). | |||

|- | |||

|'''LookupTable''' (LookupTable) | |||

| | |||

| | |||

| | | | ||

|- | |||

|'''Color By''' (SelectInputScalars) | |||

| | |||

This property specifies the name of the scalar array | |||

from which we will color by. | |||

| | |||

| | |||

An array of scalars is required.The value must be field array name. | |||

|- | |||

|'''RGBA NaN Color''' (NaNColor) | |||

| | |||

| | |||

0 0 0 255 | |||

| | |||

|- | |||

|'''OutputFormat''' (OutputFormat) | |||

| | |||

| | |||

3 | |||

| | |||

value | The value(s) is an enumeration of the following: | ||

* Luminance (1) | |||

* Luminance Alpha (2) | |||

* RGB (3) | |||

* RGBA (4) | |||

|} | |||

==Compute Derivatives== | |||

and | This filter computes derivatives of scalars and vectors. | ||

the | CellDerivatives is a filter that computes derivatives of | ||

scalars and vectors at the center of cells. You can choose | |||

to generate different output including the scalar gradient | |||

(a vector), computed tensor vorticity (a vector), gradient | |||

of input vectors (a tensor), and strain matrix of the | |||

input vectors (a tensor); or you may choose to pass data | |||

through to the output. | |||

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 1,771: | Line 1,884: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

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

* | * vtkDataSet | ||

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

|- | |- | ||

|''' | |'''Scalars''' (SelectInputScalars) | ||

| | | | ||

This property | This property indicates the name of the scalar array to | ||

differentiate. | |||

| | | | ||

| | | | ||

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

|- | |- | ||

|''' | |'''Vectors''' (SelectInputVectors) | ||

| | | | ||

This property | This property indicates the name of the vector array to | ||

differentiate. | |||

| | | | ||

1 | |||

| | | | ||

An array of vectors is required. | |||

|- | |- | ||

|''' | |'''OutputVectorType''' (OutputVectorType) | ||

| | | | ||

This property Controls how the filter works to generate | |||

vector cell data. You can choose to compute the gradient of the input | |||

scalars, or extract the vorticity of the computed vector gradient | |||

tensor. By default, the filter will take the gradient of the input | |||

scalar data. | |||

| | | | ||

1 | 1 | ||

| | | | ||

The value(s) is an enumeration of the following: | |||

* Nothing (0) | |||

* Scalar Gradient (1) | |||

* Vorticity (2) | |||

|- | |- | ||

|''' | |'''OutputTensorType''' (OutputTensorType) | ||

| | | | ||

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

| | | | ||

1 | |||

| | | | ||

The value(s) is an enumeration of the following: | |||

* Nothing (0) | |||

* Vector Gradient (1) | |||

* Strain (2) | |||

* | |||

* | |||

* | |||

|} | |} | ||

== | ==Compute Quartiles== | ||

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

* | * vtkDataObject | ||

|} | |} | ||

== | ==Connectivity== | ||

Mark connected components with integer point attribute array.The Connectivity | |||

filter assigns a region id to connected components of the | |||

input data set. (The region id is assigned as a point | |||

scalar value.) This filter takes any data set type as | |||

input and produces unstructured grid | |||

output. | |||

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 1,880: | Line 1,990: | ||

| '''Restrictions''' | | '''Restrictions''' | ||

|- | |- | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies the input to the Connectivity | |||

filter. | |||

| | | | ||

| | | | ||

Accepts input of following types: | Accepts input of following types: | ||

* | * vtkDataSet | ||

|- | |- | ||

|''' | |'''ExtractionMode''' (ExtractionMode) | ||

| | | | ||

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

* | * Extract Point Seeded Regions (1) | ||

* Extract Cell Seeded Regions (2) | |||

* | * Extract Specified Regions (3) | ||

* | * Extract Largest Region (4) | ||

* | * Extract All Regions (5) | ||

* | * Extract Closes Point Region (6) | ||

* | |||

|- | |- | ||

|''' | |'''ColorRegions''' (ColorRegions) | ||

| | | | ||

Controls the coloring of the connected | |||

regions. | |||

| | | | ||

1 | |||

| | | | ||

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

Line 1,934: | Line 2,027: | ||

|} | |} | ||

== | ==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" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 1,953: | Line 2,052: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

The input to the filter. Arrays from this dataset will | |||

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

* vtkPolyData | |||

* vtkUnstructuredGrid | |||

* vtkTable | |||

* vtkGraph | |||

The dataset must contain a field array () | |||

The | |||

|- | |- | ||

| ''' | |'''ModelInput''' (ModelInput) | ||

| | | | ||

This | A previously-calculated model with which to assess a | ||

separate dataset. This input is optional. | |||

| | | | ||

| | | | ||

Accepts input of following types: | Accepts input of following types: | ||

* | * vtkTable | ||

* vtkMultiBlockDataSet | |||

|- | |- | ||

|''' | |'''AttributeMode''' (AttributeMode) | ||

| | | | ||

Specify which type of field data the arrays will be | |||

drawn from. | |||

| | | | ||

0 | 0 | ||

| | | | ||

The value must be field array name. | |||

|- | |- | ||

|''' | |'''Variables of Interest''' (SelectArrays) | ||

| | | | ||

Choose arrays whose entries will be used to form | |||

observations for statistical analysis. | |||

| | | | ||

| | | | ||

|- | |- | ||

| ''' | |'''Task''' (Task) | ||

| | | | ||

Specify the task to be performed: modeling and/or | |||

assessment. <ol> <li> "Detailed model of input data," | |||

creates a set of output tables containing a calculated statistical | |||

model of the <b>entire</b> input dataset;</li> | |||

<li> "Model a subset of the data," creates an output table (or | |||

tables) summarizing a <b>randomly-chosen subset</b> of the | |||

input dataset;</li> <li> "Assess the data with a model," | |||

adds attributes to the first input dataset using a model provided on | |||

the second input port; and</li> <li> "Model and assess the | |||

same data," is really just operations 2 and 3 above applied to the same | |||

input dataset. The model is first trained using a fraction of the input | |||

data and then the entire dataset is assessed using that | |||

model.</li> </ol> When the task includes creating a model | |||

(i.e., tasks 2, and 4), you may adjust the fraction of the input | |||

dataset used for training. You should avoid using a large fraction of | |||

the input data for training as you will then not be able to detect | |||

overfitting. The <i>Training fraction</i> setting will be | |||

ignored for tasks 1 and 3. | |||

| | | | ||

3 | |||

| | | | ||

The value(s) is an enumeration of the following: | |||

* | * Detailed model of input data (0) | ||

* Model a subset of the data (1) | |||

* Assess the data with a model (2) | |||

* Model and assess the same data (3) | |||

|- | |- | ||

|''' | |'''TrainingFraction''' (TrainingFraction) | ||

| | | | ||

Specify the fraction of values from the input dataset to | |||

be used for model fitting. The exact set of values is chosen at random | |||

from the dataset. | |||

| | | | ||

0 | 0.1 | ||

| | | | ||

|} | |} | ||

== | ==Contour== | ||

Generate isolines or isosurfaces using point scalars.The Contour | |||

filter computes isolines or isosurfaces using a selected | |||

point-centered scalar array. The Contour filter operates | |||

on any type of data set, but the input is required to have | |||

at least one point-centered scalar (single-component) | |||

array. The output of this filter is | |||

polygonal. | |||

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 2,097: | Line 2,158: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies the input to the | This property specifies the input dataset to be used by | ||

filter. | the contour filter. | ||

| | | | ||

| | | | ||

Accepts input of following types: | Accepts input of following types: | ||

* | * vtkDataSet | ||

The dataset must contain a field array (point) | |||

with 1 component(s). | |||

|- | |- | ||

|''' | |'''Contour By''' (SelectInputScalars) | ||

| | | | ||

This property specifies the | This property specifies the name of the scalar array | ||

from which the contour filter will compute isolines and/or | |||

isosurfaces. | |||

| | | | ||

| | | | ||

An array of scalars is required.The value must be field array name. | |||

|- | |- | ||

|''' | |'''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, | If this property is set to 1, a scalar array containing | ||

the dataset or | a gradient value at each point in the isosurface or isoline will be | ||

created by this filter; otherwise an array of gradients will not be | |||

computed. This operation is fairly expensive both in terms of | |||

computation time and memory required, so if the output dataset produced | |||

by the contour filter will be processed by filters that modify the | |||

dataset's topology or geometry, it may be wise to set the value of this | |||

property to 0. Not that if ComputeNormals is set to 1, then gradients | |||

will have to be calculated, but they will only be stored in the output | |||

dataset if ComputeGradients is also set to 1. | |||

| | | | ||

0 | 0 | ||

Line 2,129: | Line 2,212: | ||

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

|- | |- | ||

|''' | |'''ComputeScalars''' (ComputeScalars) | ||

| | |||

If this property is set to 1, an array of scalars | |||

(containing the contour value) will be added to the output dataset. If | |||

set to 0, the output will not contain this array. | |||

| | | | ||

0 | |||

| | | | ||

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

|- | |||

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

|- | |- | ||

|''' | |'''GenerateTriangles''' (GenerateTriangles) | ||

| | | | ||

This parameter controls whether to produce triangles in the output. | |||

Warning: Many filters do not properly handle non-trianglular polygons. | |||

| | | | ||

1 | 1 | ||

| | | | ||

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

|- | |||

|'''Isosurfaces''' (ContourValues) | |||

|- | |||

|''' | |||

| | | | ||

This property specifies the | 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 | 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) | |||

|} | |} | ||

== | ==Contour Generic Dataset== | ||

Generate isolines or isosurfaces using point scalars.The Generic | |||

Contour filter computes isolines or isosurfaces using a | |||

selected point-centered scalar array. The available scalar | |||

the | arrays are listed in the Scalars menu. The scalar range of | ||

the selected array will be displayed. The interface for | |||

value | adding contour values is very similar to the one for | ||

selecting cut offsets (in the Cut filter). To add a single | |||

contour value, select the value from the New Value slider | |||

in the Add value portion of the interface and click the | |||

Add button, or press Enter. To instead add several evenly | |||

the | spaced contours, use the controls in the Generate range of | ||

values section. Select the number of contour values to | |||

generate using the Number of Values slider. The Range | |||

slider controls the interval in which to generate the | |||

contour values. Once the number of values and range have | |||

been selected, click the Generate button. The new values | |||

will be added to the Contour Values list. To delete a | |||

value from the Contour Values list, select the value and | |||

click the Delete button. (If no value is selected, the | |||

last value in the list will be removed.) Clicking the | |||

Delete All button removes all the values in the list. If | |||

no values are in the Contour Values list when Accept is | |||

pressed, the current value of the New Value slider will be | |||

the | used. In addition to selecting contour values, you can | ||

also select additional computations to perform. If any of | |||

Compute Normals, Compute Gradients, or Compute Scalars is | |||

selected, the appropriate computation will be performed, | |||

and a corresponding point-centered array will be added to | |||

the output. The Generic Contour filter operates on a | |||

generic data set, but the input is required to have at | |||

least one point-centered scalar (single-component) array. | |||

are | The output of this filter is polygonal. | ||

{| class="PropertiesTable" border="1" cellpadding="5" | |||

|- | |||

| '''Property''' | |||

| '''Description''' | |||

| '''Default Value(s)''' | |||

point | |||

the | |||

{| class="PropertiesTable" border="1" cellpadding="5" | |||

|- | |||

| '''Property''' | |||

| '''Description''' | |||

| '''Default Value(s)''' | |||

| '''Restrictions''' | | '''Restrictions''' | ||

Line 2,339: | Line 2,321: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

Set the input to the Generic Contour | |||

filter. | |||

| | | | ||

| | | | ||

Accepts input of following types: | Accepts input of following types: | ||

* | * vtkGenericDataSet | ||

The dataset must contain a field array (point) | |||

with 1 component(s). | |||

|- | |- | ||

|''' | |'''Contour By''' (SelectInputScalars) | ||

| | | | ||

This property specifies the | This property specifies the name of the scalar array | ||

from which the contour filter will compute isolines and/or | |||

isosurfaces. | |||

| | | | ||

| | | | ||

An array of scalars is required.The value must be field array name. | |||

|- | |- | ||

|''' | |'''ComputeNormals''' (ComputeNormals) | ||

| | | | ||

Select whether to compute normals. | |||

| | | | ||

1 | |||

| | | | ||

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

|- | |- | ||

|''' | |'''ComputeGradients''' (ComputeGradients) | ||

| | | | ||

Select whether to compute gradients. | |||

| | | | ||

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

|} | |} | ||

== | ==Convert AMR dataset to Multi-block== | ||

Convert AMR to Multiblock | |||

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 2,417: | Line 2,408: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies the input for this | |||

filter. | |||

| | | | ||

| | | | ||

Accepts input of following types: | Accepts input of following types: | ||

* | * vtkOverlappingAMR | ||

|- | |} | ||

|''' | |||

| | ==ConvertSelection== | ||

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

* | * vtkSelection | ||

|- | |- | ||

|''' | |'''OutputType''' (OutputType) | ||

| | | | ||

Set the ContentType for the output. | |||

| | | | ||

5 | |||

| | | | ||

The value | The value(s) is an enumeration of the following: | ||

* SELECTIONS (0) | |||

* GLOBALIDs (1) | |||

* PEDIGREEIDS (2) | |||

* VALUES (3) | |||

* INDICES (4) | |||

* FRUSTUM (5) | |||

* LOCATION (6) | |||

* THRESHOLDS (7) | |||

|- | |- | ||

|''' | |'''ArrayNames''' (ArrayNames) | ||

| | | | ||

| | | | ||

Line 2,462: | Line 2,474: | ||

|- | |- | ||

|''' | |'''MatchAnyValues''' (MatchAnyValues) | ||

| | | | ||

| | | | ||

0 | 0 | ||

| | | | ||

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

|} | |} | ||

== | ==Crop== | ||

Efficiently extract an area/volume of interest from a 2-d image or 3-d volume.The Crop filter | |||

The | extracts an area/volume of interest from a 2D image or a | ||

3D volume by allowing the user to specify the minimum and | |||

maximum extents of each dimension of the data. Both the | |||

input and output of this filter are uniform rectilinear | |||

data. | |||

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 2,540: | Line 2,503: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies the input | This property specifies the input to the Crop | ||

filter. | |||

| | | | ||

| | | | ||

Accepts input of following types: | Accepts input of following types: | ||

* | * vtkImageData | ||

|- | |- | ||

|''' | |'''OutputWholeExtent''' (OutputWholeExtent) | ||

| | | | ||

This property | This property gives the minimum and maximum point index | ||

(extent) in each dimension for the output dataset. | |||

| | | | ||

0 | 0 0 0 0 0 0 | ||

| | | | ||

The value(s) must lie within the structured-extents of the input dataset. | |||

The value | |||

|} | |} | ||

== | ==Curvature== | ||

This filter | 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" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 2,600: | Line 2,540: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies the input to the | This property specifies the input to the Curvature | ||

filter. | |||

| | | | ||

| | | | ||

Accepts input of following types: | Accepts input of following types: | ||

* | * vtkPolyData | ||

|- | |- | ||

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

| | | | ||

0 | |||

| | | | ||

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

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

is | |||

{| 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 | 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: | ||

* | * vtkDataSet | ||

|- | |- | ||

|''' | |'''BoundaryMode''' (BoundaryMode) | ||

| | | | ||

This property determines how cells that lie on processor | |||

boundaries are handled. The "Assign cells uniquely" option assigns each | |||

boundary cell to exactly one process, which is useful for isosurfacing. | |||

Selecting "Duplicate cells" causes the cells on the boundaries to be | |||

copied to each process that shares that boundary. The "Divide cells" | |||

option breaks cells across process boundary lines so that pieces of the | |||

cell lie in different processes. This option is useful for volume | |||

rendering. | |||

| | | | ||

0 | 0 | ||

| | | | ||

The value(s) is an enumeration of the following: | 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 | 0 | ||

Line 2,673: | Line 2,628: | ||

|} | |} | ||

== | ==Decimate== | ||

This filter | Simplify a polygonal model using an adaptive edge collapse algorithm. This filter works with triangles only. | ||

The Decimate filter reduces the number of triangles in a | |||

polygonal data set. Because this filter only operates on | |||

triangles, first run the Triangulate filter on a dataset | |||

that contains polygons other than | |||

triangles. | |||

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 2,688: | Line 2,647: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies the input to the | 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: | ||

* | * vtkPolyData | ||

|- | |- | ||

|''' | |'''TargetReduction''' (TargetReduction) | ||

| | | | ||

This property | This property specifies the desired reduction in the | ||

total number of polygons in the output dataset. For example, if the | |||

TargetReduction value is 0.9, the Decimate filter will attempt to | |||

produce an output dataset that is 10% the size of the | |||

input.) | |||

| | | | ||

0.9 | |||

| | | | ||

|- | |- | ||

|''' | |'''PreserveTopology''' (PreserveTopology) | ||

| | | | ||

If this property is set to 1, decimation will not split | |||

the dataset or produce holes, but it may keep the filter from reaching | |||

the reduction target. If it is set to 0, better reduction can occur | |||

(reaching the reduction target), but holes in the model may be | |||

produced. | |||

| | | | ||

0 | |||

| | | | ||

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

|- | |- | ||

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

| | | | ||

If this property is set to 1, then vertices on the | |||

boundary of the dataset can be removed. Setting the value of this | |||

property to 0 preserves the boundary of the dataset, but it may cause | |||

the filter not to reach its reduction target. | |||

| | | | ||

1 | |||

| | | | ||

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

Line 2,727: | Line 2,704: | ||

|} | |} | ||

== | ==Delaunay 2D== | ||

Create a | 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 | |||

option of | dataset containing a triangle mesh. The 2D Delaunay | ||

triangulation is defined as the triangulation that | |||

satisfies the Delaunay criterion for n-dimensional | |||

simplexes (in this case n=2 and the simplexes are | |||

triangles). This criterion states that a circumsphere of | |||

each simplex in a triangulation contains only the n+1 | |||

defining points of the simplex. In two dimensions, this | |||

translates into an optimal triangulation. That is, the | |||

maximum interior angle of any triangle is less than or | |||

equal to that of any possible triangulation. Delaunay | |||

triangulations are used to build topological structures | |||

from unorganized (or unstructured) points. The input to | |||

this filter is a list of points specified in 3D, even | |||

though the triangulation is 2D. Thus the triangulation is | |||

constructed in the x-y plane, and the z coordinate is | |||

ignored (although carried through to the output). You can | |||

use the option ProjectionPlaneMode in order to compute the | |||

best-fitting plane to the set of points, project the | |||

points and that plane and then perform the triangulation | |||

using their projected positions and then use it as the | |||

plane in which the triangulation is performed. The | |||

Delaunay triangulation can be numerically sensitive in | |||

some cases. To prevent problems, try to avoid injecting | |||

points that will result in triangles with bad aspect | |||

ratios (1000:1 or greater). In practice this means | |||

inserting points that are "widely dispersed", and enables | |||

smooth transition of triangle sizes throughout the mesh. | |||

(You may even want to add extra points to create a better | |||

point distribution.) If numerical problems are present, | |||

you will see a warning message to this effect at the end | |||

of the triangulation process. Warning: Points arranged on | |||

a regular lattice (termed degenerate cases) can be | |||

triangulated in more than one way (at least according to | |||

the Delaunay criterion). The choice of triangulation (as | |||

implemented by this algorithm) depends on the order of the | |||

input points. The first three points will form a triangle; | |||

other degenerate points will not break this triangle. | |||

Points that are coincident (or nearly so) may be discarded | |||

by the algorithm. This is because the Delaunay | |||

triangulation requires unique input points. The output of | |||

the Delaunay triangulation is supposedly a convex hull. In | |||

certain cases this implementation may not generate the | |||

convex hull. | |||

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 2,748: | Line 2,765: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies the input to the | This property specifies the input dataset to the | ||

Delaunay 2D filter. | |||

| | | | ||

| | | | ||

Accepts input of following types: | Accepts input of following types: | ||

* | * vtkPointSet | ||

|- | |- | ||

|''' | |'''ProjectionPlaneMode''' (ProjectionPlaneMode) | ||

| | | | ||

This property | This property determines type of projection plane to use | ||

in performing the triangulation. | |||

| | | | ||

0 | |||

| | | | ||

The value | The value(s) is an enumeration of the following: | ||

* | * XY Plane (0) | ||

* Best-Fitting Plane (2) | |||

* Plane ( | |||

|- | |- | ||

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

| | | | ||

|- | |||

|'''Tolerance''' (Tolerance) | |||

| | | | ||

This property specifies a tolerance to control | |||

discarding of closely spaced points. This tolerance is specified as a | |||

fraction of the diagonal length of the bounding box of the | |||

points. | |||

| | | | ||

0.00001 | |||

| | | | ||

|- | |||

|'''Offset''' (Offset) | |||

| | | | ||

This property is a multiplier to control the size of the | |||

initial, bounding Delaunay triangulation. | |||

| | | | ||

1.0 | |||

| | | | ||

|- | |- | ||

|''' | |'''BoundingTriangulation''' (BoundingTriangulation) | ||

| | | | ||

If this property is set to 1, bounding triangulation | |||

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

|} | |} | ||

== | ==Delaunay 3D== | ||

Create a 3D Delaunay triangulation of input points. It expects a vtkPointSet as input and produces vtkUnstructuredGrid as output.Delaunay3D is a filter that constructs | |||

a 3D Delaunay triangulation from a list of input points. These points may be | |||

represented by any dataset of type vtkPointSet and subclasses. The output of | |||

the filter is an unstructured grid dataset. Usually the output is a tetrahedral | |||

you | mesh, but if a non-zero alpha distance value is specified (called the "alpha" | ||

value), then only tetrahedra, triangles, edges, and vertices lying within the | |||

alpha radius are output. In other words, non-zero alpha values may result in | |||

arbitrary combinations of tetrahedra, triangles, lines, and vertices. (The | |||

notion of alpha value is derived from Edelsbrunner's work on "alpha shapes".) | |||

The 3D Delaunay triangulation is defined as the triangulation that satisfies | |||

the Delaunay criterion for n-dimensional simplexes (in this case n=3 and the | |||

simplexes are tetrahedra). This criterion states that a circumsphere of each | |||

simplex in a triangulation contains only the n+1 defining points of the | |||

simplex. (See text for more information.) While in two dimensions this | |||

translates into an "optimal" triangulation, this is not true in 3D, since a | |||

measurement for optimality in 3D is not agreed on. Delaunay triangulations are | |||

used to build topological structures from unorganized (or unstructured) points. | |||

The input to this filter is a list of points specified in 3D. (If you wish to | |||

create 2D triangulations see Delaunay2D.) The output is an unstructured grid. | |||

The Delaunay triangulation can be numerically sensitive. To prevent problems, | |||

try to avoid injecting points that will result in triangles with bad aspect | |||

ratios (1000:1 or greater). In practice this means inserting points that are | |||

"widely dispersed", and enables smooth transition of triangle sizes throughout | |||

the mesh. (You may even want to add extra points to create a better point | |||

distribution.) If numerical problems are present, you will see a warning | |||

message to this effect at the end of the triangulation process. Warning: Points | |||

arranged on a regular lattice (termed degenerate cases) can be triangulated in | |||

more than one way (at least according to the Delaunay criterion). The choice of | |||

triangulation (as implemented by this algorithm) depends on the order of the | |||

input points. The first four points will form a tetrahedron; other degenerate | |||

points (relative to this initial tetrahedron) will not break it. Points that | |||

are coincident (or nearly so) may be discarded by the algorithm. This is | |||

because the Delaunay triangulation requires unique input points. You can | |||

control the definition of coincidence with the "Tolerance" instance variable. | |||

The output of the Delaunay triangulation is supposedly a convex hull. In | |||

certain cases this implementation may not generate the convex hull. This | |||

behavior can be controlled by the Offset instance variable. Offset is a | |||

multiplier used to control the size of the initial triangulation. The larger | |||

the offset value, the more likely you will generate a convex hull; and the more | |||

likely you are to see numerical problems. The implementation of this algorithm | |||

varies from the 2D Delaunay algorithm (i.e., Delaunay2D) in an important way. | |||

When points are injected into the triangulation, the search for the enclosing | |||

tetrahedron is quite different. In the 3D case, the closest previously inserted | |||

point point is found, and then the connected tetrahedra are searched to find | |||

the containing one. (In 2D, a "walk" towards the enclosing triangle is | |||

performed.) If the triangulation is Delaunay, then an enclosing tetrahedron | |||

will be found. However, in degenerate cases an enclosing tetrahedron may not be | |||

found and the point will be rejected. | |||

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 2,837: | Line 2,889: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies the input to the | This property specifies the input dataset to the | ||

filter. | Delaunay 3D filter. | ||

| | | | ||

| | | | ||

Accepts input of following types: | Accepts input of following types: | ||

* | * vtkPointSet | ||

|- | |- | ||

|''' | |'''Alpha''' (Alpha) | ||

| | |||

This property specifies the alpha (or distance) value to | |||

control the output of this filter. For a non-zero alpha value, only | |||

edges, faces, or tetra contained within the circumsphere (of radius | |||

alpha) will be output. Otherwise, only tetrahedra will be | |||

output. | |||

| | | | ||

0.0 | |||

| | | | ||

|- | |||

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

| | | | ||

|- | |||

|'''Offset''' (Offset) | |||

| | |||

This property specifies a multiplier to control the size | |||

of the initial, bounding Delaunay triangulation. | |||

| | |||

2.5 | |||

| | |||

|- | |- | ||

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

|- | |- | ||

|''' | |'''AlphaTris''' (AlphaTris) | ||

| | | | ||

This | This boolean controls whether triangles which satisfy | ||

the alpha criterion output when alpha is non-zero. | |||

| | | | ||

1 | 1 | ||

| | | | ||

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

|- | |- | ||

|''' | |'''AlphaLines''' (AlphaLines) | ||

| | | | ||

This | This boolean controls whether lines which satisfy the | ||

alpha criterion output when alpha is non-zero. | |||

| | | | ||

0 | 0 | ||

Line 2,890: | Line 2,967: | ||

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

|- | |- | ||

|''' | |'''AlphaVerts''' (AlphaVerts) | ||

| | | | ||

This | This boolean controls whether vertices which satisfy the | ||

are | alpha criterion are output when alpha is non-zero. | ||

| | | | ||

0 | 0 | ||

Line 2,901: | Line 2,978: | ||

|} | |} | ||

== | ==Descriptive Statistics== | ||

Compute a statistical model of a dataset and/or assess the dataset with a statistical model. | |||

filter | This filter either computes a statistical model of a dataset or takes | ||

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

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

| | | | ||

The input to the filter. Arrays from this dataset will | |||

be used for computing statistics and/or assessed by a statistical | |||

model. | |||

| | | | ||

| | | | ||

Accepts input of following types: | Accepts input of following types: | ||

* | * vtkImageData | ||

* vtkStructuredGrid | |||

* vtkPolyData | |||

* vtkUnstructuredGrid | |||

* vtkTable | |||

* vtkGraph | |||

The dataset must contain a field array () | |||

|- | |- | ||

| ''' | |'''ModelInput''' (ModelInput) | ||

| | | | ||

A previously-calculated model with which to assess a | |||

separate dataset. This input is optional. | |||

| | | | ||

| | | | ||

Accepts input of following types: | Accepts input of following types: | ||

* | * vtkTable | ||

* vtkMultiBlockDataSet | |||

|- | |- | ||

|''' | |'''AttributeMode''' (AttributeMode) | ||

| | |||

Specify which type of field data the arrays will be | |||

drawn from. | |||

| | |||

0 | |||

| | | | ||

The value must be field array name. | |||

|- | |||

|'''Variables of Interest''' (SelectArrays) | |||

| | | | ||

Choose arrays whose entries will be used to form | |||

observations for statistical analysis. | |||

| | | | ||

| | | | ||

|- | |- | ||

| ''' | |'''Task''' (Task) | ||

| | | | ||

| | Specify the task to be performed: modeling and/or | ||

assessment. <ol> <li> "Detailed model of input data," | |||

creates a set of output tables containing a calculated statistical | |||

model of the <b>entire</b> input dataset;</li> | |||

<li> "Model a subset of the data," creates an output table (or | |||

tables) summarizing a <b>randomly-chosen subset</b> of the | |||

input dataset;</li> <li> "Assess the data with a model," | |||

adds attributes to the first input dataset using a model provided on | |||

the second input port; and</li> <li> "Model and assess the | |||

same data," is really just operations 2 and 3 above applied to the same | |||

input dataset. The model is first trained using a fraction of the input | |||

data and then the entire dataset is assessed using that | |||

model.</li> </ol> When the task includes creating a model | |||

(i.e., tasks 2, and 4), you may adjust the fraction of the input | |||

dataset used for training. You should avoid using a large fraction of | |||

the input data for training as you will then not be able to detect | |||

overfitting. The <i>Training fraction</i> setting will be | |||

ignored for tasks 1 and 3. | |||

| | |||

3 | |||

| | |||

The value(s) is an enumeration of the following: | |||

* Detailed model of input data (0) | |||

* Model a subset of the data (1) | |||

* Assess the data with a model (2) | |||

* Model and assess the same data (3) | |||

|- | |- | ||

|''' | |'''TrainingFraction''' (TrainingFraction) | ||

| | |||

Specify the fraction of values from the input dataset to | |||

be used for model fitting. The exact set of values is chosen at random | |||

from the dataset. | |||

| | | | ||

0.1 | |||

| | | | ||

|- | |- | ||

|''' | |'''Deviations should be''' (SignedDeviations) | ||

| | | | ||

Should the assessed values be signed deviations or | |||

unsigned? | |||

| | | | ||

0 | |||

| | | | ||

The value(s) is an enumeration of the following: | |||

* Unsigned (0) | |||

* Signed (1) | |||

|} | |} | ||

== | ==Elevation== | ||

Create point attribute array by projecting points onto an elevation vector. | |||

filter | The Elevation filter generates point scalar values for an | ||

The | input dataset along a specified direction vector. The | ||

Input menu allows the user to select the data set to which | |||

this filter will be applied. Use the Scalar range entry | |||

boxes to specify the minimum and maximum scalar value to | |||

be generated. The Low Point and High Point define a line | |||

onto which each point of the data set is projected. The | |||

minimum scalar value is associated with the Low Point, and | |||

the maximum scalar value is associated with the High | |||

Point. The scalar value for each point in the data set is | |||

determined by the location along the line to which that | |||

point projects. | |||

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 3,016: | Line 3,126: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies the input | This property specifies the input dataset to the | ||

Elevation filter. | |||

| | | | ||

Line 3,023: | Line 3,133: | ||

Accepts input of following types: | Accepts input of following types: | ||

* vtkDataSet | * vtkDataSet | ||

|- | |- | ||

|''' | |'''ScalarRange''' (ScalarRange) | ||

| | |||

This property determines the range into which scalars | |||

will be mapped. | |||

| | | | ||

0 1 | |||

| | | | ||

|- | |- | ||

|''' | |'''Low Point''' (LowPoint) | ||

| | | | ||

This property defines one end of the direction vector | |||

(small scalar values). | |||

| | | | ||

0 | 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 0 1 | ||

| | | | ||

The value must lie within the bounding box of the dataset. | |||

It will default to the max in each dimension. | |||

|} | |} | ||

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

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 3,076: | Line 3,188: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

Set the input of the filter. | |||

| | | | ||

| | | | ||

Accepts input of following types: | Accepts input of following types: | ||

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

|- | |- | ||

|''' | |'''FileName''' (FileName) | ||

| | | | ||

Annotation of file name. | |||

| | | | ||

| | | | ||

|} | |} | ||

==Extract | ==Extract AMR Blocks== | ||

This filter extracts a list of datasets from hierarchical datasets.This filter extracts a list | |||

of datasets from hierarchical datasets. | |||

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 3,114: | Line 3,260: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies the input to the Extract | This property specifies the input to the Extract | ||

filter. | Datasets filter. | ||

| | | | ||

| | | | ||

Accepts input of following types: | Accepts input of following types: | ||

* | * vtkUniformGridAMR | ||

|- | |- | ||

|''' | |'''SelectedDataSets''' (SelectedDataSets) | ||

| | | | ||

This property | This property provides a list of datasets to | ||

extract. | |||

| | | | ||

| | | | ||

|} | |} | ||

==Extract | ==Extract Attributes== | ||

Extract a | Extract attribute data as a table.This is a | ||

filter that produces a vtkTable from the chosen attribute | |||

in the input dataobject. This filter can accept composite | |||

datasets. If the input is a composite dataset, the output | |||

is a multiblock with vtkTable leaves. | |||

{| class="PropertiesTable" border="1" cellpadding="5" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 3,198: | Line 3,297: | ||

|'''Input''' (Input) | |'''Input''' (Input) | ||

| | | | ||

This property specifies the input | 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: | ||

* | * vtkDataObject | ||

|- | |- | ||

|''' | |'''FieldAssociation''' (FieldAssociation) | ||

| | |||

Select the attribute data to pass. | |||

| | | | ||

0 | |||

| | | | ||