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

From KitwarePublic

< ParaView

Jump to navigationJump to search
Line 1: | Line 1: | ||

==AMR Contour== | ==AMR Contour== | ||

Line 13: | Line 14: | ||

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

| | | | ||

This property specifies the input of the filter. | This property specifies the input of the | ||

filter. | |||

| | | | ||

Line 26: | Line 28: | ||

|'''SelectMaterialArrays''' (SelectMaterialArrays) | |'''SelectMaterialArrays''' (SelectMaterialArrays) | ||

| | | | ||

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

contour filter will compute contour cells. | |||

| | | | ||

Line 37: | Line 37: | ||

|'''Volume Fraction Value''' (VolumeFractionSurfaceValue) | |'''Volume Fraction Value''' (VolumeFractionSurfaceValue) | ||

| | | | ||

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

the isosurface. | |||

| | | | ||

0.1 | 0.1 | ||

Line 47: | Line 46: | ||

|'''Capping''' (Capping) | |'''Capping''' (Capping) | ||

| | | | ||

If this property is on, the the boundary of the data set | |||

is capped. | |||

| | | | ||

1 | 1 | ||

Line 57: | Line 55: | ||

|'''DegenerateCells''' (DegenerateCells) | |'''DegenerateCells''' (DegenerateCells) | ||

| | | | ||

If this property is on, a transition mesh between levels | |||

is created. | |||

| | | | ||

1 | 1 | ||

Line 67: | Line 64: | ||

|'''MultiprocessCommunication''' (MultiprocessCommunication) | |'''MultiprocessCommunication''' (MultiprocessCommunication) | ||

| | | | ||

If this property is off, each process executes | |||

independantly. | |||

| | | | ||

1 | 1 | ||

Line 77: | Line 73: | ||

|'''SkipGhostCopy''' (SkipGhostCopy) | |'''SkipGhostCopy''' (SkipGhostCopy) | ||

| | | | ||

A simple test to see if ghost values are already set | |||

properly. | |||

| | | | ||

1 | 1 | ||

Line 87: | Line 82: | ||

|'''Triangulate''' (Triangulate) | |'''Triangulate''' (Triangulate) | ||

| | | | ||

Use triangles instead of quads on capping | |||

surfaces. | |||

| | | | ||

1 | 1 | ||

Line 97: | Line 91: | ||

|'''MergePoints''' (MergePoints) | |'''MergePoints''' (MergePoints) | ||

| | | | ||

Use more memory to merge points on the boundaries of | |||

blocks. | |||

| | | | ||

1 | 1 | ||

Line 107: | Line 100: | ||

|} | |} | ||

==AMR | ==AMR CutPlane== | ||

Planar Cut of an AMR grid datasetThis filter | |||

creates a cut-plane of the | |||

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

Line 121: | Line 115: | ||

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

| | | | ||

This property specifies the input | This property specifies the input for this | ||

filter. | |||

| | | | ||

| | | | ||

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

* | * vtkOverlappingAMR | ||

|- | |- | ||

|''' | |'''UseNativeCutter''' (UseNativeCutter) | ||

| | | | ||

This property specifies whether the ParaView's generic | |||

dataset cutter is used instead of the specialized AMR | |||

cutter. | |||

| | | | ||

0 | |||

| | | | ||

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

|- | |- | ||

|''' | |'''LevelOfResolution''' (LevelOfResolution) | ||

| | | | ||

Set maximum slice resolution. | |||

| | | | ||

0 | 0 | ||

| | | | ||

|- | |- | ||

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

| | | | ||

| | | | ||

0.5 0.5 0.5 | |||

| | | | ||

|- | |- | ||

|''' | |'''Normal''' (Normal) | ||

| | | | ||

| | | | ||

0 0 1 | |||

| | | | ||

|} | |} | ||

== | ==AMR Dual Clip== | ||

Clip with scalars. Tetrahedra. | |||

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

Line 201: | Line 173: | ||

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

| | | | ||

This property specifies the input of the | |||

filter. | |||

| | | | ||

| | | | ||

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

* | * vtkCompositeDataSet | ||

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

with 1 component(s). | |||

|- | |- | ||

|''' | |'''SelectMaterialArrays''' (SelectMaterialArrays) | ||

| | |||

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

clip filter will compute clipped cells. | |||

| | | | ||

| | | | ||

An array of scalars is required. | |||

|- | |- | ||

| ''' | |'''Volume Fraction Value''' (VolumeFractionSurfaceValue) | ||

| | | | ||

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

the isosurface. | |||

| | | | ||

0.1 | |||

| | | | ||

|- | |- | ||

|''' | |'''InternalDecimation''' (InternalDecimation) | ||

| | | | ||

If this property is on, internal tetrahedra are | |||

decimation | |||

| | | | ||

1 | |||

| | | | ||

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

|- | |- | ||

|''' | |'''MultiprocessCommunication''' (MultiprocessCommunication) | ||

| | | | ||

If this property is off, each process executes | |||

independantly. | |||

| | | | ||

1 | |||

| | | | ||

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

|- | |- | ||

|''' | |'''MergePoints''' (MergePoints) | ||

| | | | ||

Use more memory to merge points on the boundaries of | |||

blocks. | |||

| | | | ||

1 | 1 | ||

| | | | ||

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

|} | |} | ||

== | ==All to N== | ||

Redistribute data to a subset of available processes.The All to N filter | |||

is available when ParaView is run in parallel. It | |||

redistributes the data so that it is located on the number | |||

of processes specified in the Number of Processes entry | |||

box. It also does load-balancing of the data among these | |||

processes. This filter operates on polygonal data and | |||

produces polygonal output. | |||

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

Line 294: | Line 252: | ||

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

| | | | ||

Set the input to the All to N filter. | |||

| | | | ||

| | | | ||

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

* | * vtkPolyData | ||

|- | |||

|'''Number of Processes''' (NumberOfProcesses) | |||

| | |||

Set the number of processes across which to split the | |||

input data. | |||

| | |||

1 | |||

| | |||

|} | |} | ||

== | ==Annotate Global Data== | ||

Line 321: | Line 284: | ||

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

| | | | ||

Set the input of the filter. | |||

| | | | ||

Line 329: | Line 290: | ||

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

* vtkDataSet | * vtkDataSet | ||

The dataset much 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: | |||

| | |||

|} | |} | ||

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

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

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

annotation. | |||

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

Line 347: | Line 330: | ||

|- | |- | ||

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

| | |||

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

| | |||

|} | |} | ||

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

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

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

sets with the same geometry and merges their point and | |||

cell attributes to produce a single output containing all | |||

the point and cell attributes of the inputs. Any inputs | |||

without the same number of points and cells as the first | |||

input are ignored. The input data sets must already be | |||

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

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

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

data sets. | |||

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

Line 375: | Line 392: | ||

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

| | | | ||

This property specifies the input to the Append | |||

Attributes filter. | |||

| | | | ||

| | | | ||

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

* | * 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 402: | Line 425: | ||

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

| | | | ||

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

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

| | | | ||

| | | | ||

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

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

Line 427: | Line 453: | ||

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

| | | | ||

Set the input to the Append Geometry | |||

filter. | |||

| | | | ||

| | | | ||

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

* | * vtkPolyData | ||

|} | |} | ||

== | ==Balance== | ||

Balance data among available processes.The Balance filter is | |||

available when ParaView is run in parallel. It does | |||

load-balancing so that all processes have the same number | |||

of cells. It operates on polygonal data sets and produces | |||

polygonal output. | |||

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

Line 456: | Line 480: | ||

|- | |- | ||

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

| | |||

Set the input to the Balance filter. | |||

| | | | ||

| | | | ||

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

|- | |- | ||

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

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

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

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

|- | |||

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

| | | | ||

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

filter. | |||

| | | | ||

| | | | ||

Accepts input of following types: | |||

* vtkMultiBlockDataSet | |||

|} | |} | ||

== | ==CTH Surface== | ||

Not finished yet. | |||

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

Line 536: | Line 530: | ||

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

| | | | ||

This property specifies the input of the | |||

filter. | |||

| | | | ||

| | | | ||

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

| | | | ||

Line 565: | Line 566: | ||

|- | |- | ||

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

| | | | ||

| | | | ||

0 | 0.0 | ||

| | | | ||

|- | |- | ||

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

| | | | ||

Toggle whether the caching is enabled. | |||

| | | | ||

1 | 1 | ||

| | | | ||

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 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 626: | Line 660: | ||

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

| | | | ||

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

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

this dataset's arrays. | |||

| | | | ||

Line 634: | Line 668: | ||

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

* vtkDataSet | * vtkDataSet | ||

The dataset much 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 | |||

The | results of this computation should be used as point coordinates or as a | ||

new array. | |||

| | |||

0 | |||

| | |||

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

|- | |- | ||

| ''' | |'''ResultArrayName''' (ResultArrayName) | ||

| | | | ||

| | This property contains the name for the output array | ||

| | containing the result of this computation. | ||

| | |||

Result | |||

| | |||

|- | |- | ||

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

| | | | ||

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

new array. | |||

| | | | ||

| | | | ||

|- | |- | ||

|''' | |'''Replace Invalid Results''' (ReplaceInvalidValues) | ||

| | | | ||

This property determines whether invalid values in the | |||

computation will be replaced with a specific value. (See the | |||

ReplacementValue property.) | |||

| | | | ||

1 | |||

| | | | ||

Accepts boolean values (0 or 1). | 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.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" | {| class="PropertiesTable" border="1" cellpadding="5" | ||

Line 712: | Line 757: | ||

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

| | | | ||

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

filter. | |||

| | | | ||

| | | | ||

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

* | * 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). | 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 much contain a field array (cell) | |||

|- | |- | ||

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

| | | | ||

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 761: | Line 815: | ||

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

|- | |- | ||

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

| | | | ||

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

| | | | ||

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

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

|- | |- | ||

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

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

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

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

|- | |||

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

| | | | ||

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

| | | | ||

| | |||

Accepts input of following types: | |||

* 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 791: | Line 870: | ||

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

|- | |- | ||

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

| | |||

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

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

property specifies the tolerance for performing merging as a fraction | |||

of the length of the diagonal of the bounding box of the input data | |||

set. | |||

| | |||

0.0 | |||

| | | | ||

|- | |||

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

| | |||

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

| | |||

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

|- | |||

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

| | |||

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

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

points. | |||

| | |||

1 | |||

| | |||

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

|- | |||

|'''ConvertPolysToLines''' (ConvertPolysToLines) | |||

| | |||

If this property is set to 1, degenerate polygons (a | |||

"polygon" with only two distinct point coordinates) will be converted | |||

to lines. | |||

| | |||

1 | |||

| | |||

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

|- | |||

|'''ConvertStripsToPolys''' (ConvertStripsToPolys) | |||

| | |||

If this property is set to 1, degenerate triangle strips | |||

(a triangle "strip" containing only one triangle) will be converted to | |||

triangles. | |||

| | |||

1 | |||

| | |||

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

|- | |||

|'''PointMerging''' (PointMerging) | |||

| | |||

If this property is set to 1, then points will be merged | |||

if they are within the specified Tolerance or AbsoluteTolerance (see | |||

the Tolerance and AbsoluteTolerance propertys), depending on the value | |||

of the ToleranceIsAbsolute property. (See the ToleranceIsAbsolute | |||

property.) If this property is set to 0, points will not be | |||

merged. | |||

| | | | ||

1 | 1 | ||

Line 805: | Line 950: | ||

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

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

Merges degenerate cells. Assumes the input grid does not contain duplicate | the input grid does not contain duplicate points. You may | ||

points. You may want to run vtkCleanUnstructuredGrid first to assert it. If | want to run vtkCleanUnstructuredGrid first to assert it. | ||

duplicated cells are found they are removed in the output. The filter also | If duplicated cells are found they are removed in the | ||

handles the case, where a cell may contain degenerate nodes (i.e. one and | output. The filter also handles the case, where a cell may | ||

the same node is referenced by a cell more than once). | 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 823: | Line 968: | ||

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

| | | | ||

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

Grid filter. | |||

| | | | ||

Line 836: | Line 980: | ||

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

This filter merges points and converts the data set to unstructured grid. | This filter merges points and converts the data set to unstructured grid.The Clean to Grid filter merges | ||

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

Line 850: | Line 999: | ||

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

| | | | ||

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

filter. | |||

| | | | ||

Line 875: | Line 1,023: | ||

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

| | | | ||

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

filter. | |||

| | | | ||

Line 903: | Line 1,050: | ||

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

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. | 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 917: | Line 1,066: | ||

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

| | | | ||

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

filter will operate. | |||

| | | | ||

Line 932: | Line 1,080: | ||

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

| | | | ||

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

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

| | | | ||

Line 958: | Line 1,105: | ||

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

| | | | ||

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

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

operation. | |||

| | | | ||

Line 968: | Line 1,115: | ||

|'''Value''' (Value) | |'''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 | 0.0 | ||

Line 978: | Line 1,128: | ||

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

| | | | ||

If this property is set to 0, the clip filter will | |||

return that portion of the dataset that lies within the clip function. | |||

If set to 1, the portions of the dataset that lie outside the clip | |||

function will be returned instead. | |||

| | | | ||

0 | 0 | ||

Line 988: | Line 1,139: | ||

|'''UseValueAsOffset''' (UseValueAsOffset) | |'''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 | 0 | ||

Line 1,001: | Line 1,162: | ||

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

This clip filter cuts away a portion of the input polygonal dataset using a plane to generate a new polygonal dataset. | 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,014: | Line 1,175: | ||

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

| | | | ||

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

filter will operate. | |||

| | | | ||

Line 1,029: | Line 1,189: | ||

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

| | | | ||

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

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

| | | | ||

Line 1,041: | Line 1,200: | ||

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

| | | | ||

Generate polygonal faces in the output. | |||

| | | | ||

1 | 1 | ||

Line 1,051: | Line 1,208: | ||

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

| | | | ||

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

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

| | | | ||

0 | 0 | ||

Line 1,061: | Line 1,217: | ||

|'''Generate Cell Origins''' (GenerateColorScalars) | |'''Generate Cell Origins''' (GenerateColorScalars) | ||

| | | | ||

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

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

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

| | | | ||

0 | 0 | ||

Line 1,071: | Line 1,227: | ||

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

Line 1,081: | Line 1,238: | ||

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

| | | | ||

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

value might incur degenerate triangles. | |||

| | | | ||

0.000001 | 0.000001 | ||

Line 1,091: | Line 1,247: | ||

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

| | | | ||

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

input. | |||

| | | | ||

0.10 0.10 1.00 | 0.10 0.10 1.00 | ||

Line 1,101: | Line 1,256: | ||

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

| | | | ||

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

the clipping interface). | |||

| | | | ||

1.00 0.11 0.10 | 1.00 0.11 0.10 | ||

Line 1,114: | Line 1,268: | ||

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. | 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. | The Generic Clip filter cuts away a portion of the input | ||

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. | data set using a plane, a sphere, a box, or a scalar | ||

This filter operates on all types of data sets, and it returns unstructured grid data on output. | 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,129: | Line 1,300: | ||

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

| | | | ||

Set the input to the Generic Clip | |||

filter. | |||

| | | | ||

Line 1,142: | Line 1,312: | ||

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

| | | | ||

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

| | | | ||

Line 1,168: | Line 1,336: | ||

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

| | | | ||

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

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

operation. | |||

| | | | ||

Line 1,178: | Line 1,346: | ||

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

| | | | ||

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

away. | |||

| | | | ||

0 | 0 | ||

Line 1,188: | Line 1,355: | ||

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

| | | | ||

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

value. | |||

| | | | ||

0.0 | 0.0 | ||

Line 1,201: | Line 1,367: | ||

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

CellDerivatives is a filter that computes derivatives of scalars and vectors at the center of cells. You can choose to generate different output including the scalar gradient (a vector), computed tensor vorticity (a vector), gradient of input vectors (a tensor), and strain matrix of the input vectors (a tensor); or you may choose to pass data through to the output. | 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,214: | Line 1,385: | ||

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

| | | | ||

This property specifies the input to the | |||

filter. | |||

| | | | ||

Line 1,233: | Line 1,403: | ||

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

| | | | ||

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

differentiate. | |||

| | | | ||

Line 1,243: | Line 1,412: | ||

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

| | | | ||

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

differentiate. | |||

| | | | ||

1 | 1 | ||

Line 1,253: | Line 1,421: | ||

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

| | | | ||

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

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

Line 1,266: | Line 1,436: | ||

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

| | | | ||

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

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. | tensor cell data. You can choose to compute the gradient of the input | ||

vectors, or compute the strain tensor of the vector gradient tensor. By | |||

default, the filter will take the gradient of the vector data to | |||

construct a tensor. | |||

| | | | ||

1 | 1 | ||

Line 1,281: | Line 1,453: | ||

==Connectivity== | ==Connectivity== | ||

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

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. | 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,295: | Line 1,470: | ||

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

| | | | ||

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

filter. | |||

| | | | ||

Line 1,306: | Line 1,480: | ||

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

| | | | ||

Controls the extraction of connected | |||

surfaces. | |||

| | | | ||

5 | 5 | ||

Line 1,322: | Line 1,495: | ||

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

| | | | ||

Controls the coloring of the connected | |||

regions. | |||

| | | | ||

1 | 1 | ||

Line 1,335: | Line 1,507: | ||

Compute a statistical model of a dataset and/or assess the dataset with a statistical model. | 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 either computes a statistical model of a dataset or takes | ||

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> | 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 observing both variables simultaneously; | ||

<li> the probability of each variable conditioned on the other (the two values need not be identical); and | <li> the probability of each variable conditioned on the other (the | ||

<li> the pointwise mutual information (PMI). </ul> | two values need not be identical); and <li> the pointwise mutual | ||

Finally, the summary statistics include the information entropy of the observations. | 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,353: | Line 1,529: | ||

|'''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,371: | Line 1,547: | ||

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

| | | | ||

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

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

| | | | ||

Line 1,383: | Line 1,558: | ||

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

| | | | ||

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

drawn from. | |||

| | | | ||

0 | 0 | ||

Line 1,393: | Line 1,567: | ||

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

| | | | ||

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

observations for statistical analysis. | |||

| | |||

| | |||

| | | | ||

Line 1,403: | Line 1,576: | ||

|'''Task''' (Task) | |'''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 | 3 | ||

Line 1,423: | Line 1,605: | ||

|'''TrainingFraction''' (TrainingFraction) | |'''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 | 0.1 | ||

Line 1,435: | Line 1,617: | ||

==Contour== | ==Contour== | ||

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

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. | 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 1,449: | Line 1,635: | ||

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

| | | | ||

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

the contour filter. | |||

| | | | ||

Line 1,464: | Line 1,649: | ||

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

| | | | ||

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

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

isosurfaces. | |||

| | | | ||

Line 1,474: | Line 1,659: | ||

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

| | | | ||

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

isosurfaces/isolines and also the number of such | |||

values. | |||

| | | | ||

Line 1,484: | Line 1,669: | ||

|'''ComputeNormals''' (ComputeNormals) | |'''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 | 1 | ||

Line 1,495: | Line 1,684: | ||

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

| | | | ||

If this property is set to 1, a scalar array containing | |||

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

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

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

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

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

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

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

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

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

| | | | ||

0 | 0 | ||

Line 1,505: | Line 1,701: | ||

|'''ComputeScalars''' (ComputeScalars) | |'''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 | 0 | ||

Line 1,515: | Line 1,711: | ||

|'''Point Merge Method''' (Locator) | |'''Point Merge Method''' (Locator) | ||

| | | | ||

This property specifies an incremental point locator for | |||

merging duplicate / coincident points. | |||

| | | | ||

Line 1,533: | Line 1,728: | ||

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

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

The Generic Contour filter computes isolines or isosurfaces using a selected point-centered scalar array. The available scalar arrays are listed in the Scalars menu. The scalar range of the selected array will be displayed. | Contour filter computes isolines or isosurfaces using a | ||

The interface for adding contour values is very similar to the one for selecting cut offsets (in the Cut filter). To add a single contour value, select the value from the New Value slider in the Add value portion of the interface and click the Add button, or press Enter. To instead add several evenly spaced contours, use the controls in the Generate range of values section. Select the number of contour values to generate using the Number of Values slider. The Range slider controls the interval in which to generate the contour values. Once the number of values and range have been selected, click the Generate button. The new values will be added to the Contour Values list. To delete a value from the Contour Values list, select the value and click the Delete button. (If no value is selected, the last value in the list will be removed.) Clicking the Delete All button removes all the values in the list. If no values are in the Contour Values list when Accept is pressed, the current value of the New Value slider will be used. | selected point-centered scalar array. The available scalar | ||

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. | arrays are listed in the Scalars menu. The scalar range of | ||

The Generic Contour filter operates on a generic data set, but the input is required to have at least one point-centered scalar (single-component) array. The output of this filter is polygonal. | the selected array will be displayed. The interface for | ||

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Line 1,550: | Line 1,771: | ||

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

| | | | ||

Set the input to the Generic Contour | |||

filter. | |||

| | | | ||

Line 1,565: | Line 1,785: | ||

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

| | | | ||

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

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

isosurfaces. | |||

| | | | ||

Line 1,575: | Line 1,795: | ||

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

| | | | ||

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

isosurfaces/isolines and also the number of such | |||

values. | |||

| | | | ||

Line 1,585: | Line 1,805: | ||

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

| | | | ||

Select whether to compute normals. | |||

| | | | ||

1 | 1 | ||

Line 1,595: | Line 1,813: | ||

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

| | | | ||

Select whether to compute gradients. | |||

| | | | ||

0 | 0 | ||

Line 1,605: | Line 1,821: | ||

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

| | | | ||

Select whether to compute scalars. | |||

| | | | ||

0 | 0 | ||

Line 1,615: | Line 1,829: | ||

|'''Point Merge Method''' (Locator) | |'''Point Merge Method''' (Locator) | ||

| | | | ||

This property specifies an incremental point locator for | |||

merging duplicate / coincident points. | |||

| | | | ||

Line 1,631: | Line 1,844: | ||

|} | |} | ||

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

Convert AMR to Multiblock | |||

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

|- | |||

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

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

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

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

|- | |||

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

| | |||

This property specifies the input for this | |||

filter. | |||

| | |||

| | |||

Accepts input of following types: | |||

* vtkOverlappingAMR | |||

|} | |||

==ConvertSelection== | |||

Converts a selection from one type to | |||

another. | |||

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

Line 1,647: | Line 1,883: | ||

|'''DataInput''' (DataInput) | |'''DataInput''' (DataInput) | ||

| | | | ||

Set the vtkDataObject input used to convert the | |||

selection. | |||

| | | | ||

Line 1,658: | Line 1,893: | ||

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

| | | | ||

Set the selection to convert. | |||

| | | | ||

Line 1,669: | Line 1,902: | ||

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

| | | | ||

Set the ContentType for the output. | |||

| | | | ||

5 | 5 | ||

Line 1,705: | Line 1,936: | ||

==Crop== | ==Crop== | ||

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

The Crop filter extracts an area/volume of interest from a 2D image or a 3D volume by allowing the user to specify the minimum and maximum extents of each dimension of the data. Both the input and output of this filter are uniform rectilinear data. | 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 1,719: | Line 1,953: | ||

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

| | | | ||

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

filter. | |||

| | | | ||

Line 1,730: | Line 1,963: | ||

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

| | | | ||

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

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

| | |||

| | |||

0 0 0 0 0 0 | 0 0 0 0 0 0 | ||

| | | | ||

Line 1,742: | Line 1,974: | ||

==Curvature== | ==Curvature== | ||

This filter will compute the Gaussian or mean curvature of the mesh at each point. | 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 | |||

; the type can be selected from the Curvature type menu button. | 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 1,758: | Line 1,990: | ||

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

| | | | ||

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

filter. | |||

| | | | ||

Line 1,769: | Line 2,000: | ||

|'''InvertMeanCurvature''' (InvertMeanCurvature) | |'''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 | 0 | ||

Line 1,779: | Line 2,010: | ||

|'''CurvatureType''' (CurvatureType) | |'''CurvatureType''' (CurvatureType) | ||

| | | | ||

This propery specifies which type of curvature to | |||

compute. | |||

| | | | ||

0 | 0 | ||

Line 1,793: | Line 2,023: | ||

==D3== | ==D3== | ||

Repartition a data set into load-balanced spatially convex regions. Create ghost cells if requested. | Repartition a data set into load-balanced spatially convex regions. Create ghost cells if requested.The D3 filter is | ||

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. | available when ParaView is run in parallel. It operates on | ||

any type of data set to evenly divide it across the | |||

processors into spatially contiguous regions. The output | |||

of this filter is of type unstructured | |||

grid. | |||

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

Line 1,807: | Line 2,040: | ||

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

| | | | ||

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

filter. | |||

| | | | ||

Line 1,818: | Line 2,050: | ||

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

Line 1,831: | Line 2,068: | ||

|'''Minimal Memory''' (UseMinimalMemory) | |'''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 1,844: | Line 2,081: | ||

Simplify a polygonal model using an adaptive edge collapse algorithm. This filter works with triangles only. | 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. | 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 1,857: | Line 2,097: | ||

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

| | | | ||

This property specifies the input to the Decimate | |||

filter. | |||

| | | | ||

Line 1,868: | Line 2,107: | ||

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

| | | | ||

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

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

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

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

input.) | |||

| | | | ||

0.9 | 0.9 | ||

Line 1,878: | Line 2,119: | ||

|'''PreserveTopology''' (PreserveTopology) | |'''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 | 0 | ||

Line 1,888: | Line 2,131: | ||

|'''FeatureAngle''' (FeatureAngle) | |'''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 | 15.0 | ||

Line 1,898: | Line 2,143: | ||

|'''BoundaryVertexDeletion''' (BoundaryVertexDeletion) | |'''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 | 1 | ||

Line 1,911: | Line 2,157: | ||

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. | Create 2D Delaunay triangulation of input points. It expects a vtkPointSet as input and produces vtkPolyData as output. The points are expected to be in a mostly planar distribution. | ||

Delaunay2D is a filter that constructs a 2D Delaunay triangulation from a list of input points. These points may be represented by any dataset of type vtkPointSet and subclasses. The output of the filter is a polygonal dataset containing a triangle mesh. | Delaunay2D is a filter that constructs a 2D Delaunay | ||

triangulation from a list of input points. These points | |||

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. | may be represented by any dataset of type vtkPointSet and | ||

subclasses. The output of the filter is a polygonal | |||

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

triangulation is defined as the triangulation that | |||

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

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

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

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. | each simplex in a triangulation contains only the n+1 | ||

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

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. | 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 1,935: | Line 2,215: | ||

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

| | | | ||

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

Delaunay 2D filter. | |||

| | | | ||

Line 1,946: | Line 2,225: | ||

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

| | | | ||

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

in performing the triangulation. | |||

| | | | ||

0 | 0 | ||

Line 1,958: | Line 2,236: | ||

|'''Alpha''' (Alpha) | |'''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 | 0.0 | ||

Line 1,968: | Line 2,247: | ||

|'''Tolerance''' (Tolerance) | |'''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 | 0.00001 | ||

Line 1,978: | Line 2,258: | ||

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

| | | | ||

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

initial, bounding Delaunay triangulation. | |||

| | | | ||

1.0 | 1.0 | ||

Line 1,988: | Line 2,267: | ||

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

| | | | ||

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

points (and associated triangles) are included in the output. These are | |||

introduced as an initial triangulation to begin the triangulation | |||

process. This feature is nice for debugging output. | |||

| | | | ||

0 | 0 | ||

Line 2,000: | Line 2,280: | ||

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

Create a 3D Delaunay triangulation of input points. It expects a vtkPointSet as input and produces vtkUnstructuredGrid as output. | 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 | |||

Delaunay3D is a filter that constructs a 3D Delaunay triangulation | represented by any dataset of type vtkPointSet and subclasses. The output of | ||

from a list of input points. These points may be represented by any | the filter is an unstructured grid dataset. Usually the output is a tetrahedral | ||

dataset of type vtkPointSet and subclasses. The output of the filter | mesh, but if a non-zero alpha distance value is specified (called the "alpha" | ||

is an unstructured grid dataset. Usually the output is a tetrahedral | value), then only tetrahedra, triangles, edges, and vertices lying within the | ||

mesh, but if a non-zero alpha distance value is specified (called | alpha radius are output. In other words, non-zero alpha values may result in | ||

the "alpha" value), then only tetrahedra, triangles, edges, and | arbitrary combinations of tetrahedra, triangles, lines, and vertices. (The | ||

vertices lying within the alpha radius are output. In other words, | notion of alpha value is derived from Edelsbrunner's work on "alpha shapes".) | ||

non-zero alpha values may result in arbitrary combinations of | The 3D Delaunay triangulation is defined as the triangulation that satisfies | ||

tetrahedra, triangles, lines, and vertices. (The notion of alpha | the Delaunay criterion for n-dimensional simplexes (in this case n=3 and the | ||

value is derived from Edelsbrunner's work on "alpha shapes".) | simplexes are tetrahedra). This criterion states that a circumsphere of each | ||

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

The 3D Delaunay triangulation is defined as the triangulation that | simplex. (See text for more information.) While in two dimensions this | ||

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

this case n=3 and the simplexes are tetrahedra). This criterion | measurement for optimality in 3D is not agreed on. Delaunay triangulations are | ||

states that a circumsphere of each simplex in a triangulation | used to build topological structures from unorganized (or unstructured) points. | ||

contains only the n+1 defining points of the simplex. (See text for | The input to this filter is a list of points specified in 3D. (If you wish to | ||

more information.) While in two dimensions this translates into an | create 2D triangulations see Delaunay2D.) The output is an unstructured grid. | ||

"optimal" triangulation, this is not true in 3D, since a measurement | The Delaunay triangulation can be numerically sensitive. To prevent problems, | ||

for optimality in 3D is not agreed on. | 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 | |||

Delaunay triangulations are used to build topological structures | "widely dispersed", and enables smooth transition of triangle sizes throughout | ||

from unorganized (or unstructured) points. The input to this filter | the mesh. (You may even want to add extra points to create a better point | ||

is a list of points specified in 3D. (If you wish to create 2D | distribution.) If numerical problems are present, you will see a warning | ||

triangulations see Delaunay2D.) The output is an unstructured | message to this effect at the end of the triangulation process. Warning: Points | ||

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

The Delaunay triangulation can be numerically sensitive. To prevent | triangulation (as implemented by this algorithm) depends on the order of the | ||

problems, try to avoid injecting points that will result in | input points. The first four points will form a tetrahedron; other degenerate | ||

triangles with bad aspect ratios (1000:1 or greater). In practice | points (relative to this initial tetrahedron) will not break it. Points that | ||

this means inserting points that are "widely dispersed", and enables | are coincident (or nearly so) may be discarded by the algorithm. This is | ||

smooth transition of triangle sizes throughout the mesh. (You may | because the Delaunay triangulation requires unique input points. You can | ||

even want to add extra points to create a better point | control the definition of coincidence with the "Tolerance" instance variable. | ||

distribution.) If numerical problems are present, you will see a | The output of the Delaunay triangulation is supposedly a convex hull. In | ||

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

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

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

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

be triangulated in more than one way (at least according to the | varies from the 2D Delaunay algorithm (i.e., Delaunay2D) in an important way. | ||

Delaunay criterion). The choice of triangulation (as implemented by | When points are injected into the triangulation, the search for the enclosing | ||

this algorithm) depends on the order of the input points. The first | tetrahedron is quite different. In the 3D case, the closest previously inserted | ||

four points will form a tetrahedron; other degenerate points | point point is found, and then the connected tetrahedra are searched to find | ||

(relative to this initial tetrahedron) will not break it. | the containing one. (In 2D, a "walk" towards the enclosing triangle is | ||

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

Points that are coincident (or nearly so) may be discarded by the | will be found. However, in degenerate cases an enclosing tetrahedron may not be | ||

algorithm. This is because the Delaunay triangulation requires | found and the point will be rejected. | ||

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,081: | Line 2,339: | ||

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

| | | | ||

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

Delaunay 3D filter. | |||

| | | | ||

Line 2,092: | Line 2,349: | ||

|'''Alpha''' (Alpha) | |'''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 | 0.0 | ||

| | | | ||

Line 2,106: | Line 2,361: | ||

|'''Tolerance''' (Tolerance) | |'''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 | 0.001 | ||

Line 2,118: | Line 2,372: | ||

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

| | | | ||

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

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

| | | | ||

2.5 | 2.5 | ||

Line 2,129: | Line 2,381: | ||

|'''BoundingTriangulation''' (BoundingTriangulation) | |'''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 | 0 | ||

Line 2,145: | Line 2,395: | ||

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

This filter either computes a statistical model of a dataset or takes such a model as its second input. Then, the model (however it is obtained) may optionally be used to assess the input dataset.<p> | This filter either computes a statistical model of a dataset or takes | ||

This filter computes the min, max, mean, raw moments M2 through M4, standard deviation, skewness, and kurtosis for each array you select.<p> | such a model as its second input. Then, the model (however it is | ||

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. | obtained) may optionally be used to assess the input dataset.<p> | ||

This filter computes the min, max, mean, raw moments M2 through M4, | |||

standard deviation, skewness, and kurtosis for each array you | |||

select.<p> The model is simply a univariate Gaussian distribution | |||

with the mean and standard deviation provided. Data is assessed using | |||

this model by detrending the data (i.e., subtracting the mean) and then | |||

dividing by the standard deviation. Thus the assessment is an array whose | |||

entries are the number of standard deviations from the mean that each | |||

input point lies. | |||

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

Line 2,160: | Line 2,417: | ||

|'''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 2,178: | Line 2,435: | ||

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

| | | | ||

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

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

| | | | ||

Line 2,187: | Line 2,443: | ||

* vtkTable | * vtkTable | ||

* vtkMultiBlockDataSet | * vtkMultiBlockDataSet | ||

|- | |- | ||

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

| | | | ||

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

drawn from. | |||

| | | | ||

0 | 0 | ||

Line 2,208: | Line 2,455: | ||

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

| | | | ||

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

observations for statistical analysis. | |||

| | | | ||

Line 2,218: | Line 2,464: | ||

|'''Task''' (Task) | |'''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 | 3 | ||

Line 2,238: | Line 2,493: | ||

|'''TrainingFraction''' (TrainingFraction) | |'''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 | 0.1 | ||

Line 2,248: | Line 2,503: | ||

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

| | | | ||

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

unsigned? | |||

| | | | ||

0 | 0 | ||

Line 2,263: | Line 2,517: | ||

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

The Elevation filter generates point scalar values for an input dataset along a specified direction vector. | The Elevation filter generates point scalar values for an | ||

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

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

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

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

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

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

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

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

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

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

point projects. | |||

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

Line 2,278: | Line 2,540: | ||

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

| | | | ||

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

Elevation filter. | |||

| | | | ||

Line 2,289: | Line 2,550: | ||

|'''ScalarRange''' (ScalarRange) | |'''ScalarRange''' (ScalarRange) | ||

| | | | ||

This property determines the range into which scalars | |||

will be mapped. | |||

| | | | ||

0 1 | 0 1 | ||

Line 2,299: | Line 2,559: | ||

|'''Low Point''' (LowPoint) | |'''Low Point''' (LowPoint) | ||

| | | | ||

This property defines one end of the direction vector | |||

(small scalar values). | |||

| | | | ||

0 0 0 | 0 0 0 | ||

Line 2,313: | Line 2,572: | ||

|'''High Point''' (HighPoint) | |'''High Point''' (HighPoint) | ||

| | | | ||

This property defines the other end of the direction | |||

vector (large scalar values). | |||

| | | | ||

0 0 1 | 0 0 1 | ||

Line 2,329: | Line 2,587: | ||

==Extract AMR Blocks== | ==Extract AMR Blocks== | ||

This filter extracts a list of datasets from hierarchical datasets. | This filter extracts a list of datasets from hierarchical datasets.This filter extracts a list | ||

This filter extracts a list of datasets from hierarchical datasets. | of datasets from hierarchical datasets. | ||

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

Line 2,343: | Line 2,600: | ||

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

| | | | ||

This property specifies the input to the Extract | |||

Datasets filter. | |||

| | | | ||

| | | | ||

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

* | * vtkUniformGridAMR | ||

|- | |- | ||

|'''SelectedDataSets''' (SelectedDataSets) | |'''SelectedDataSets''' (SelectedDataSets) | ||

| | | | ||

This property provides a list of datasets to | |||

extract. | |||

| | | | ||

Line 2,366: | Line 2,621: | ||

==Extract Attributes== | ==Extract Attributes== | ||

Extract attribute data as a table. | 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 2,383: | Line 2,637: | ||

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

| | | | ||

This property specifies the input of the filter. | This property specifies the input of the | ||

filter. | |||

| | | | ||

Line 2,392: | Line 2,647: | ||

|'''FieldAssociation''' (FieldAssociation) | |'''FieldAssociation''' (FieldAssociation) | ||

| | | | ||

Select the attribute data to pass. | |||

| | | | ||

0 | 0 | ||

Line 2,408: | Line 2,661: | ||

|'''AddMetaData''' (AddMetaData) | |'''AddMetaData''' (AddMetaData) | ||

| | | | ||

It is possible for this filter to add additional | |||

meta-data to the field data such as point coordinates (when point | |||

attributes are selected and input is pointset) or structured | |||

coordinates etc. To enable this addition of extra information, turn | |||

this flag on. Off by default. | |||

| | | | ||

0 | 0 | ||

Line 2,424: | Line 2,675: | ||

==Extract Block== | ==Extract Block== | ||

This filter extracts a range of blocks from a multiblock dataset. | This filter extracts a range of blocks from a multiblock dataset.This filter extracts a range | ||

This filter extracts a range of groups from a multiblock dataset | of groups from a multiblock dataset | ||

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

Line 2,438: | Line 2,688: | ||

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

| | | | ||

This property specifies the input to the Extract Group | |||

filter. | |||

| | | | ||

Line 2,449: | Line 2,698: | ||

|'''BlockIndices''' (BlockIndices) | |'''BlockIndices''' (BlockIndices) | ||

| | | | ||

This property lists the ids of the blocks to extract | |||

from the input multiblock dataset. | |||

| | | | ||

Line 2,460: | Line 2,707: | ||

|'''PruneOutput''' (PruneOutput) | |'''PruneOutput''' (PruneOutput) | ||

| | | | ||

When set, the output mutliblock dataset will be pruned | |||

to remove empty nodes. On by default. | |||

| | | | ||

1 | 1 | ||

Line 2,471: | Line 2,716: | ||

|'''MaintainStructure''' (MaintainStructure) | |'''MaintainStructure''' (MaintainStructure) | ||

| | | | ||

This is used only when PruneOutput is ON. By default, | |||

when pruning the output i.e. remove empty blocks, if node has only 1 | |||

non-null child block, then that node is removed. To preserve these | |||

parent nodes, set this flag to true. | |||

| | | | ||

0 | 0 | ||

Line 2,486: | Line 2,729: | ||

==Extract CTH Parts== | ==Extract CTH Parts== | ||

Create a surface from a CTH volume fraction. | Create a surface from a CTH volume fraction.Extract | ||

CTH Parts is a specialized filter for visualizing the data | |||

from a CTH simulation. It first converts the selected | |||

cell-centered arrays to point-centered ones. It then | |||

contours each array at a value of 0.5. The user has the | |||

option of clipping the resulting surface(s) with a plane. | |||

This filter only operates on unstructured data. It | |||

produces polygonal output. | |||

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

Line 2,500: | Line 2,748: | ||

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

| | | | ||

This property specifies the input to the Extract CTH | |||

Parts filter. | |||

| | | | ||

Line 2,515: | Line 2,762: | ||

|'''Clip Type''' (ClipPlane) | |'''Clip Type''' (ClipPlane) | ||

| | | | ||

This property specifies whether to clip the dataset, and | |||

if so, it also specifies the parameters of the plane with which to | |||

clip. | |||

| | | | ||

Line 2,533: | Line 2,780: | ||

|'''Double Volume Arrays''' (AddDoubleVolumeArrayName) | |'''Double Volume Arrays''' (AddDoubleVolumeArrayName) | ||

| | | | ||

This property specifies the name(s) of the volume | |||

fraction array(s) for generating parts. | |||

| | | | ||

Line 2,543: | Line 2,789: | ||

|'''Float Volume Arrays''' (AddFloatVolumeArrayName) | |'''Float Volume Arrays''' (AddFloatVolumeArrayName) | ||

| | | | ||

This property specifies the name(s) of the volume | |||

fraction array(s) for generating parts. | |||

| | | | ||

Line 2,553: | Line 2,798: | ||

|'''Unsigned Character Volume Arrays''' (AddUnsignedCharVolumeArrayName) | |'''Unsigned Character Volume Arrays''' (AddUnsignedCharVolumeArrayName) | ||

| | | | ||

This property specifies the name(s) of the volume | |||

fraction array(s) for generating parts. | |||

| | | | ||

Line 2,563: | Line 2,807: | ||

|'''Volume Fraction Value''' (VolumeFractionSurfaceValue) | |'''Volume Fraction Value''' (VolumeFractionSurfaceValue) | ||

| | | | ||

The value of this property is the volume fraction value | |||

for the surface. | |||

| | |||

| | |||

0.1 | 0.1 | ||

| | | | ||

Line 2,576: | Line 2,819: | ||

This filter extracts cells that are inside/outside a region or at a region boundary. | This filter extracts cells that are inside/outside a region or at a region boundary. | ||

This filter extracts from its input dataset all cells that are either completely inside or outside of a specified region (implicit function). On output, the filter generates an unstructured grid. | This filter extracts from its input dataset all cells that are either | ||

To use this filter you must specify a region (implicit function). You must also specify whethter to extract cells lying inside or outside of the region. An option exists to extract cells that are neither inside or outside (i.e., boundary). | completely inside or outside of a specified region (implicit function). | ||

On output, the filter generates an unstructured grid. To use this filter | |||

you must specify a region (implicit function). You must also specify | |||

whethter to extract cells lying inside or outside of the region. An | |||

option exists to extract cells that are neither inside or outside (i.e., | |||

boundary). | |||

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

Line 2,590: | Line 2,837: | ||

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

| | | | ||

This property specifies the input to the Slice | |||

filter. | |||

| | | | ||

Line 2,601: | Line 2,847: | ||

|'''Intersect With''' (ImplicitFunction) | |'''Intersect With''' (ImplicitFunction) | ||

| | | | ||

This property sets the region used to extract | |||

cells. | |||

| | | | ||

Line 2,625: | Line 2,870: | ||

|'''Extraction Side''' (ExtractInside) | |'''Extraction Side''' (ExtractInside) | ||

| | | | ||

This parameter controls whether to extract cells that | |||

This parameter controls whether to extract cells that are inside or outside the region. | are inside or outside the region. | ||

| | | | ||

1 | 1 | ||

Line 2,637: | Line 2,881: | ||

|'''Extract only intersected''' (Extract only intersected) | |'''Extract only intersected''' (Extract only intersected) | ||

| | | | ||

This parameter controls whether to extract only cells | |||

This parameter controls whether to extract only cells that are on the boundary of the region. If this parameter is set, the Extraction Side parameter is ignored. If Extract Intersected is off, this parameter has no effect. | that are on the boundary of the region. If this parameter is set, the | ||

Extraction Side parameter is ignored. If Extract Intersected is off, | |||

this parameter has no effect. | |||

| | | | ||

0 | 0 | ||

Line 2,647: | Line 2,892: | ||

|'''Extract intersected''' (Extract intersected) | |'''Extract intersected''' (Extract intersected) | ||

| | | | ||

This parameter controls whether to extract cells that | |||

This parameter controls whether to extract cells that are on the boundary of the region. | are on the boundary of the region. | ||

| | | | ||

0 | 0 | ||

Line 2,659: | Line 2,903: | ||

==Extract Edges== | ==Extract Edges== | ||

Extract edges of 2D and 3D cells as lines. | Extract edges of 2D and 3D cells as lines.The Extract Edges | ||

The Extract Edges filter produces a wireframe version of the input dataset by extracting all the edges of the dataset's cells as lines. This filter operates on any type of data set and produces polygonal output. | filter produces a wireframe version of the input dataset | ||

by extracting all the edges of the dataset's cells as | |||

lines. This filter operates on any type of data set and | |||

produces polygonal output. | |||

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

Line 2,673: | Line 2,919: | ||

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

| | | | ||

This property specifies the input to the Extract Edges | |||

filter. | |||

| | | | ||

Line 2,687: | Line 2,932: | ||

Extract geometry from a higher-order dataset | Extract geometry from a higher-order dataset | ||

Extract geometry from a higher-order dataset. | Extract geometry from a higher-order | ||

dataset. | |||

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

Line 2,700: | Line 2,945: | ||

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

| | | | ||

Set the input to the Generic Geometry | |||

Filter. | |||

| | | | ||

Line 2,711: | Line 2,955: | ||

|'''PassThroughCellIds''' (PassThroughCellIds) | |'''PassThroughCellIds''' (PassThroughCellIds) | ||

| | | | ||

Select whether to forward original ids. | |||

| | | | ||

1 | 1 | ||

Line 2,723: | Line 2,965: | ||

==Extract Level== | ==Extract Level== | ||

This filter extracts a range of groups from a hierarchical dataset. | This filter extracts a range of groups from a hierarchical dataset.This filter extracts a range | ||

This filter extracts a range of levels from a hierarchical dataset | of levels from a hierarchical dataset | ||

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

Line 2,737: | Line 2,978: | ||

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

| | | | ||

This property specifies the input to the Extract Group | |||

filter. | |||

| | | | ||

| | | | ||

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

* | * vtkUniformGridAMR | ||

|- | |- | ||

|'''Levels''' (Levels) | |'''Levels''' (Levels) | ||

| | | | ||

This property lists the levels to extract from the input | |||

hierarchical dataset. | |||

| | | | ||

Line 2,761: | Line 2,999: | ||

==Extract Selection== | ==Extract Selection== | ||

Extract different type of selections. | Extract different type of selections.This | ||

filter extracts a set of cells/points given a selection. | |||

The selection can be obtained from a rubber-band selection | The selection can be obtained from a rubber-band selection | ||

(either cell, visible or in a frustum) or threshold selection | (either cell, visible or in a frustum) or threshold | ||

and passed to the filter or specified by providing an ID list. | selection and passed to the filter or specified by | ||

providing an ID list. | |||

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

Line 2,778: | Line 3,016: | ||

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

| | | | ||

This property specifies the input from which the | |||

selection is extracted. | |||

| | | | ||

Line 2,790: | Line 3,027: | ||

|'''Selection''' (Selection) | |'''Selection''' (Selection) | ||

| | | | ||

The input that provides the selection | |||

object. | |||

| | | | ||

Line 2,801: | Line 3,037: | ||

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

| | | | ||

If this property is set to 1 the output preserves the | |||

topology of its input and adds an insidedness array to mark which cells | |||

are inside or out. If 0 then the output is an unstructured grid which | |||

contains only the subset of cells that are inside. | |||

| | | | ||

0 | 0 | ||

Line 2,814: | Line 3,048: | ||

|'''ShowBounds''' (ShowBounds) | |'''ShowBounds''' (ShowBounds) | ||

| | | | ||

For frustum selection, if this property is set to 1 the | |||

output is the outline of the frustum instead of the contents of the | |||

input that lie within the frustum. | |||

| | | | ||

0 | 0 | ||

Line 2,828: | Line 3,060: | ||

==Extract Selection (internal)== | ==Extract Selection (internal)== | ||

This filter extracts a given set of cells or points given | |||

This filter extracts a given set of cells or points given a selection. | a selection. The selection can be obtained from a rubber-band selection | ||

The selection can be obtained from a rubber-band selection | (either point, cell, visible or in a frustum) and passed to the filter or | ||

(either point, cell, visible or in a frustum) and passed to the filter | specified by providing an ID list. This is an internal filter, use | ||

"ExtractSelection" instead. | |||

This is an internal filter, use "ExtractSelection" instead. | |||

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

Line 2,846: | Line 3,076: | ||

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

| | | | ||

The input from which the selection is | |||

extracted. | |||

| | | | ||

Line 2,857: | Line 3,086: | ||

|'''Selection''' (Selection) | |'''Selection''' (Selection) | ||

| | | | ||

The input that provides the selection | |||

object. | |||

| | | | ||

Line 2,865: | Line 3,093: | ||

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

* vtkSelection | * vtkSelection | ||

|} | |} | ||

Line 2,883: | Line 3,098: | ||

==Extract Subset== | ==Extract Subset== | ||

Extract a subgrid from a structured grid with the option of setting subsample strides. | Extract a subgrid from a structured grid with the option of setting subsample strides.The Extract | ||

The Extract Grid filter returns a subgrid of a structured input data set (uniform rectilinear, curvilinear, or nonuniform rectilinear). The output data set type of this filter is the same as the input type. | Grid filter returns a subgrid of a structured input data | ||

set (uniform rectilinear, curvilinear, or nonuniform | |||

rectilinear). The output data set type of this filter is | |||

the same as the input type. | |||

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

Line 2,897: | Line 3,114: | ||

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

| | | | ||

This property specifies the input to the Extract Grid | |||

filter. | |||

| | | | ||

Line 2,911: | Line 3,127: | ||

|'''VOI''' (VOI) | |'''VOI''' (VOI) | ||

| | | | ||

This property specifies the minimum and maximum point | |||

indices along each of the I, J, and K axes; these values indicate the | |||

volume of interest (VOI). The output will have the (I,J,K) extent | |||

specified here. | |||

| | | | ||

0 0 0 0 0 0 | 0 0 0 0 0 0 | ||

Line 2,921: | Line 3,138: | ||

|'''SampleRateI''' (SampleRateI) | |'''SampleRateI''' (SampleRateI) | ||

| | | | ||

This property indicates the sampling rate in the I | |||

dimension. A value grater than 1 results in subsampling; every nth | |||

index will be included in the output. | |||

| | | | ||

1 | 1 | ||

Line 2,931: | Line 3,148: | ||

|'''SampleRateJ''' (SampleRateJ) | |'''SampleRateJ''' (SampleRateJ) | ||

| | | | ||

This property indicates the sampling rate in the J | |||

dimension. A value grater than 1 results in subsampling; every nth | |||

index will be included in the output. | |||

| | | | ||

1 | 1 | ||

Line 2,941: | Line 3,158: | ||

|'''SampleRateK''' (SampleRateK) | |'''SampleRateK''' (SampleRateK) | ||

| | | | ||

This property indicates the sampling rate in the K | |||

dimension. A value grater than 1 results in subsampling; every nth | |||

index will be included in the output. | |||

| | | | ||

1 | 1 | ||

| | | | ||

Line 2,951: | Line 3,168: | ||

|'''IncludeBoundary''' (IncludeBoundary) | |'''IncludeBoundary''' (IncludeBoundary) | ||

| | | | ||

If the value of this property is 1, then if the sample | |||

rate in any dimension is greater than 1, the boundary indices of the | |||

input dataset will be passed to the output even if the boundary extent | |||

is not an even multiple of the sample rate in a given | |||

dimension. | |||

| | | | ||

0 | 0 | ||

Line 2,963: | Line 3,182: | ||

==Extract Surface== | ==Extract Surface== | ||

Extract a 2D boundary surface using neighbor relations to eliminate internal faces. | Extract a 2D boundary surface using neighbor relations to eliminate internal faces.The Extract | ||

The Extract Surface filter extracts the polygons forming the outer surface of the input dataset. This filter operates on any type of data and produces polygonal data as output. | Surface filter extracts the polygons forming the outer | ||

surface of the input dataset. This filter operates on any | |||

type of data and produces polygonal data as | |||

output. | |||

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

Line 2,977: | Line 3,198: | ||

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

| | | | ||

This property specifies the input to the Extract Surface | |||

filter. | |||

| | | | ||

Line 2,988: | Line 3,208: | ||

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

| | | | ||

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

surfaces along process boundaries will be removed. NOTE: Enabling this | |||

option might cause multiple executions of the data source because more | |||

information is needed to remove internal surfaces. | |||

| | | | ||

1 | 1 | ||

Line 2,998: | Line 3,219: | ||

|'''NonlinearSubdivisionLevel''' (NonlinearSubdivisionLevel) | |'''NonlinearSubdivisionLevel''' (NonlinearSubdivisionLevel) | ||

| | | | ||

If the input is an unstructured grid with nonlinear | |||

faces, this parameter determines how many times the face is subdivided | |||

into linear faces. If 0, the output is the equivalent of its linear | |||

couterpart (and the midpoints determining the nonlinear interpolation | |||

are discarded). If 1, the nonlinear face is triangulated based on the | |||

midpoints. If greater than 1, the triangulated pieces are recursively | |||

subdivided to reach the desired subdivision. Setting the value to | |||

greater than 1 may cause some point data to not be passed even if no | |||

quadratic faces exist. This option has no effect if the input is not an | |||

unstructured grid. | |||

| | | | ||

1 | 1 | ||

Line 3,032: | Line 3,250: | ||

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

| | | | ||

This property specifies the input of the filter. | This property specifies the input of the | ||

filter. | |||

| | | | ||

Line 3,041: | Line 3,260: | ||

|'''rL (physical box side length)''' (RL) | |'''rL (physical box side length)''' (RL) | ||

| | | | ||

The box side length used to wrap particles around if | |||

The box side length used to wrap particles around if they exceed rL (or less than 0) in any dimension (only positive positions are allowed in the input, or they are wrapped around). | they exceed rL (or less than 0) in any dimension (only positive | ||

positions are allowed in the input, or they are wrapped | |||

around). | |||

| | | | ||

100 | 100 | ||

Line 3,051: | Line 3,271: | ||

|'''overlap (shared point/ghost cell gap distance)''' (Overlap) | |'''overlap (shared point/ghost cell gap distance)''' (Overlap) | ||

| | | | ||

The space (in rL units) to extend processor particle | |||

The space (in rL units) to extend processor particle ownership for ghost particles/cells. Needed for correct halo calculation when halos cross processor boundaries in parallel computation. | ownership for ghost particles/cells. Needed for correct halo | ||

calculation when halos cross processor boundaries in parallel | |||

computation. | |||

| | | | ||

5 | 5 | ||

Line 3,061: | Line 3,282: | ||

|'''np (number of seeded particles in one dimension, i.e., total particles = np^3)''' (NP) | |'''np (number of seeded particles in one dimension, i.e., total particles = np^3)''' (NP) | ||

| | | | ||

Number of seeded particles in one dimension. Therefore, | |||

total simulation particles is np^3 (cubed). | |||

| | | | ||

256 | 256 | ||

Line 3,071: | Line 3,291: | ||

|'''bb (linking length)''' (BB) | |'''bb (linking length)''' (BB) | ||

| | | | ||

Linking length measured in units of interparticle | |||

spacing and is dimensionless. Used to link particles into halos for the | |||

friends-of-friends (FOF) algorithm. | |||

| | | | ||

0.20 | 0.20 | ||

Line 3,081: | Line 3,301: | ||

|'''pmin (minimum particle threshold for an FOF halo)''' (PMin) | |'''pmin (minimum particle threshold for an FOF halo)''' (PMin) | ||

| | | | ||

Minimum number of particles (threshold) needed before a | |||

group is called a friends-of-friends (FOF) halo. | |||

| | | | ||

100 | 100 | ||

Line 3,091: | Line 3,310: | ||

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

| | | | ||

If checked, the friends-of-friends (FOF) halo catalog | |||

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

well. | |||

| | | | ||

0 | 0 | ||

Line 3,101: | Line 3,320: | ||

|'''Compute the most bound particle''' (ComputeMostBoundParticle) | |'''Compute the most bound particle''' (ComputeMostBoundParticle) | ||

| | | | ||

If checked, the most bound particle for an FOF halo will | |||

If checked, the most bound particle for an FOF halo will be calculated. WARNING: This can be very slow. | be calculated. WARNING: This can be very slow. | ||

| | | | ||

0 | 0 | ||

Line 3,111: | Line 3,329: | ||

|'''Compute the most connected particle''' (ComputeMostConnectedParticle) | |'''Compute the most connected particle''' (ComputeMostConnectedParticle) | ||

| | | | ||

If checked, the most connected particle for an FOF halo | |||

If checked, the most connected particle for an FOF halo will be calculated. WARNING: This can be very slow. | will be calculated. WARNING: This can be very slow. | ||

| | | | ||

0 | 0 | ||

Line 3,121: | Line 3,338: | ||

|'''Compute spherical overdensity (SOD) halos''' (ComputeSOD) | |'''Compute spherical overdensity (SOD) halos''' (ComputeSOD) | ||

| | | | ||

If checked, spherical overdensity (SOD) halos will be | |||

If checked, spherical overdensity (SOD) halos will be calculated in addition to friends-of-friends (FOF) halos. | calculated in addition to friends-of-friends (FOF) | ||

halos. | |||

| | | | ||

0 | 0 | ||

Line 3,131: | Line 3,348: | ||

|'''initial SOD center''' (SODCenterType) | |'''initial SOD center''' (SODCenterType) | ||

| | | | ||

The initial friends-of-friends (FOF) center used for | |||

The initial friends-of-friends (FOF) center used for calculating a spherical overdensity (SOD) halo. WARNING: Using MBP or MCP can be very slow. | calculating a spherical overdensity (SOD) halo. WARNING: Using MBP or | ||

MCP can be very slow. | |||

| | | | ||

0 | 0 | ||

Line 3,145: | Line 3,362: | ||

|'''rho_c''' (RhoC) | |'''rho_c''' (RhoC) | ||

| | | | ||

rho_c (critical density) for SOD halo | |||

rho_c (critical density) for SOD halo finding. | finding. | ||

| | | | ||

2.77536627e11 | 2.77536627e11 | ||

Line 3,155: | Line 3,371: | ||

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

| | | | ||

The initial SOD mass. | The initial SOD mass. | ||

| | | | ||

1.0e14 | 1.0e14 | ||

Line 3,165: | Line 3,379: | ||

|'''minimum radius factor''' (MinRadiusFactor) | |'''minimum radius factor''' (MinRadiusFactor) | ||

| | | | ||

Minimum radius factor for SOD finding. | Minimum radius factor for SOD finding. | ||

| | | | ||

0.5 | 0.5 | ||

Line 3,175: | Line 3,387: | ||

|'''maximum radius factor''' (MaxRadiusFactor) | |'''maximum radius factor''' (MaxRadiusFactor) | ||

| | | | ||

Maximum radius factor for SOD finding. | Maximum radius factor for SOD finding. | ||

| | | | ||

2.0 | 2.0 | ||

Line 3,185: | Line 3,395: | ||

|'''number of bins''' (SODBins) | |'''number of bins''' (SODBins) | ||

| | | | ||

Number of bins for SOD finding. | Number of bins for SOD finding. | ||

| | | | ||

20 | 20 | ||

Line 3,195: | Line 3,403: | ||

|'''minimum FOF size''' (MinFOFSize) | |'''minimum FOF size''' (MinFOFSize) | ||

| | | | ||

Minimum FOF halo size to calculate an SOD | |||

Minimum FOF halo size to calculate an SOD halo. | halo. | ||

| | | | ||

1000 | 1000 | ||

Line 3,205: | Line 3,412: | ||

|'''minimum FOF mass''' (MinFOFMass) | |'''minimum FOF mass''' (MinFOFMass) | ||

| | | | ||

Minimum FOF mass to calculate an SOD | |||

Minimum FOF mass to calculate an SOD halo. | halo. | ||

| | | | ||

5.0e12 | 5.0e12 | ||

Line 3,218: | Line 3,424: | ||

This filter will extract edges along sharp edges of surfaces or boundaries of surfaces. | This filter will extract edges along sharp edges of surfaces or boundaries of surfaces. | ||

The Feature Edges filter extracts various subsets of edges from the input data set. This filter operates on polygonal data and produces polygonal output. | The Feature Edges filter extracts various subsets of edges | ||

from the input data set. This filter operates on polygonal | |||

data and produces polygonal output. | |||

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

Line 3,231: | Line 3,438: | ||

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

| | | | ||

This property specifies the input to the Feature Edges | |||

filter. | |||

| | | | ||

Line 3,242: | Line 3,448: | ||

|'''BoundaryEdges''' (BoundaryEdges) | |'''BoundaryEdges''' (BoundaryEdges) | ||

| | | | ||

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

edges will be extracted. Boundary edges are defined as lines cells or | |||

edges that are used by only one polygon. | |||

| | | | ||

1 | 1 | ||

Line 3,252: | Line 3,458: | ||

|'''FeatureEdges''' (FeatureEdges) | |'''FeatureEdges''' (FeatureEdges) | ||

| | | | ||

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

will be extracted. Feature edges are defined as edges that are used by | |||

two polygons whose dihedral angle is greater than the feature angle. | |||

(See the FeatureAngle property.) Toggle whether to extract feature | |||

edges. | |||

| | | | ||

1 | 1 | ||

Line 3,263: | Line 3,470: | ||

|'''Non-Manifold Edges''' (NonManifoldEdges) | |'''Non-Manifold Edges''' (NonManifoldEdges) | ||

| | | | ||

If the value of this property is set to 1, non-manifold | |||

ediges will be extracted. Non-manifold edges are defined as edges that | |||

are use by three or more polygons. | |||

| | | | ||

1 | 1 | ||

Line 3,273: | Line 3,480: | ||

|'''ManifoldEdges''' (ManifoldEdges) | |'''ManifoldEdges''' (ManifoldEdges) | ||

| | | | ||

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

edges will be extracted. Manifold edges are defined as edges that are | |||

used by exactly two polygons. | |||

| | | | ||

0 | 0 | ||

Line 3,283: | Line 3,490: | ||

|'''Coloring''' (Coloring) | |'''Coloring''' (Coloring) | ||

| | | | ||

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

extracted edges are assigned a scalar value based on the type of the | |||

edge. | |||

| | | | ||

0 | 0 | ||

| | | | ||

Line 3,293: | Line 3,500: | ||

|'''FeatureAngle''' (FeatureAngle) | |'''FeatureAngle''' (FeatureAngle) | ||

| | | | ||

Ths value of this property is used to define a feature | |||

edge. If the surface normal between two adjacent triangles is at least | |||

as large as this Feature Angle, a feature edge exists. (See the | |||

FeatureEdges property.) | |||

| | | | ||

30.0 | 30.0 | ||

Line 3,317: | Line 3,525: | ||

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

| | | | ||

Set the input to the Flatten Filter. | |||

| | | | ||

Line 3,332: | Line 3,538: | ||

==Gaussian Resampling== | ==Gaussian Resampling== | ||

Splat points into a volume with an elliptical, Gaussian distribution. | Splat points into a volume with an elliptical, Gaussian distribution.vtkGaussianSplatter | ||

is a filter that injects input points into a structured | |||

points (volume) dataset. As each point is injected, it | |||

or distributes values to nearby voxels. Data is distributed using an | "splats" or distributes values to nearby voxels. Data is | ||

elliptical, Gaussian distribution function. The distribution function is | distributed using an elliptical, Gaussian distribution | ||

modified using scalar values (expands distribution) or normals | function. The distribution function is modified using | ||

(creates ellipsoidal distribution rather than spherical). | scalar values (expands distribution) or normals (creates | ||

ellipsoidal distribution rather than spherical). Warning: | |||

Warning: results may be incorrect in parallel as points can't splat | results may be incorrect in parallel as points can't splat | ||

into other processor's cells. | into other processor's cells. | ||

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

Line 3,354: | Line 3,559: | ||

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

| | | | ||

This property specifies the input to the | |||

filter. | |||

| | | | ||

Line 3,369: | Line 3,573: | ||

|'''Resample Field''' (SelectInputScalars) | |'''Resample Field''' (SelectInputScalars) | ||

| | | | ||

Choose a scalar array to splat into the output cells. If | |||

ignore arrays is chosen, point density will be counted | |||

instead. | |||

| | | | ||

Line 3,379: | Line 3,583: | ||

|'''Resampling Grid''' (SampleDimensions) | |'''Resampling Grid''' (SampleDimensions) | ||

| | | | ||

Set / get the dimensions of the sampling structured | |||

point set. Higher values produce better results but are much | |||

slower. | |||

| | | | ||

50 50 50 | 50 50 50 | ||

Line 3,389: | Line 3,593: | ||

|'''Extent to Resample''' (ModelBounds) | |'''Extent to Resample''' (ModelBounds) | ||

| | | | ||

Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding | |||

box in which the sampling is performed. If any of the (min,max) bounds | |||

values are min >= max, then the bounds will be computed | |||

automatically from the input data. Otherwise, the user-specified bounds | |||

will be used. | |||

| | | | ||

0.0 0.0 0.0 0.0 0.0 0.0 | 0.0 0.0 0.0 0.0 0.0 0.0 | ||

Line 3,399: | Line 3,605: | ||

|'''Gaussian Splat Radius''' (Radius) | |'''Gaussian Splat Radius''' (Radius) | ||

| | | | ||

Set / get the radius of propagation of the splat. This | |||

value is expressed as a percentage of the length of the longest side of | |||

the sampling volume. Smaller numbers greatly reduce execution | |||

time. | |||

| | | | ||

0.1 | 0.1 | ||

Line 3,409: | Line 3,616: | ||

|'''Gaussian Exponent Factor''' (ExponentFactor) | |'''Gaussian Exponent Factor''' (ExponentFactor) | ||

| | | | ||

Set / get the sharpness of decay of the splats. This is | |||

the exponent constant in the Gaussian equation. Normally this is a | |||

negative value. | |||

| | | | ||

-5.0 | -5.0 | ||

Line 3,419: | Line 3,626: | ||

|'''Scale Splats''' (ScalarWarping) | |'''Scale Splats''' (ScalarWarping) | ||

| | | | ||

Turn on/off the scaling of splats by scalar | |||

value. | |||

| | | | ||

1 | 1 | ||

Line 3,429: | Line 3,635: | ||

|'''Scale Factor''' (ScaleFactor) | |'''Scale Factor''' (ScaleFactor) | ||

| | | | ||

Multiply Gaussian splat distribution by this value. If | |||

ScalarWarping is on, then the Scalar value will be multiplied by the | |||

ScaleFactor times the Gaussian function. | |||

| | | | ||

1.0 | 1.0 | ||

Line 3,439: | Line 3,645: | ||

|'''Elliptical Splats''' (NormalWarping) | |'''Elliptical Splats''' (NormalWarping) | ||

| | | | ||

Turn on/off the generation of elliptical splats. If | |||

normal warping is on, then the input normals affect the distribution of | |||

the splat. This boolean is used in combination with the Eccentricity | |||

ivar. | |||

| | | | ||

1 | 1 | ||

Line 3,449: | Line 3,656: | ||

|'''Ellipitical Eccentricity''' (Eccentricity) | |'''Ellipitical Eccentricity''' (Eccentricity) | ||

| | | | ||

Control the shape of elliptical splatting. Eccentricity | |||

is the ratio of the major axis (aligned along normal) to the minor | |||

(axes) aligned along other two axes. So Eccentricity gt 1 creates | |||

needles with the long axis in the direction of the normal; Eccentricity | |||

lt 1 creates pancakes perpendicular to the normal | |||

vector. | |||

| | | | ||

2.5 | 2.5 | ||

Line 3,459: | Line 3,669: | ||

|'''Fill Volume Boundary''' (Capping) | |'''Fill Volume Boundary''' (Capping) | ||

| | | | ||

Turn on/off the capping of the outer boundary of the | |||

volume to a specified cap value. This can be used to close surfaces | |||

(after iso-surfacing) and create other effects. | |||

| | | | ||

1 | 1 | ||

Line 3,469: | Line 3,679: | ||

|'''Fill Value''' (CapValue) | |'''Fill Value''' (CapValue) | ||

| | | | ||

Specify the cap value to use. (This instance variable | |||

only has effect if the ivar Capping is on.) | |||

| | | | ||

0.0 | 0.0 | ||

Line 3,479: | Line 3,688: | ||

|'''Splat Accumulation Mode''' (Accumulation Mode) | |'''Splat Accumulation Mode''' (Accumulation Mode) | ||

| | | | ||

Specify the scalar accumulation mode. This mode | |||

expresses how scalar values are combined when splats are overlapped. | |||

The Max mode acts like a set union operation and is the most commonly | |||

used; the Min mode acts like a set intersection, and the sum is just | |||

weird. | |||

| | | | ||

1 | 1 | ||

Line 3,492: | Line 3,703: | ||

|'''Empty Cell Value''' (NullValue) | |'''Empty Cell Value''' (NullValue) | ||

| | | | ||

Set the Null value for output points not receiving a | |||

contribution from the input points. (This is the initial value of the | |||

voxel samples.) | |||

| | | | ||

0.0 | 0.0 | ||

Line 3,505: | Line 3,716: | ||

Generate scalars from point and cell ids. | Generate scalars from point and cell ids. | ||

This filter generates scalars using cell and point ids. That is, the point attribute data scalars are generated from the point ids, and the cell attribute data scalars or field data are generated from the the cell ids. | This filter generates scalars using cell and point ids. | ||

That is, the point attribute data scalars are generated | |||

from the point ids, and the cell attribute data scalars or | |||

field data are generated from the the cell | |||

ids. | |||

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

Line 3,518: | Line 3,732: | ||

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

| | | | ||

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

Point Data filter. | |||

| | | | ||

Line 3,529: | Line 3,742: | ||

|'''ArrayName''' (ArrayName) | |'''ArrayName''' (ArrayName) | ||

| | | | ||

The name of the array that will contain | |||

ids. | |||

| | | | ||

Ids | Ids | ||

Line 3,542: | Line 3,754: | ||

Create a point set with data at quadrature points. | Create a point set with data at quadrature points. | ||

"Create a point set with data at quadrature | |||

points." | |||

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

Line 3,555: | Line 3,767: | ||

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

| | | | ||

This property specifies the input of the filter. | This property specifies the input of the | ||

filter. | |||

| | | | ||

Line 3,566: | Line 3,779: | ||

|'''SelectSourceArray''' (SelectSourceArray) | |'''SelectSourceArray''' (SelectSourceArray) | ||

| | | | ||

Specifies the offset array from which we generate | |||

quadrature points. | |||

| | | | ||

Line 3,579: | Line 3,791: | ||

Generate quadrature scheme dictionaries in data sets that do not have them. | Generate quadrature scheme dictionaries in data sets that do not have them. | ||

Generate quadrature scheme dictionaries in data sets that do not have | |||

them. | |||

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

Line 3,592: | Line 3,804: | ||

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

| | | | ||

This property specifies the input of the filter. | This property specifies the input of the | ||

filter. | |||

| | | | ||

Line 3,603: | Line 3,816: | ||

==Generate Surface Normals== | ==Generate Surface Normals== | ||

This filter will produce surface normals used for smooth shading. Splitting is used to avoid smoothing across feature edges. | This filter will produce surface normals used for smooth shading. Splitting is used to avoid smoothing across feature edges.This filter | ||

This filter generates surface normals at the points of the input polygonal dataset to provide smooth shading of the dataset. The resulting dataset is also polygonal. The filter works by calculating a normal vector for each polygon in the dataset and then averaging the normals at the shared points. | generates surface normals at the points of the input | ||

polygonal dataset to provide smooth shading of the | |||

dataset. The resulting dataset is also polygonal. The | |||

filter works by calculating a normal vector for each | |||

polygon in the dataset and then averaging the normals at | |||

the shared points. | |||

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

Line 3,617: | Line 3,834: | ||

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

| | | | ||

This property specifies the input to the Normals | |||

Generation filter. | |||

| | | | ||

Line 3,628: | Line 3,844: | ||

|'''FeatureAngle''' (FeatureAngle) | |'''FeatureAngle''' (FeatureAngle) | ||

| | | | ||

The value of this property defines a feature edge. If | |||

the surface normal between two adjacent triangles is at least as large | |||

as this Feature Angle, a feature edge exists. If Splitting is on, | |||

points are duplicated along these feature edges. (See the Splitting | |||

property.) | |||

| | | | ||

30 | 30 | ||

Line 3,638: | Line 3,856: | ||

|'''Splitting''' (Splitting) | |'''Splitting''' (Splitting) | ||

| | | | ||

This property controls the splitting of sharp edges. If | |||

sharp edges are split (property value = 1), then points are duplicated | |||

along these edges, and separate normals are computed for both sets of | |||

points to give crisp (rendered) surface definition. | |||

| | | | ||

1 | 1 | ||

Line 3,648: | Line 3,867: | ||

|'''Consistency''' (Consistency) | |'''Consistency''' (Consistency) | ||

| | | | ||

The value of this property controls whether consistent | |||

polygon ordering is enforced. Generally the normals for a data set | |||

should either all point inward or all point outward. If the value of | |||

this property is 1, then this filter will reorder the points of cells | |||

that whose normal vectors are oriented the opposite direction from the | |||

rest of those in the data set. | |||

| | | | ||

1 | 1 | ||

Line 3,658: | Line 3,880: | ||

|'''FlipNormals''' (FlipNormals) | |'''FlipNormals''' (FlipNormals) | ||

| | | | ||

If the value of this property is 1, this filter will | |||

reverse the normal direction (and reorder the points accordingly) for | |||

all polygons in the data set; this changes front-facing polygons to | |||

back-facing ones, and vice versa. You might want to do this if your | |||

viewing position will be inside the data set instead of outside of | |||

it. | |||

| | | | ||

0 | 0 | ||

Line 3,668: | Line 3,893: | ||

|'''Non-Manifold Traversal''' (NonManifoldTraversal) | |'''Non-Manifold Traversal''' (NonManifoldTraversal) | ||

| | | | ||

Turn on/off traversal across non-manifold edges. Not | |||

traversing non-manifold edges will prevent problems where the | |||

consistency of polygonal ordering is corrupted due to topological | |||

loops. | |||

| | | | ||

1 | 1 | ||

Line 3,678: | Line 3,904: | ||

|'''ComputeCellNormals''' (ComputeCellNormals) | |'''ComputeCellNormals''' (ComputeCellNormals) | ||

| | | | ||

This filter computes the normals at the points in the | |||

data set. In the process of doing this it computes polygon normals too. | |||

If you want these normals to be passed to the output of this filter, | |||

| | set the value of this property to 1. | ||

| | |||

0 | 0 | ||

| | | | ||

Line 3,688: | Line 3,915: | ||

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

| | | | ||

Turn this option to to produce the same results | |||

regardless of the number of processors used (i.e., avoid seams along | |||

processor boundaries). Turn this off if you do want to process ghost | |||

levels and do not mind seams. | |||

| | | | ||

1 | 1 | ||

Line 3,712: | Line 3,940: | ||

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

| | | | ||

Set the input to the Geoemtry Filter. | |||

| | | | ||

Line 3,722: | Line 3,948: | ||

|'''UseStrips''' (UseStrips) | |'''UseStrips''' (UseStrips) | ||

| | | | ||

Toggle whether to generate faces containing triangle | |||

strips. This should render faster and use less memory, but no cell data | |||

is copied. | |||

| | | | ||

0 | 0 | ||

Line 3,733: | Line 3,958: | ||

|'''ForceStrips''' (ForceStrips) | |'''ForceStrips''' (ForceStrips) | ||

| | | | ||

This makes UseStrips call Modified() after changing its | |||

setting to ensure that the filter's output is immediatley | |||

changed. | |||

| | | | ||

0 | 0 | ||

Line 3,743: | Line 3,968: | ||

|'''UseOutline''' (UseOutline) | |'''UseOutline''' (UseOutline) | ||

| | | | ||

Toggle whether to generate an outline or a | |||

surface. | |||

| | | | ||

0 | 0 | ||

Line 3,753: | Line 3,977: | ||

|'''NonlinearSubdivisionLevel''' (NonlinearSubdivisionLevel) | |'''NonlinearSubdivisionLevel''' (NonlinearSubdivisionLevel) | ||

| | | | ||

Nonlinear faces are approximated with flat polygons. | |||

This parameter controls how many times to subdivide nonlinear surface | |||

cells. Higher subdivisions generate closer approximations but take more | |||

memory and rendering time. Subdivision is recursive, so the number of | |||

output polygons can grow exponentially with this | |||

parameter. | |||

| | | | ||

1 | 1 | ||

Line 3,768: | Line 3,990: | ||

|'''PassThroughIds''' (PassThroughIds) | |'''PassThroughIds''' (PassThroughIds) | ||

| | | | ||

If on, the output polygonal dataset will have a celldata | |||

array that holds the cell index of the original 3D cell that produced | |||

each output cell. This is useful for cell picking. | |||

| | | | ||

1 | 1 | ||

Line 3,778: | Line 4,000: | ||

|'''PassThroughPointIds''' (PassThroughPointIds) | |'''PassThroughPointIds''' (PassThroughPointIds) | ||

| | | | ||

If on, the output polygonal dataset will have a | |||

pointdata array that holds the point index of the original 3D vertex | |||

that produced each output vertex. This is useful for | |||

picking. | |||

| | | | ||

1 | 1 | ||

Line 3,788: | Line 4,011: | ||

|'''MakeOutlineOfInput''' (MakeOutlineOfInput) | |'''MakeOutlineOfInput''' (MakeOutlineOfInput) | ||

| | | | ||

Causes filter to try to make geometry of input to the | |||

algorithm on its input. | |||

| | | | ||

0 | 0 | ||

Line 3,801: | Line 4,023: | ||

This filter generates an arrow, cone, cube, cylinder, line, sphere, or 2D glyph at each point of the input data set. The glyphs can be oriented and scaled by point attributes of the input dataset. | This filter generates an arrow, cone, cube, cylinder, line, sphere, or 2D glyph at each point of the input data set. The glyphs can be oriented and scaled by point attributes of the input dataset. | ||

The Glyph filter generates a glyph (i.e., an arrow, cone, cube, cylinder, line, sphere, or 2D glyph) at each point in the input dataset. The glyphs can be oriented and scaled by the input point-centered scalars and vectors. The Glyph filter operates on any type of data set. Its output is polygonal. This filter is available on the Toolbar. | The Glyph filter generates a glyph (i.e., an arrow, cone, cube, cylinder, | ||

line, sphere, or 2D glyph) at each point in the input dataset. The glyphs | |||

can be oriented and scaled by the input point-centered scalars and | |||

vectors. The Glyph filter operates on any type of data set. Its output is | |||

polygonal. This filter is available on the Toolbar. | |||

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

Line 3,814: | Line 4,039: | ||

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

| | | | ||

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

This is the dataset to which the glyphs will be | |||

applied. | |||

| | | | ||

Line 3,833: | Line 4,058: | ||

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

| | | | ||

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

which to operate. The indicated array may be used for scaling the | |||

glyphs. (See the SetScaleMode property.) | |||

| | | | ||

Line 3,843: | Line 4,068: | ||

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

| | | | ||

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

which to operate. The indicated array may be used for scaling and/or | |||

orienting the glyphs. (See the SetScaleMode and SetOrient | |||

properties.) | |||

| | | | ||

1 | 1 | ||

Line 3,853: | Line 4,079: | ||

|'''Glyph Type''' (Source) | |'''Glyph Type''' (Source) | ||

| | | | ||

This property determines which type of glyph will be | |||

placed at the points in the input dataset. | |||

| | | | ||

Line 3,878: | Line 4,103: | ||

|'''GlyphTransform''' (GlyphTransform) | |'''GlyphTransform''' (GlyphTransform) | ||

| | | | ||

The values in this property allow you to specify the | |||

transform (translation, rotation, and scaling) to apply to the glyph | |||

source. | |||

| | | | ||

Line 3,891: | Line 4,115: | ||

|'''Orient''' (SetOrient) | |'''Orient''' (SetOrient) | ||

| | | | ||

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

oriented based on the selected vector array. | |||

| | | | ||

1 | 1 | ||

Line 3,901: | Line 4,124: | ||

|'''Scale Mode''' (SetScaleMode) | |'''Scale Mode''' (SetScaleMode) | ||

| | | | ||

The value of this property specifies how/if the glyphs | |||

should be scaled based on the point-centered scalars/vectors in the | |||

input dataset. | |||

| | | | ||

1 | 1 | ||

Line 3,915: | Line 4,138: | ||

|'''SetScaleFactor''' (SetScaleFactor) | |'''SetScaleFactor''' (SetScaleFactor) | ||

| | | | ||

The value of this property will be used as a multiplier | |||

for scaling the glyphs before adding them to the | |||

output. | |||

| | | | ||

1.0 | 1.0 | ||

Line 3,929: | Line 4,152: | ||

|'''Maximum Number of Points''' (MaximumNumberOfPoints) | |'''Maximum Number of Points''' (MaximumNumberOfPoints) | ||

| | | | ||

The value of this property specifies the maximum number | |||

of glyphs that should appear in the output dataset if the value of the | |||

UseMaskPoints property is 1. (See the UseMaskPoints | |||

property.) | |||

| | | | ||

5000 | 5000 | ||

Line 3,939: | Line 4,163: | ||

|'''Mask Points''' (UseMaskPoints) | |'''Mask Points''' (UseMaskPoints) | ||

| | | | ||

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

maximum number of glyphs to the value indicated by | |||

MaximumNumberOfPoints. (See the MaximumNumberOfPoints | |||

property.) | |||

| | | | ||

1 | 1 | ||

Line 3,949: | Line 4,174: | ||

|'''RandomMode''' (RandomMode) | |'''RandomMode''' (RandomMode) | ||

| | | | ||

If the value of this property is 1, then the points to | |||

glyph are chosen randomly. Otherwise the point ids chosen are evenly | |||

spaced. | |||

| | |||

1 | |||

| | |||

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

|- | |||

|'''KeepRandomPoints''' (KeepRandomPoints) | |||

| | |||

If the value of this property is 1 and RandomMode is | |||

1, then the randomly chosen points to glyph are saved and reused for | |||

other timesteps. This is only useful if the coordinates are the same | |||

and in the same order between timesteps. | |||

| | | | ||

0 | |||

| | | | ||

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

Line 3,962: | Line 4,199: | ||

This filter generates a glyph at each point of the input data set. The glyphs can be oriented and scaled by point attributes of the input dataset. | This filter generates a glyph at each point of the input data set. The glyphs can be oriented and scaled by point attributes of the input dataset. | ||

The Glyph filter generates a glyph at each point in the input dataset. The glyphs can be oriented and scaled by the input point-centered scalars and vectors. The Glyph filter operates on any type of data set. Its output is polygonal. This filter is available on the Toolbar. | The Glyph filter generates a glyph at each point in the input dataset. | ||

The glyphs can be oriented and scaled by the input point-centered scalars | |||

and vectors. The Glyph filter operates on any type of data set. Its | |||

output is polygonal. This filter is available on the | |||

Toolbar. | |||

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

Line 3,975: | Line 4,215: | ||

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

| | | | ||

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

This is the dataset to which the glyphs will be | |||

applied. | |||

| | | | ||

Line 3,994: | Line 4,234: | ||

|'''Glyph Type''' (Source) | |'''Glyph Type''' (Source) | ||

| | | | ||

This property determines which type of glyph will be | |||

placed at the points in the input dataset. | |||

| | | | ||

Line 4,005: | Line 4,244: | ||

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

| | | | ||

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

which to operate. The indicated array may be used for scaling the | |||

glyphs. (See the SetScaleMode property.) | |||

| | | | ||

Line 4,015: | Line 4,254: | ||

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

| | | | ||

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

which to operate. The indicated array may be used for scaling and/or | |||

orienting the glyphs. (See the SetScaleMode and SetOrient | |||

properties.) | |||

| | | | ||

1 | 1 | ||

Line 4,025: | Line 4,265: | ||

|'''Orient''' (SetOrient) | |'''Orient''' (SetOrient) | ||

| | | | ||

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

oriented based on the selected vector array. | |||

| | | | ||

1 | 1 | ||

Line 4,035: | Line 4,274: | ||

|'''Scale Mode''' (SetScaleMode) | |'''Scale Mode''' (SetScaleMode) | ||

| | | | ||

The value of this property specifies how/if the glyphs | |||

should be scaled based on the point-centered scalars/vectors in the | |||

input dataset. | |||

| | | | ||

1 | 1 | ||

Line 4,049: | Line 4,288: | ||

|'''SetScaleFactor''' (SetScaleFactor) | |'''SetScaleFactor''' (SetScaleFactor) | ||

| | | | ||

The value of this property will be used as a multiplier | |||

for scaling the glyphs before adding them to the | |||

output. | |||

| | | | ||

1.0 | 1.0 | ||

Line 4,063: | Line 4,302: | ||

|'''Maximum Number of Points''' (MaximumNumberOfPoints) | |'''Maximum Number of Points''' (MaximumNumberOfPoints) | ||

| | | | ||

The value of this property specifies the maximum number | |||

of glyphs that should appear in the output dataset if the value of the | |||

UseMaskPoints property is 1. (See the UseMaskPoints | |||

property.) | |||

| | | | ||

5000 | 5000 | ||

Line 4,073: | Line 4,313: | ||

|'''Mask Points''' (UseMaskPoints) | |'''Mask Points''' (UseMaskPoints) | ||

| | | | ||

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

maximum number of glyphs to the value indicated by | |||

MaximumNumberOfPoints. (See the MaximumNumberOfPoints | |||

property.) | |||

| | | | ||

1 | 1 | ||

Line 4,083: | Line 4,324: | ||

|'''RandomMode''' (RandomMode) | |'''RandomMode''' (RandomMode) | ||

| | | | ||

If the value of this property is 1, then the points to | |||

glyph are chosen randomly. Otherwise the point ids chosen are evenly | |||

spaced. | |||

| | | | ||

1 | 1 | ||

| | |||

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

|- | |||

|'''KeepRandomPoints''' (KeepRandomPoints) | |||

| | |||

If the value of this property is 1 and RandomMode is | |||

1, then the randomly chosen points to glyph are saved and reused for | |||

other timesteps. This is only useful if the coordinates are the same | |||

and in the same order between timesteps. | |||

| | |||

0 | |||

| | | | ||

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

Line 4,095: | Line 4,348: | ||

==Gradient== | ==Gradient== | ||

This filter computes gradient vectors for an image/volume. | This filter computes gradient vectors for an image/volume.The Gradient filter | ||

The Gradient filter computes the gradient vector at each point in an image or volume. This filter uses central differences to compute the gradients. The Gradient filter operates on uniform rectilinear (image) data and produces image data output. | computes the gradient vector at each point in an image or | ||

volume. This filter uses central differences to compute | |||

the gradients. The Gradient filter operates on uniform | |||

rectilinear (image) data and produces image data | |||

output. | |||

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

Line 4,109: | Line 4,365: | ||

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

| | | | ||

This property specifies the input to the Gradient | |||

filter. | |||

| | | | ||

Line 4,124: | Line 4,379: | ||

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

| | | | ||

This property lists the name of the array from which to | |||

compute the gradient. | |||

| | | | ||

Line 4,134: | Line 4,388: | ||

|'''Dimensionality''' (Dimensionality) | |'''Dimensionality''' (Dimensionality) | ||

| | | | ||

This property indicates whether to compute the gradient | |||

in two dimensions or in three. If the gradient is being computed in two | |||

dimensions, the X and Y dimensions are used. | |||

| | | | ||

3 | 3 | ||

Line 4,148: | Line 4,402: | ||

==Gradient Magnitude== | ==Gradient Magnitude== | ||

Compute the magnitude of the gradient vectors for an image/volume. | Compute the magnitude of the gradient vectors for an image/volume.The Gradient | ||

The Gradient Magnitude filter computes the magnitude of the gradient vector at each point in an image or volume. This filter operates on uniform rectilinear (image) data and produces image data output. | Magnitude filter computes the magnitude of the gradient | ||

vector at each point in an image or volume. This filter | |||

operates on uniform rectilinear (image) data and produces | |||

image data output. | |||

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

Line 4,162: | Line 4,418: | ||

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

| | | | ||

This property specifies the input to the Gradient | |||

Magnitude filter. | |||

| | | | ||

Line 4,177: | Line 4,432: | ||

|'''Dimensionality''' (Dimensionality) | |'''Dimensionality''' (Dimensionality) | ||

| | | | ||

This property indicates whether to compute the gradient | |||

magnitude in two or three dimensions. If computing the gradient | |||

magnitude in 2D, the gradients in X and Y are used for computing the | |||

gradient magnitude. | |||

| | | | ||

3 | 3 | ||

Line 4,192: | Line 4,448: | ||

Estimate the gradient for each point or cell in any type of dataset. | Estimate the gradient for each point or cell in any type of dataset. | ||

The Gradient (Unstructured) filter estimates the gradient vector at each point or cell. It operates on any type of vtkDataSet, and the output is the same type as the input. If the dataset is a vtkImageData, use the Gradient filter instead; it will be more efficient for this type of dataset. | The Gradient (Unstructured) filter estimates the gradient | ||

vector at each point or cell. It operates on any type of | |||

vtkDataSet, and the output is the same type as the input. | |||

If the dataset is a vtkImageData, use the Gradient filter | |||

instead; it will be more efficient for this type of | |||

dataset. | |||

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

Line 4,205: | Line 4,465: | ||

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

| | | | ||

This property specifies the input to the Gradient | |||

(Unstructured) filter. | |||

| | | | ||

Line 4,218: | Line 4,477: | ||

|'''Scalar Array''' (SelectInputScalars) | |'''Scalar Array''' (SelectInputScalars) | ||

| | | | ||

This property lists the name of the scalar array from | |||

which to compute the gradient. | |||

| | | | ||

Line 4,228: | Line 4,486: | ||

|'''ResultArrayName''' (ResultArrayName) | |'''ResultArrayName''' (ResultArrayName) | ||

| | | | ||

This property provides a name for the output array | |||

containing the gradient vectors. | |||

| | | | ||

Gradients | Gradients | ||

Line 4,238: | Line 4,495: | ||

|'''FasterApproximation''' (FasterApproximation) | |'''FasterApproximation''' (FasterApproximation) | ||

| | | | ||

When this flag is on, the gradient filter will provide a | |||

less accurate (but close) algorithm that performs fewer derivative | |||

calculations (and is therefore faster). The error contains some | |||

smoothing of the output data and some possible errors on the boundary. | |||

This parameter has no effect when performing the gradient of cell | |||

data. | |||

| | | | ||

0 | 0 | ||

Line 4,253: | Line 4,508: | ||

|'''ComputeVorticity''' (ComputeVorticity) | |'''ComputeVorticity''' (ComputeVorticity) | ||

| | | | ||

When this flag is on, the gradient filter will compute | |||

the vorticity/curl of a 3 component array. | |||

| | | | ||

0 | 0 | ||

| | | | ||

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

|- | |||

|'''VorticityArrayName''' (VorticityArrayName) | |||

| | |||

This property provides a name for the output array | |||

containing the vorticity vector. | |||

| | |||

Vorticity | |||

| | |||

|- | |- | ||

|'''ComputeQCriterion''' (ComputeQCriterion) | |'''ComputeQCriterion''' (ComputeQCriterion) | ||

| | | | ||

When this flag is on, the gradient filter will compute | |||

the Q-criterion of a 3 component array. | |||

| | | | ||

0 | 0 | ||

| | | | ||

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

|- | |||

|'''QCriterionArrayName''' (QCriterionArrayName) | |||

| | |||

This property provides a name for the output array | |||

containing Q criterion. | |||

| | |||

Q-criterion | |||

| | |||

|} | |} | ||

Line 4,277: | Line 4,546: | ||

==Grid Connectivity== | ==Grid Connectivity== | ||

Mass properties of connected fragments for unstructured grids. | Mass properties of connected fragments for unstructured grids.This | ||

filter works on multiblock unstructured grid inputs and | |||

parallel. It Ignores any cells with a cell data Status value of 0. | also works in parallel. It Ignores any cells with a cell | ||

It performs connectivity to distict fragments separately. It then integrates | data Status value of 0. It performs connectivity to | ||

distict fragments separately. It then integrates | |||

attributes of the fragments. | attributes of the fragments. | ||

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

Line 4,294: | Line 4,563: | ||

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

| | | | ||

This property specifies the input of the filter. | This property specifies the input of the | ||

filter. | |||

| | | | ||

Line 4,307: | Line 4,577: | ||

Group data sets. | Group data sets. | ||

Groups multiple datasets to create a multiblock | |||

dataset | |||

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

Line 4,320: | Line 4,590: | ||

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

| | | | ||

This property indicates the the inputs to the Group | |||

Datasets filter. | |||

| | | | ||

Line 4,345: | Line 4,614: | ||

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

| | | | ||

This property specifies the input to the Histogram | |||

filter. | |||

| | | | ||

Line 4,358: | Line 4,626: | ||

|'''SelectInputArray''' (SelectInputArray) | |'''SelectInputArray''' (SelectInputArray) | ||

| | | | ||

This property indicates the name of the array from which | |||

to compute the histogram. | |||

| | | | ||

Line 4,368: | Line 4,635: | ||

|'''BinCount''' (BinCount) | |'''BinCount''' (BinCount) | ||

| | | | ||

The value of this property specifies the number of bins | |||

for the histogram. | |||

| | | | ||

10 | 10 | ||

Line 4,378: | Line 4,644: | ||

|'''Component''' (Component) | |'''Component''' (Component) | ||

| | | | ||

The value of this property specifies the array component | |||

from which the histogram should be computed. | |||

| | | | ||

0 | 0 | ||

Line 4,388: | Line 4,653: | ||

|'''CalculateAverages''' (CalculateAverages) | |'''CalculateAverages''' (CalculateAverages) | ||

| | | | ||

This option controls whether the algorithm calculates | |||

averages of variables other than the primary variable that fall into | |||

each bin. | |||

| | | | ||

1 | 1 | ||

Line 4,400: | Line 4,663: | ||

|'''UseCustomBinRanges''' (UseCustomBinRanges) | |'''UseCustomBinRanges''' (UseCustomBinRanges) | ||

| | | | ||

When set to true, CustomBinRanges will be used instead | |||

of using the full range for the selected array. By default, set to | |||

false. | |||

| | | | ||

0 | 0 | ||

Line 4,411: | Line 4,673: | ||

|'''CustomBinRanges''' (CustomBinRanges) | |'''CustomBinRanges''' (CustomBinRanges) | ||

| | | | ||

Set custom bin ranges to use. These are used only when | |||

UseCustomBinRanges is set to true. | |||

| | | | ||

0.0 100.0 | 0.0 100.0 | ||

Line 4,422: | Line 4,682: | ||

|} | |} | ||

==Image Data | ==Image Data To AMR== | ||

Converts certain images to AMR. | |||

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

Line 4,438: | Line 4,696: | ||

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

| | | | ||

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

Point Data filter. | |||

| | | | ||

Line 4,444: | Line 4,705: | ||

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

* vtkImageData | * vtkImageData | ||

|- | |||

|'''Number of levels''' (NumberOfLevels) | |||

| | |||

This property specifies the number of levels in the amr data structure. | |||

| | |||

2 | |||

| | |||

|- | |||

|'''Maximum Number of Blocks''' (MaximumNumberOfLevels) | |||

| | |||

This property specifies the maximum number of blocks in the output | |||

amr data structure. | |||

| | |||

100 | |||

| | |||

|- | |||

|'''Refinement Ratio''' (RefinementRatio) | |||

| | |||

This property specifies the refinement ratio between levels. | |||

| | |||

2 | |||

| | |||

|} | |} | ||

==Image | ==Image Data To Uniform Grid== | ||

Create a uniform grid from an image data by specified blanking arrays. | |||

Create a vtkUniformGrid from a vtkImageData by passing in arrays to be used | |||

for point and/or cell blanking. By default, values of 0 in the specified | |||

array will result in a point or cell being blanked. Use Reverse to switch this. | |||

Line 4,464: | Line 4,758: | ||

| | | | ||

| | | | ||

Line 4,471: | Line 4,763: | ||

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

* vtkImageData | * vtkImageData | ||

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

with 1 component(s). | |||

|- | |||

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

| | | | ||

Specify the array to use for blanking. | |||

| | | | ||

| | |||

An array of scalars is required. | |||

|- | |- | ||

|''' | |'''Reverse''' (Reverse) | ||

| | | | ||

Reverse the array value to whether or not a point or cell is blanked. | |||

| | | | ||

0 | |||

| | | | ||

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

Line 4,494: | Line 4,786: | ||

|} | |} | ||

== | ==Image Data to Point Set== | ||

The Image Data to Point Set filter takes an image data | |||

(uniform rectilinear grid) object and outputs an equivalent structured | |||

grid (which as a type of point set). This brings the data to a broader | |||

category of data storage but only adds a small amount of overhead. This | |||

filter can be helpful in applying filters that expect or manipulate point | |||

coordinates. | |||

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

Line 4,511: | Line 4,806: | ||

| | | | ||

| | | | ||

| | | | ||

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

* | * vtkImageData | ||

|} | |} | ||

== | ==Image Shrink== | ||

Reduce the size of an image/volume by subsampling.The Image Shrink | |||

filter reduces the size of an image/volume dataset by | |||

subsampling it (i.e., extracting every nth pixel/voxel in | |||

integer multiples). The sbsampling rate can be set | |||

separately for each dimension of the | |||

image/volume. | |||

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

Line 4,537: | Line 4,833: | ||

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

| | | | ||

This property specifies the input | This property specifies the input to the Image Shrink | ||

filter. | |||

| | | | ||

| | | | ||

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

* | * vtkImageData | ||

|- | |- | ||

|''' | |'''ShrinkFactors''' (ShrinkFactors) | ||

| | | | ||

The value of this property indicates the amount by which | |||

to shrink along each axis. | |||

| | |||

1 1 1 | |||

| | | | ||

|- | |||

|'''Averaging''' (Averaging) | |||

| | | | ||

If the value of this property is 1, an average of | |||

neighborhood scalar values will be used as the output scalar value for | |||

each output point. If its value is 0, only subsampling will be | |||

performed, and the original scalar values at the points will be | |||

retained. | |||

| | |||

1 | |||

| | |||

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

|} | |} | ||

== | ==Integrate Variables== | ||

This filter integrates cell and point attributes. | |||

The Integrate Attributes filter integrates point and cell | |||

data over lines and surfaces. It also computes length of | |||

lines, area of surface, or volume. | |||

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

Line 4,577: | Line 4,881: | ||

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

| | | | ||

This property specifies the input to the Integrate | |||

Attributes filter. | |||

| | | | ||

| | | | ||

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

* | * vtkDataSet | ||

|} | |} | ||

== | ==Interpolate to Quadrature Points== | ||

Create scalar/vector data arrays interpolated to quadrature points. | |||

"Create scalar/vector data arrays interpolated to quadrature | |||

points." | |||

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

Line 4,632: | Line 4,907: | ||

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

| | | | ||

This property specifies the input of the | |||

filter. | |||

| | | | ||

| | | | ||

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

* | * vtkUnstructuredGrid | ||

|- | |||

|'''SelectSourceArray''' (SelectSourceArray) | |||

|- | |||

|''' | |||

| | | | ||

Specifies the offset array from which we interpolate | |||

values to quadrature points. | |||

| | | | ||

| | | | ||

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

|} | |} | ||

== | ==Intersect Fragments== | ||

The Intersect Fragments filter perform geometric intersections on sets of fragments. | |||

The Intersect Fragments filter perform geometric intersections on sets of | |||

fragments. The filter takes two inputs, the first containing fragment | |||

geometry and the second containing fragment centers. The filter has two | |||

outputs. The first is geometry that results from the intersection. The | |||

second is a set of points that is an approximation of the center of where | |||

each fragment has been intersected. | |||

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

Line 4,684: | Line 4,946: | ||

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

| | | | ||

This input must contian fragment | |||

geometry. | |||

| | | | ||

| | | | ||

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

* | * vtkMultiBlockDataSet | ||

|- | |- | ||

|''' | |'''Source''' (Source) | ||

| | | | ||

This input must contian fragment | |||

centers. | |||

| | | | ||

| | | | ||

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

* vtkMultiBlockDataSet | * vtkMultiBlockDataSet | ||

|- | |- | ||

|''' | |'''Slice Type''' (CutFunction) | ||

| | |||

This property sets the type of intersecting geometry, | |||

and associated parameters. | |||

| | | | ||

| | | | ||

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

* Plane (implicit_functions) | |||

* Box (implicit_functions) | |||

* Sphere (implicit_functions) | |||

| | |} | ||

==Iso Volume== | |||

This filter extracts cells by clipping cells that have point scalars not in the specified range. | |||

This filter clip away the cells using lower and upper | |||

thresholds. | |||

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

|- | |||

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

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

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

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

|- | |- | ||

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

| | |||

This property specifies the input to the Threshold | |||

filter. | |||

| | | | ||

| | | | ||

Accepts input of following types: | |||

* vtkDataSet | |||

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

* | |||

with 1 component(s). | |||

|- | |||

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

| | | | ||

The value of this property contains the name of the | |||

scalar array from which to perform thresholding. | |||

| | | | ||

| | |||

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

|- | |- | ||

|''' | |'''Threshold Range''' (ThresholdBetween) | ||

| | | | ||

The values of this property specify the upper and lower | |||

bounds of the thresholding operation. | |||

| | | | ||

0 0 | |||

| | | | ||

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

| | |} | ||

==K Means== | |||

== | |||

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

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

such a model as its second input. Then, the model (however it is | |||

obtained) may optionally be used to assess the input dataset.<p> | |||

This filter iteratively computes the center of k clusters in a space | |||

whose coordinates are specified by the arrays you select. The clusters | |||

are chosen as local minima of the sum of square Euclidean distances from | |||

each point to its nearest cluster center. The model is then a set of | |||

cluster centers. Data is assessed by assigning a cluster center and | |||

distance to the cluster to each point in the input data | |||