Api.php: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
(Automatic update)
(Automatic update)
Line 1: Line 1:
html2wiki.xsl Wikitext Output






==AMR Contour==
==2D Glyph==




<!-- End of Proxy Documentation -->
Create a 2D glyph (e.g., arrow, cross, dash, etc.)
 
The 2D Glyph source is used for generating a family of 2D glyphs, each of which lies in the x-y plane. The output of the 2D Glyph source is polygonal data.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 15: Line 16:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Capping'''<br>''(Capping)''
| '''Center'''<br>''(Center)''
|  
|
If this property is on, the the boundary of the data set is capped.
Set the x, y, z coordinates of the origin of the 2D glyph.
| 1
|
Only the values 0 and 1 are accepted.
 


| 0 0 0
|
|-
|-
| '''Isosurface'''<br>''(ContourValue)''
| '''Filled'''<br>''(Filled)''
|  
|
This property specifies the values at which to compute the isosurface.
If the value of this property is 1, the 2D glyph will be a filled polygon; otherwise, only the edges (line segments) will be included in the output. This only applies to closed 2D glyphs.
| 1
|
The value must lie within the range of the selected data array.
 


|-
| 0
| '''Degenerate Cells'''<br>''(DegenerateCells)''
|
|
If this property is on, a transition mesh between levels is created.
| 1
|  
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.




|-
|-
| '''Input'''<br>''(Input)''
| '''Glyph Type'''<br>''(GlyphType)''
|  
|
|
This property specifies the type of the 2D glyph.
|
The selected object must be the result of the following: sources (includes readers), filters.


| 9
|
The value must be one of the following: Vertex (1), Dash (2), Cross (3), ThickCross (4), Triangle (5), Square (6), Circle (7), Diamond (8), Arrow (9), ThickArrow (10), HookedArrow (11), EdgeArrow (12).


The dataset must contain a cell array with 1 components.


|}


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


==3D Text==


|-
| '''Merge Points'''<br>''(MergePoints)''
|
Use more memory to merge points on the boundaries of blocks.
| 1
|
Only the values 0 and 1 are accepted.


3D geometric representation of a text string


|-
The 3D Text source displays a text string as polygonal data.<br>
| '''Multiprocess Communication'''<br>''(MultiprocessCommunication)''
|
If this property is off, each process executes independantly.
| 1
|
Only the values 0 and 1 are accepted.
 


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Contour By'''<br>''(SelectInputScalars)''
| '''Property'''
|  
| '''Description'''
This property specifies the name of the cell scalar array from which the contour filter will compute isolines and/or isosurfaces.
| '''Default Value(s)'''
| '''Restrictions'''
|
|
An array of scalars is required.
 
 
|-
|-
| '''Skip Ghost Copy'''<br>''(SkipGhostCopy)''
| '''Text'''<br>''(Text)''
|  
|
A simple test to see if ghost values are already set properly.
This property contains the text string to be displayed. The ASCII alphanumeric characters a-z, A-Z, and 0-9 are supported; so are ASCII punctuation marks. The only supported control character is "\n", which inserts a new line in the text string.
| 1
|
Only the values 0 and 1 are accepted.


| 3D Text
|
|}


|-
| '''Triangulate'''<br>''(Triangulate)''
|
Use triangles instead of quads on capping surfaces.
| 1
|
Only the values 0 and 1 are accepted.
|}


==Annotate Time==


==AMR Dual Clip==


Shows the animation time as text annnotation in the view.


Clip with scalars. Tetrahedra.
The Annotate Time source can be used to show the animation time in text annotation.<br>
<!-- End of Proxy Documentation -->


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 125: Line 82:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Degenerate Cells'''<br>''(DegenerateCells)''
| '''Format'''<br>''(Format)''
|  
|
If this property is on, a transition mesh between levels is created.
This property specifies the format used to display the input time (using printf style).
| 1
|
Only the values 0 and 1 are accepted.


| Time: %f
|
|}
==Arrow==
3D arrow with a long cylindrical shaft and a cone for the tip
The Arrow source appends a cylinder to a cone to form a 3D arrow. The length of the whole arrow is 1.0 unit. The output of the Arrow source is polygonal data. This polygonal data will not contain normals, so rendering of the arrow will be performed using flat shading. The appearance of the arrow can be improved without significantly increasing the resolution of the tip and shaft by generating normals. (Use Normals Generation filter).<br>


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Input'''<br>''(Input)''
| '''Property'''
|  
| '''Description'''
|  
| '''Default Value(s)'''
|  
| '''Restrictions'''
The selected object must be the result of the following: sources (includes readers), filters.
|-
| '''Invert'''<br>''(Invert)''
|
Inverts the arrow direction.


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


The dataset must contain a cell array with 1 components.


|-
| '''Shaft Radius'''<br>''(ShaftRadius)''
|
This property specifies the radius of the shaft of the arrow (the cylinder).


The selected dataset must be one of the following types (or a subclass of one of them): vtkCompositeDataSet.
| 0.03
|
The value must be greater than or equal to 0 and less than or equal to 5.




|-
|-
| '''Merge Points'''<br>''(MergePoints)''
| '''Shaft Resolution'''<br>''(ShaftResolution)''
|  
|
Use more memory to merge points on the boundaries of blocks.
This property specifies the number of faces of the shaft of the arrow (the cylinder). As the resolution increases, the cylinder will become smoother.
 
| 1
| 6
|  
|
Only the values 0 and 1 are accepted.
The value must be greater than or equal to 0 and less than or equal to 128.




|-
|-
| '''Multiprocess Communication'''<br>''(MultiprocessCommunication)''
| '''Tip Length'''<br>''(TipLength)''
|  
|
If this property is off, each process executes independantly.
This property specifies the length of the tip.
 
| 1
| 0.35
|  
|
Only the values 0 and 1 are accepted.
The value must be greater than or equal to 0 and less than or equal to 1.




|-
|-
| '''Select Material Arrays'''<br>''(SelectMaterialArrays)''
| '''Tip Radius'''<br>''(TipRadius)''
|  
|
This property specifies the cell arrays from which the clip filter will
This property specifies the radius of the widest part of the tip of the arrow (the cone).
compute clipped cells.
 
| 0.1
|  
|
|  
The value must be greater than or equal to 0 and less than or equal to 10.
An array of scalars is required.




|-
|-
| '''Volume Fraction Value'''<br>''(VolumeFractionSurfaceValue)''
| '''Tip Resolution'''<br>''(TipResolution)''
|  
|
This property specifies the values at which to compute the isosurface.
This property specifies the number of faces in the representation of the tip of the arrow (the cone). As the resolution increases, the cone will become smoother.
 
| 0.1
| 6
|  
|
The value must be greater than or equal to 0 and less than or equal to 1.
The value must be greater than or equal to 1 and less than or equal to 128.




Line 192: Line 167:




==Annotate Time Filter==
==Axes==




Shows input data time as text annnotation in the view.
Three lines representing the axes - red line along X, green line along Y, and blue line along Z
 
The Annotate Time filter can be used to show the data time in a text annotation.<br>
The Axes source can be used to add a representation of the coordinate system axes to the 3D scene. The X axis will be drawn as a blue line, the Y axis as a green line, and the Z axis as a red line. The axes can be drawn either as three lines drawn in the positive direction from the origin or as three lines crossing at the origin (drawn in both the positive and negative directions). The output of the Axes source is polygonal data. This polygonal data has a scalar per line so that the lines can be colored. It also has normals defined.<br>
<!-- End of Proxy Documentation -->


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 207: Line 181:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Format'''<br>''(Format)''
| '''Origin'''<br>''(Origin)''
|  
|
The value of this property is a format string used to display the input time. The format string is specified using printf style.
The values of this property set the X, Y, and Z coordinates of the origin of the axes.
 
| Time: %f
| 0 0 0
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Scale Factor'''<br>''(ScaleFactor)''
|  
|
This property specifies the input dataset for which to display the time.
By default the axes lines have a length of 1 (or 1 in each direction, for a total length of 2, if value of the Symmetric property is 1). Increasing or decreasing the value of this property will make the axes larger or smaller, respectively.
 
|  
| 1
|  
|
The selected object must be the result of the following: sources (includes readers), filters.
The value must be greater than or equal to 0.




|-
|-
| '''Scale'''<br>''(Scale)''
| '''Symmetric'''<br>''(Symmetric)''
|  
|
The factor by which the input time is scaled.
When this property is set to 1, the axes extend along each of the positive and negative directions for a distance equal to the value of the Scale Factor property. When set to 0, the axes extend only in the positive direction.
 
| 1
| 0
|
|
|-
Only the values 0 and 1 are accepted.
| '''Shift'''<br>''(Shift)''
 
|  
 
The amount of time the input is shifted (after scaling).
| 0
|
|}
|}




==Append Attributes==
==Box==
 


Create a box with specified X, Y, and Z lengths.


Copies geometry from first input. Puts all of the arrays into the output.
The Box source can be used to add a box to the 3D scene. The output of the Box source is polygonal data containing both normals and texture coordinates.<br>
The Append Attributes filter takes multiple input data sets with the same geometry and merges their point and cell attributes to produce a single output containing all the point and cell attributes of the inputs. Any inputs without the same number of points and cells as the first input are ignored. The input data sets must already be collected together, either as a result of a reader that loads multiple parts (e.g., EnSight reader) or because the Group Parts filter has been run to form a collection of data sets.<br>
<!-- End of Proxy Documentation -->


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 255: Line 224:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Input'''<br>''(Input)''
| '''Center'''<br>''(Center)''
|  
|
This property specifies the input to the Append Attributes filter.
This property specifies the center of the box.
|
|
The selected object must be the result of the following: sources (includes readers), filters.


| 0 0 0
|
|-
| '''X Length'''<br>''(XLength)''
|
This property specifies the length of the box in the X direction.


The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
| 1
|
The value must be greater than or equal to 0.




|}
|-
 
| '''Y Length'''<br>''(YLength)''
 
|
==Append Datasets==
This property specifies the length of the box in the Y direction.


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


Takes an input of multiple datasets and output has only one unstructured grid.
The Append Datasets filter operates on multiple data sets of any type (polygonal, structured, etc.). It merges their geometry into a single data set. Only the point and cell attributes that all of the input data sets have in common will appear in the output. The input data sets must already be collected together, either as a result of a reader that loads multiple parts (e.g., EnSight reader) or because the Group Parts filter has been run to form a collection of data sets.<br>
<!-- End of Proxy Documentation -->


{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
|-
| '''Input'''<br>''(Input)''
| '''Z Length'''<br>''(ZLength)''
|  
|
This property specifies the datasets to be merged into a single dataset by the Append Datasets filter.
This property specifies the length of the box in the Z direction.
|
|
The selected object must be the result of the following: sources (includes readers), filters.


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


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


|}


|}


==Cone==


==Append Geometry==


Create a 3D cone of a given radius and height.


Takes an input of multiple poly data parts and output has only one part.
The Cone source can be used to add a polygonal cone to the 3D scene. The output of the Cone source is polygonal data.<br>
The Append Geometry filter operates on multiple polygonal data sets. It merges their geometry into a single data set. Only the point and cell attributes that all of the input data sets have in common will appear in the output.<br>
<!-- End of Proxy Documentation -->


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 315: Line 277:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Input'''<br>''(Input)''
| '''Capping'''<br>''(Capping)''
|  
|
Set the input to the Append Geometry filter.
If this property is set to 1, the base of the cone will be capped with a filled polygon. Otherwise, the base of the cone will be open.
|
|
The selected object must be the result of the following: sources (includes readers), filters.


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


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


|-
| '''Center'''<br>''(Center)''
|
This property specifies the center of the cone.
| 0 0 0
|
|-
| '''Direction'''<br>''(Direction)''
|
Set the orientation vector of the cone. The vector does not have to be normalized. The cone will point in the direction specified.
| 1 0 0
|
|-
| '''Height'''<br>''(Height)''
|
This property specifies the height of the cone.


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




==Block Scalars==
|-
| '''Radius'''<br>''(Radius)''
|
This property specifies the radius of the base of the cone.


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


The Level Scalars filter uses colors to show levels of a multiblock dataset.
The Level Scalars filter uses colors to show levels of a multiblock dataset.<br>
<!-- End of Proxy Documentation -->


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Resolution'''<br>''(Resolution)''
| '''Description'''
|
| '''Default Value(s)'''
This property indicates the number of divisions around the cone. The higher this number, the closer the polygonal approximation will come to representing a cone, and the more polygons it will contain.
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|  
This property specifies the input to the Level Scalars filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.


| 6
|
The value must be greater than or equal to 0 and less than or equal to 512.


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


|}


|}


==Cylinder==


==Calculator==


Create a 3D cylinder of a given radius and height.


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 410: Line 347:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Attribute Mode'''<br>''(AttributeMode)''
| '''Capping'''<br>''(Capping)''
|  
|
This property determines whether the computation is to be performed on point-centered or cell-centered data.
If this property is set to 1, the ends of the cylinder will each be capped with a closed polygon. Otherwise, the ends of the cylinder will be open.
| 0
|
The value must be one of the following: point_data (1), cell_data (2), field_data (5).


 
| 1
|-
|
| '''Coordinate Results'''<br>''(CoordinateResults)''
|
The value of this property determines whether the results of this computation should be used as point coordinates or as a new array.
| 0
|  
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.




|-
|-
| '''Function'''<br>''(Function)''
| '''Center'''<br>''(Center)''
|  
|
This property contains the equation for computing the new array.
This property specifies the coordinate value at the center of the cylinder.
 
|  
| 0 0 0
|  
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Height'''<br>''(Height)''
|  
|
This property specifies the input dataset to the Calculator filter. The scalar and vector variables may be chosen from this dataset's arrays.
This property specifies the height of the cylinder (along the y axis).
|
|
The selected object must be the result of the following: sources (includes readers), filters.


 
| 1
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
|
The value must be greater than or equal to 0.




|-
|-
| '''Replace Invalid Results'''<br>''(ReplaceInvalidValues)''
| '''Radius'''<br>''(Radius)''
|  
|
This property determines whether invalid values in the computation will be replaced with a specific value. (See the ReplacementValue property.)
This property specifies the radius of the cylinder.
 
| 1
| 0.5
|  
|
Only the values 0 and 1 are accepted.
The value must be greater than or equal to 0.




|-
|-
| '''Replacement Value'''<br>''(ReplacementValue)''
| '''Resolution'''<br>''(Resolution)''
|  
|
If invalid values in the computation are to be replaced with another value, this property contains that value.
This property indicates the number of divisions around the cylinder. The higher this number, the closer the polygonal approximation will come to representing a cylinder, and the more polygons it will contain.
 
| 0
| 6
|  
|
|-
The value must be greater than or equal to 2 and less than or equal to 512.
| '''Result Array Name'''<br>''(ResultArrayName)''
 
|
 
This property contains the name for the output array containing the result of this computation.
| Result
|
|}
|}




==Cell Centers==
==Data Object Generator==
 


Parses a string to produce composite data objects consisting of simple templated datasets.


Create a point (no geometry) at the center of each input cell.
vtkDataObjectGenerator parses a string and produces dataobjects from the<br>
dataobject template names it sees in the string. For example, if the string<br>
The Cell Centers filter places a point at the center of each cell in the input data set. The center computed is the parametric center of the cell, not necessarily the geometric or bounding box center. The cell attributes of the input will be associated with these newly created points of the output. You have the option of creating a vertex cell per point in the outpuut. This is useful because vertex cells are rendered, but points are not. The points themselves could be used for placing glyphs (using the Glyph filter). The Cell Centers filter takes any type of data set as input and produces a polygonal data set as output.<br>
contains "ID1" the generator will create a vtkImageData. "UF1", "RG1", <br>
<!-- End of Proxy Documentation -->
"SG1", "PD1", and "UG1" will produce vtkUniformGrid, vtkRectilinearGrid,<br>
vtkStructuredGrid, vtkPolyData and vtkUnstructuredGrid respectively. <br>
"PD2" will produce an alternate vtkPolydata.<br>
You can compose composite datasets from the atomic ones listed above<br>
by placing them within one of the two composite dataset identifiers<br>
- "MB{}" or "HB[]". "MB{ ID1 PD1 MB{} }" for example will create a <br>
vtkMultiBlockDataSet consisting of three blocks: image data, poly data, <br>
multi-block (empty). Hierarchical Box data sets additionally require<br>
the notion of groups, declared within "()" braces, to specify AMR depth.<br>
"HB[ (UF1)(UF1)(UF1) ]" will create a vtkHierarchicalBoxDataSet representing<br>
an octree that is three levels deep, in which the firstmost cell in each level<br>
is refined.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 491: Line 424:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Input'''<br>''(Input)''
| '''Program'''<br>''(Program)''
|  
|
This property specifies the input to the Cell Centers filter.
This property contains the string that is parsed to determine the structured of the output data object to produce.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Vertex Cells'''<br>''(VertexCells)''
|
If set to 1, a vertex cell will be generated per point in the output. Otherwise only points will be generated.
| 0
|
Only the values 0 and 1 are accepted.


| ID1
|
|}


|}


==Disk==


==Cell Data to Point Data==


Create a 3D disk with a specified inner and outer radius.


Create point attributes by averaging cell attributes.
The Disk source can be used to add a polygonal disk to the 3D scene. The output of the Disk source is polygonal data.<br>
The Cell Data to Point Data filter averages the values of the cell attributes of the cells surrounding a point to compute point attributes. The Cell Data to Point Data filter operates on any type of data set, and the output data set is of the same type as the input.<br>
<!-- End of Proxy Documentation -->


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 531: Line 447:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Input'''<br>''(Input)''
| '''Circumferential Resolution'''<br>''(CircumferentialResolution)''
|  
|
This property specifies the input to the Cell Data to Point Data filter.
Set the number of points in circumferential direction.
|
|
The selected object must be the result of the following: sources (includes readers), filters.


| 8
|
The value must be greater than or equal to 3 and less than or equal to 1024.


The dataset must contain a cell array.


|-
| '''Inner Radius'''<br>''(InnerRadius)''
|
Specify inner radius of hole in disc.


The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
| 0.5
|
The value must be greater than or equal to 0.




|-
|-
| '''Pass Cell Data'''<br>''(PassCellData)''
| '''Outer Radius'''<br>''(OuterRadius)''
|  
|
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.
Specify outer radius of disc.
 
| 0
| 1
|  
|
Only the values 0 and 1 are accepted.
The value must be greater than or equal to 0.




|-
|-
| '''Piece Invariant'''<br>''(PieceInvariant)''
| '''Radial Resolution'''<br>''(RadialResolution)''
|  
|
If the value of this property is set to 1, this filter will request ghost levels so that the values at boundary points match across processes. NOTE: Enabling this option might cause multiple executions of the data source because more information is needed to remove internal surfaces.
Set the number of points in radial direction.
 
| 0
| 8
|  
|
Only the values 0 and 1 are accepted.
The value must be greater than or equal to 3 and less than or equal to 1024.




Line 569: Line 489:




==Clean==
==Hierarchical Fractal==




Merge coincident points if they do not meet a feature edge criteria.
Test source for AMR with HierarchicalDataSet
 
The Clean filter takes polygonal data as input and generates polygonal data as output. This filter can merge duplicate points, remove unused points, and transform degenerate cells into their appropriate forms (e.g., a triangle is converted into a line if two of its points are merged).<br>
The Hierarchical Fractal source is a collection of uniform grids. All have the same dimensions. Each block has a different origin and spacing. This source uses the Mandelbrot source to create cell data. The fractal array is scaled to look like a volme fraction.<br>
<!-- End of Proxy Documentation -->


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 584: Line 503:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Absolute Tolerance'''<br>''(AbsoluteTolerance)''
| '''Asymetric'''<br>''(Asymetric)''
|  
|
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.
If this property is set to 0, all the blocks will be the same size. If it is set to 1, an asymmetric dataset will be created: some blocks will have an X dimension that is larger by 2 units.
| 1  
|
The value must be greater than or equal to 0.


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




|-
|-
| '''Convert Polys To Lines'''<br>''(ConvertPolysToLines)''
| '''Dimensions'''<br>''(Dimensions)''
|  
|
If this property is set to 1, degenerate polygons (a "polygon" with only two distinct point coordinates) will be converted to lines.
This property specifies the X, Y, Z cell dimensions of a block.
 
| 1
| 10
|  
|
Only the values 0 and 1 are accepted.
The value must be greater than or equal to 2 and less than or equal to 64.




|-
|-
| '''Convert Strips To Polys'''<br>''(ConvertStripsToPolys)''
| '''Fractal Value'''<br>''(FractalValue)''
|  
|
If this property is set to 1, degenerate triangle strips (a triangle "strip" containing only one triangle) will be converted to triangles.
The value of this property will be mapped to 0.5 for use as a volume fraction.
 
| 1
| 9.5
|  
|
Only the values 0 and 1 are accepted.
The value must be greater than or equal to 0.




|-
|-
| '''Input'''<br>''(Input)''
| '''Ghost Levels'''<br>''(GhostLevels)''
|  
|
Set the input to the Clean filter.
This property specifies whether ghost levels should be generated at processor boundaries.
|
|
The selected object must be the result of the following: sources (includes readers), filters.


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


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


|-
| '''Maximum Level'''<br>''(MaximumLevel)''
|
This property specifies how many levels of refinement should be included in this hierarchical dataset.


|-
| 5
| '''Piece Invariant'''<br>''(PieceInvariant)''
|
|
The value must be greater than or equal to 1 and less than or equal to 10.
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  
|
Only the values 0 and 1 are accepted.




|-
|-
| '''Point Merging'''<br>''(PointMerging)''
| '''Rectilinear Grids'''<br>''(RectilinearGrids)''
|  
|
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.
If this property is set to 1, the hierarchical dataset will contain rectilinear grids; otherwise it will contain uniform grids.
 
| 1
| 0
|  
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.




|-
|-
| '''Tolerance'''<br>''(Tolerance)''
| '''Time Step'''<br>''(TimeStep)''
|  
|
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.
This property specifies the timestep to use for this dataset.
| 0
|
The value must be greater than or equal to 0 and less than or equal to 1.


| 0
|
|-
| '''Two Dimensional'''<br>''(TwoDimensional)''
|
If this property is set to 1, the generated dataset will be 2D; otherwise it will be 3D.


|-
| 1
| '''Tolerance Is Absolute'''<br>''(ToleranceIsAbsolute)''
|
|
This property determines whether to use absolute or relative (a percentage of the bounding box) tolerance when performing point merging.
| 0
|  
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


Line 679: Line 582:




==Clean to Grid==
==Line==
 


This source creates a line between two points. The resolution indicates how many segments are in the line.


This filter merges points and converts the data set to unstructured grid.
The Line source can be used to interactively (using a 3D widget) or manually (using the entries on the user interface) add a line to the 3D scene. The output of the Line source is polygonal data.<br>
The Clean to Grid filter merges points that are exactly coincident. It also converts the data set to an unstructured grid. You may wish to do this if you want to apply a filter to your data set that is available for unstructured grids but not for the initial type of your data set (e.g., applying warp vector to volumetric data). The Clean to Grid filter operates on any type of data set.<br>
<!-- End of Proxy Documentation -->


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 694: Line 596:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Input'''<br>''(Input)''
| '''Point1'''<br>''(Point1)''
|  
|
This property specifies the input to the Clean to Grid filter.
This property controls the coordinates of the first endpoint of the line.
 
|  
| -0.5 0 0
|  
|
The selected object must be the result of the following: sources (includes readers), filters.
|-
| '''Point2'''<br>''(Point2)''
|
This property controls the coordinates of the second endpoint of the line.


| 0.5 0 0
|
|-
| '''Resolution'''<br>''(Resolution)''
|
This property specifies the number of pieces into which to divide the line.


The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
| 6
|
The value must be greater than or equal to 1.




Line 709: Line 622:




==Clip==
==Mandelbrot==




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.  
Representation (unsigned char) of the Mandlebrot set in up to 3 dimensions
 
The Clip filter cuts away a portion of the input data set using an implicit plane. This filter operates on all types of data sets, and it returns unstructured grid data on output.<br>
The Mandelbrot source can be used to add a uniform rectilinear grid with scalar values derived from the Mandelbrot set to the 3D scene. The equation used is z = z^2 + C (where z and C are complex, and C is a constant). The scalar values in the grid are the number of iterations of the equation it takes for the magnitude of the value to become greater than 2. In the equation, the initial value of z is 0. By default, the real component of C is mapped onto the X axis; the imaginary component of C is mapped onto the Y axis; and the imaginary component of the initial value is mapped onto the Z axis. If a two-dimensional extent is specified, the resulting image will be displayed. If a three-dimensional extent is used, then the bounding box of the volume will be displayed. The output of the Mandelbrot source is image (uniform rectilinear) data.<br>
<!-- End of Proxy Documentation -->


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 724: Line 636:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Clip Type'''<br>''(ClipFunction)''
| '''Maximum Number of Iterations'''<br>''(MaximumNumberOfIterations)''
|  
|
This property specifies the parameters of the clip function (an implicit plane) used to clip the dataset.
The value of this property specifies the limit on computational iterations (i.e., the maximum number of iterations to perform to determine if the value will go above 2). Values less than 2.0 after the specified number of iterations are considered in the fractal set.
 
|  
| 100
|  
|
The value must be set to one of the following: Plane, Box, Sphere, Scalar.
The value must be greater than or equal to 1 and less than or equal to 5000.




|-
|-
| '''Input'''<br>''(Input)''
| '''Origin CX'''<br>''(OriginCX)''
|  
|
This property specifies the dataset on which the Clip filter will operate.
The four values of this property indicate (in order) the components of C (real and imaginary) and the components of the initial value, X (real and imaginary).
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.


| -1.75 -1.25 0 0
|
|-
| '''Projection Axes'''<br>''(ProjectionAxes)''
|
The three values in this property allow you to specify the projection from the 4D space used by the Mandelbrot set to the axes of the 3D volume. By default, the real component of C (represented by 0) is mapped to the X axis; the imaginary component of C (represented by 1) is mapped to the Y axis; and the real component of X, the initial value (represented by 2) is mapped to the Z axis. The imaginary component of X is represented by 3. All values entered must be between 0 and 3, inclusive.


| 0 1 2
|
|-
|-
| '''Inside Out'''<br>''(InsideOut)''
| '''Size CX'''<br>''(SizeCX)''
|  
|
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.
The four values of this property indicate the length of the output in each of the four dimensions (the real and imaginary components of C and the real and imaginary components of X). The three dimensions specified in the Projection Axes property will determine which of these values specify the length of the axes in the output.
| 0
|
Only the values 0 and 1 are accepted.
 


| 2.5 2.5 2 1.5
|
|-
|-
| '''Scalars'''<br>''(SelectInputScalars)''
| '''Subsample Rate'''<br>''(SubsampleRate)''
|  
|
If clipping with scalars, this property specifies the name of the scalar array on which to perform the clip operation.
This property specifies the rate at which to subsample the volume. The extent of the dataset in each dimension will be divided by this value.
|
|
An array of scalars is required.


 
| 1
Valud array names will be chosen from point and cell data.
|
The value must be greater than or equal to 1.




|-
|-
| '''Use Value As Offset'''<br>''(UseValueAsOffset)''
| '''Whole Extent'''<br>''(WholeExtent)''
|  
|
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.
The six values in the property indicate the X, Y, and Z extent of the output data. The first two numbers are the minimum and maximum X extent; the next two are the minimum and maximum Y extent; and the final two are the minimum and maximum Z extent. The numbers are inclusive, so values of 0, 250, 0, 250, 0, 0 indicate that the dimensions of the output will be 251 x 251 x 1.
| 0  
|
Only the values 0 and 1 are accepted.


| 0 250 0 250 0 0
|
|}


|-
| '''Value'''<br>''(Value)''
|
If clipping with scalars, this property sets the scalar value about which to clip the dataset based on the scalar array chosen. (See SelectInputScalars.) If clipping with a clip function, this property specifies an offset from the clip function to use in the clipping operation. Neither functionality is currently available in ParaView's user interface.
| 0
|
The value must lie within the range of the selected data array.


==Octree Fractal==


|}


Test source for octree with Mandelbrot fractal


==Clip Closed Surface==
Create an octree from a Mandelbrot fractal. See the Mandelbrot source for a description of the variables used.<br>
 
 
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.<br>
<!-- End of Proxy Documentation -->


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 807: Line 700:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Base Color'''<br>''(BaseColor)''
| '''Dimension'''<br>''(Dimension)''
|  
|
Specify the color for the faces from the input.
This property specifies the dimensionality of the fractal: 1D - Binary tree line, 2D - Quadtree plane, 3D - Octree volume.
| 0.1 0.1 1
|
The value must be greater than or equal to (0, 0, 0) and less than or equal to (1, 1, 1).


 
| 2
|-
|
| '''Clip Color'''<br>''(ClipColor)''
The value must be greater than or equal to 1 and less than or equal to 3.
|
Specifiy the color for the capping faces (generated on the clipping interface).
| 1 0.11 0.1
|  
The value must be greater than or equal to (0, 0, 0) and less than or equal to (1, 1, 1).




|-
|-
| '''Clipping Plane'''<br>''(ClippingPlane)''
| '''Maximum Level'''<br>''(MaximumLevel)''
|  
|
This property specifies the parameters of the clipping plane used to clip the polygonal data.
This property specifies the maximum refinement level for the grid.
|
|
The value must be set to one of the following: Plane.
 


|-
| 5
| '''Generate Cell Origins'''<br>''(GenerateColorScalars)''
|
|
The value must be greater than or equal to 2 and less than or equal to 11.
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
|
Only the values 0 and 1 are accepted.




|-
|-
| '''Generate Faces'''<br>''(GenerateFaces)''
| '''Maximum Number of Iterations'''<br>''(MaximumNumberOfIterations)''
|  
|
Generate polygonal faces in the output.
The value of this property specifies the limit on computational iterations (i.e., the maximum number of iterations to perform to determine if the value will go above 2). Values less than 2.0 after the specified number of iterations are considered in the fractal set.
| 1
|
Only the values 0 and 1 are accepted.
 


|-
| 100
| '''Generate Outline'''<br>''(GenerateOutline)''
|
|
The value must be greater than or equal to 1 and less than or equal to 5000.
Generate clipping outlines in the output wherever an input face is cut by the clipping plane.
| 0
|
Only the values 0 and 1 are accepted.




|-
|-
| '''Input'''<br>''(Input)''
| '''Minimum Level'''<br>''(MinimumLevel)''
|  
|
This property specifies the dataset on which the Clip filter will operate.
This property specifies the minimum refinement level for the grid.
|
|
The selected object must be the result of the following: sources (includes readers), filters.


| 3
|
The value must be greater than or equal to 1 and less than or equal to 10.


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


|-
| '''Origin CX'''<br>''(OriginCX)''
|
This property specifies the imaginary and real values for C (constant) and X (initial value). See Mandelbrot source for a description of the C and X variables.


| -1.75 -1.25 0 0
|
|-
|-
| '''Inside Out'''<br>''(InsideOut)''
| '''Projection Axes'''<br>''(ProjectionAxes)''
|  
|
If this flag is turned off, the clipper will return the portion of the data that lies within the clipping plane. Otherwise, the clipper will return the portion of the data that lies outside the clipping plane.
This property indicates which axes of the dataset to display. See Mandelbrot source for a description of the possible axes.
| 0
|
Only the values 0 and 1 are accepted.


| 0 1 2
|
|-
| '''Size CX'''<br>''(SizeCX)''
|
The four values of this property indicate the length of the output in each of the four dimensions (the real and imaginary components of C and the real and imaginary components of X). The three dimensions specified in the Projection Axes property will determine which of these values specify the length of the axes in the output.


| 2.5 2.5 2 1.5
|
|-
|-
| '''Clipping Tolerance'''<br>''(Tolerance)''
| '''Threshold'''<br>''(Threshold)''
|  
|
Specify the tolerance for creating new points. A small value might incur degenerate triangles.
This property specifies a threshold value that determines when to subdivide a leaf node.
 
| 1e-06
| 2
|  
|
|}
|}




==Compute Derivatives==
==Outline==
 


3D outline of the specified bounds.


This filter computes derivatives of scalars and vectors.
The Outline source creates an axis aligned bounding box given the user-specified minimum and maximum coordinates for each axis.<br>
CellDerivatives is a filter that computes derivatives of scalars and vectors at the center of cells. You can choose to generate different output including the scalar gradient (a vector), computed tensor vorticity (a vector), gradient of input vectors (a tensor), and strain matrix of the input vectors (a tensor); or you may choose to pass data through to the output.<br>
<!-- End of Proxy Documentation -->


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 914: Line 784:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Input'''<br>''(Input)''
| '''Bounds'''<br>''(Bounds)''
|
|
This property specifies the input to the filter.
The values of this property specify the minimum and maximum X, Y, and Z coordinates (X min, X max, Y min, Y max, Z min, Z max) for drawing the outline.
|
|  
The selected object must be the result of the following: sources (includes readers), filters.


| 0 1 0 1 0 1
|
|}


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


==Plane==


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


Create a parallelogram given an origin and two points. The resolution indicates the number of division along each axis of the plane.


|-
The Plane source can be used to add a polygonal parallelogram to the 3D scene. Unlike the sphere, cone, and cylinder sources, the parallelogram is exactly represented at the lowest resolution, but higher resolutions may be desired if this plane is to be used as an input to a filter. The output of the Plane source is polygonal data.<br>
| '''Output Vector Type'''<br>''(OutputVectorType)''
|
This property Controls how the filter works to generate vector cell data. You can choose to compute the gradient of the input scalars, or extract the vorticity of the computed vector gradient tensor. By default, the filter will take the gradient of the input scalar data.
| 1
|
The value must be one of the following: Nothing (0), Scalar Gradient (1), Vorticity (2).


{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Origin'''<br>''(Origin)''
|
This property specifies the 3D coordinate of the origin (one corner) of the plane.


| -0.5 -0.5 0
|
|-
|-
| '''Scalars'''<br>''(SelectInputScalars)''
| '''Point1'''<br>''(Point1)''
|  
|
This property indicates the name of the scalar array to differentiate.
This property specifies the 3D coordinate a second corner of the parallelogram. The line connecting this point and that specified by the Origin property define one edge of the parallelogram (its X axis).
|
|
An array of scalars is required.


| 0.5 -0.5 0
|
|-
| '''Point2'''<br>''(Point2)''
|
This property specifies the 3D coordinate a third corner of the parallelogram. The line connecting this point and that specified by the Origin property define a second edge of the parallelogram (its Y axis).


| -0.5 0.5 0
|
|-
|-
| '''Vectors'''<br>''(SelectInputVectors)''
| '''X Resolution'''<br>''(XResolution)''
|  
|
This property indicates the name of the vector array to differentiate.
This property specifies the number of divisions along the X axis of the parallelogram.
 
| 1
| 1
|  
|
An array of vectors is required.
The value must be greater than or equal to 1.
 
 
|-
| '''Y Resolution'''<br>''(YResolution)''
|
This property specifies the number of divisions along the Y axis of the parallelogram.
 
| 1
|
The value must be greater than or equal to 1.




Line 969: Line 850:




==Connectivity==
==Point Source==
 


Create a point cloud of a certain size, radius, and center.


Mark connected components with integer point attribute array.
The point source creates a specified number of points within a given radius about a specified center point. <br>
The Connectivity filter assigns a region id to connected components of the input data set. (The region id is assigned as a point scalar value.) This filter takes any data set type as input and produces unstructured grid output.<br>
<!-- End of Proxy Documentation -->


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 984: Line 864:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Color Regions'''<br>''(ColorRegions)''
| '''Center'''<br>''(Center)''
|  
|
Controls the coloring of the connected regions.
This property specifies the 3D coordinates of the center of the point cloud.
| 1
|
Only the values 0 and 1 are accepted.


| 0 0 0
|
|-
| '''Number Of Points'''<br>''(NumberOfPoints)''
|
This property specifies the number of points in the point cloud.


|-
| 1
| '''Extraction Mode'''<br>''(ExtractionMode)''
|
|
The value must be greater than or equal to 1.
Controls the extraction of connected surfaces.
| 5
|  
The value must be one of the following: Extract Point Seeded Regions (1), Extract Cell Seeded Regions (2), Extract Specified Regions (3), Extract Largest Region (4), Extract All Regions (5), Extract Closes Point Region (6).




|-
|-
| '''Input'''<br>''(Input)''
| '''Radius'''<br>''(Radius)''
|  
|
This property specifies the input to the Connectivity filter.
This property specifies the radius of the point cloud, measured from the value of the Center property.
|
|
The selected object must be the result of the following: sources (includes readers), filters.


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


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


|}


|}


==Programmable Source==


==Contingency Statistics==


Executes a user supplied python script to produce an output dataset.


Compute a statistical model of a dataset and/or assess the dataset with a statistical model.
This source will execute a python script to produce an output dataset.<br>
The source keeps a copy of the python script in Script, and creates <br>
This filter either computes a statistical model of a dataset or takes such a model as its second input. Then, the model (however it is obtained) may optionally be used to assess the input dataset.<br>
Interpretor, a python interpretor to run the script upon the first <br>
This filter computes contingency tables between pairs of attributes. This result is a tabular bivariate probability distribution which serves as a Bayesian-style prior model. Data is assessed by computing <br>
execution.<br>
*  the probability of observing both variables simultaneously;<br>
*  the probability of each variable conditioned on the other (the two values need not be identical); and<br>
*  the pointwise mutual information (PMI).
<br>
Finally, the summary statistics include the information entropy of the observations.<br>
<!-- End of Proxy Documentation -->


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,040: Line 910:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Attribute Mode'''<br>''(AttributeMode)''
| '''Script (RequestInformation)'''<br>''(InformationScript)''
|  
|
Specify which type of field data the arrays will be drawn from.
This property is a python script that is executed during the RequestInformation pipeline pass. Use this to provide information such as WHOLE_EXTENT to the pipeline downstream.
| 0
|
Valud array names will be chosen from point and cell data.
 


|
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Output Data Set Type'''<br>''(OutputDataSetType)''
|  
|
The input to the filter. Arrays from this dataset will be used for computing statistics and/or assessed by a statistical model.
The value of this property determines the dataset type for the output of the programmable source.
|
|
The selected object must be the result of the following: sources (includes readers), filters.


| 0
|
The value must be one of the following: Same as Input (8), vtkPolyData (0), vtkStructuredGrid (2), vtkRectilinearGrid (3), vtkUnstructuredGrid (4), vtkImageData (6), vtkMultiblockDataSet (13), vtkHierarchicalBoxDataSet (15), vtkTable (19).


The dataset must contain a point or cell array.


|-
| '''Python Path'''<br>''(PythonPath)''
|
A semi-colon (;) separated list of directories to add to the python library
search path.


The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData, vtkStructuredGrid, vtkPolyData, vtkUnstructuredGrid, vtkTable, vtkGraph.
|
|
|-
| '''Script'''<br>''(Script)''
|
This property contains the text of a python program that the programmable source runs.
 
|
|
|}




|-
==Ruler==
| '''Model Input'''<br>''(ModelInput)''
|
A previously-calculated model with which to assess a separate dataset. This input is optional.
|
|
The selected object must be the result of the following: sources (includes readers), filters.




The selected dataset must be one of the following types (or a subclass of one of them): vtkTable, vtkMultiBlockDataSet.
This is a line source that can be used to measure distance between two points


The ruler can be used to interactively (using a 3D widget) or manually<br>
(using the entries on the user interface) specify two points and then<br>
determine the distance between the two points. To place points on the<br>
surface of any dataset, one can use the 'p' key shortcut.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Variables of Interest'''<br>''(SelectArrays)''
| '''Property'''
|  
| '''Description'''
Choose arrays whose entries will be used to form observations for statistical analysis.
| '''Default Value(s)'''
| '''Restrictions'''
|
|
An array of scalars is required.
 
 
|-
|-
| '''Task'''<br>''(Task)''
| '''Point1'''<br>''(Point1)''
|  
|
Specify the task to be performed: modeling and/or assessment.
This property controls the coordinates of the first endpoint of the line.
#  "Statistics of all the data," creates an output table (or tables) summarizing the '''entire''' input dataset;
#  "Model a subset of the data," creates an output table (or tables) summarizing a '''randomly-chosen subset''' of the input dataset;
#  "Assess the data with a model," adds attributes to the first input dataset using a model provided on the second input port; and
#  "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.
 
When the task includes creating a model (i.e., tasks 2, and 4), you may adjust the fraction of the input dataset used for training. You should avoid using a large fraction of the input data for training as you will then not be able to detect overfitting. The ''Training fraction'' setting will be ignored for tasks 1 and 3.
| 3
|
The value must be one of the following: Statistics of all the data (0), Model a subset of the data (1), Assess the data with a model (2), Model and assess the same data (3).
 


| -0.5 0 0
|
|-
|-
| '''Training Fraction'''<br>''(TrainingFraction)''
| '''Point2'''<br>''(Point2)''
|  
|
Specify the fraction of values from the input dataset to be used for model fitting. The exact set of values is chosen at random from the dataset.
This property controls the coordinates of the second endpoint of the line.
| 0.1
|
The value must be greater than or equal to 0 and less than or equal to 1.


| 0.5 0 0
|
|}


|}


==Sphere==


==Contour==


Create a 3D sphere given a center and radius.


Generate isolines or isosurfaces using point scalars.
The Sphere source can be used to add a polygonal sphere to the 3D scene. The output of the Sphere source is polygonal data with point normals defined.<br>
The Contour filter computes isolines or isosurfaces using a selected point-centered scalar array. The Contour filter operates on any type of data set, but the input is required to have at least one point-centered scalar (single-component) array. The output of this filter is polygonal.<br>
<!-- End of Proxy Documentation -->


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,132: Line 991:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Compute Gradients'''<br>''(ComputeGradients)''
| '''Center'''<br>''(Center)''
|  
|
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.
This property specifies the 3D coordinates for the center of the sphere.
| 0
|
Only the values 0 and 1 are accepted.


| 0 0 0
|
|-
| '''End Phi'''<br>''(EndPhi)''
|
The value of this property can be adjusted to form only a portion of a sphere. The value is measured in degrees.


|-
| 180
| '''Compute Normals'''<br>''(ComputeNormals)''
|
|
The value must be greater than or equal to 0 and less than or equal to 180.
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
|
Only the values 0 and 1 are accepted.




|-
|-
| '''Compute Scalars'''<br>''(ComputeScalars)''
| '''End Theta'''<br>''(EndTheta)''
|  
|
If this property is set to 1, an array of scalars (containing the contour value) will be added to the output dataset. If set to 0, the output will not contain this array.
The value of this property can be adjusted to form only a portion of a sphere. This value is measured in degrees.
 
| 0
| 360
|  
|
Only the values 0 and 1 are accepted.
The value must be greater than or equal to 0 and less than or equal to 360.




|-
|-
| '''Isosurfaces'''<br>''(ContourValues)''
| '''Phi Resolution'''<br>''(PhiResolution)''
|  
|
This property specifies the values at which to compute isosurfaces/isolines and also the number of such values.
The value of this property represents the number of divisions between Start Phi and End Phi on the sphere. (See the Start Phi and End Phi properties.) The phi divisions are similar to latitude lines on the earth.
 
|  
| 8
|  
|
The value must lie within the range of the selected data array.
The value must be greater than or equal to 3.




|-
|-
| '''Input'''<br>''(Input)''
| '''Radius'''<br>''(Radius)''
|  
|
This property specifies the input dataset to be used by the contour filter.
This property specifies the radius of the sphere.
|
|
The selected object must be the result of the following: sources (includes readers), filters.


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


The dataset must contain a point array with 1 components.


|-
| '''Start Phi'''<br>''(StartPhi)''
|
To form a complete sphere, the value of this property should be 0 degrees, and the value of the End Phi property should be 180 degrees. The value of this property can be adjusted to form only a portion of a sphere.
Set the starting angle (in degrees) in the latitudinal direction.


The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
| 0
|
The value must be greater than or equal to 0 and less than or equal to 180.




|-
|-
| '''Point Merge Method'''<br>''(Locator)''
| '''Start Theta'''<br>''(StartTheta)''
|  
|
This property specifies an incremental point locator for merging duplicate / coincident points.
To form a complete sphere, the value of this property should be 0 degrees, and the value of the End Theta property should be 360 degrees. The value of this property can be adjusted to form only a portion of a sphere.
|
|
The selected object must be the result of the following: incremental_point_locators.


 
| 0
The value must be set to one of the following: MergePoints, IncrementalOctreeMergePoints, NonMergingPointLocator.
|
The value must be greater than or equal to 0 and less than or equal to 360.




|-
|-
| '''Contour By'''<br>''(SelectInputScalars)''
| '''Theta Resolution'''<br>''(ThetaResolution)''
|  
|
This property specifies the name of the scalar array from which the contour filter will compute isolines and/or isosurfaces.
The value of this property represents the number of divisions between Start Theta and End Theta around the sphere. (See the Start Theta and End Theta properties.) The theta divisions are similar to longitude lines on the earth. The higher the resolution, the closer the approximation will come to a sphere, and the more polygons there will be.
|
|
An array of scalars is required.


| 8
|
The value must be greater than or equal to 3.


Valud array names will be chosen from point and cell data.


|}


|}


==SplineSource==


==Curvature==


Tessellate parametric functions.


This filter will compute the Gaussian or mean curvature of the mesh at each point.  
This class tessellates parametric functions. The user must specify how<br>
many points in the parametric coordinate directions are required (i.e.,<br>
The Curvature filter computes the curvature at each point in a polygonal data set. This filter supports both Gaussian and mean curvatures.<br><br><br>
the resolution), and the mode to use to generate scalars.<br>
; the type can be selected from the Curvature type menu button.<br>
<!-- End of Proxy Documentation -->


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,233: Line 1,087:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Curvature Type'''<br>''(CurvatureType)''
| '''Parametric Function'''<br>''(ParametricFunction)''
|  
|
This propery specifies which type of curvature to compute.
|
|
| 0
The value must be set to one of the following: Spline.
|  
The value must be one of the following: Gaussian (0), Mean (1).




|-
|}
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Curvature filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
 
 
|-
| '''Invert Mean Curvature'''<br>''(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
|
Only the values 0 and 1 are accepted.
 


|}


==Superquadric==


==D3==


Create a superquadric according to the theta and phi roundness parameters. This one source can generate a wide variety of 3D objects including a box, a sphere, or a torus.


Repartition a data set into load-balanced spatially convex regions. Create ghost cells if requested.  
The Superquadric source can be used to add a polygonal superquadric to the 3D scene. This source can be used to create a wide variety of shapes (e.g., a sphere, a box, or a torus) by adjusting the roundness parameters. The output of the Superquadric source is polygonal data with point normals and texture coordinates defined.<br>
The D3 filter is available when ParaView is run in parallel. It operates on any type of data set to evenly divide it across the processors into spatially contiguous regions. The output of this filter is of type unstructured grid.<br>
<!-- End of Proxy Documentation -->


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,283: Line 1,111:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Boundary Mode'''<br>''(BoundaryMode)''
| '''Center'''<br>''(Center)''
|  
|
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.
This property specifies the 3D coordinates of the center of the superquadric.
 
| 0
| 0 0 0
|  
|
The value must be one of the following: Assign cells uniquely (0), Duplicate cells (1), Divide cells (2).
|-
| '''Phi Resolution'''<br>''(PhiResolution)''
|
The value of this property represents the number of divisions in the phi (latitudinal) direction. This number will be rounded to the nearest multiple of 4.
 
| 16
|
The value must be greater than or equal to 4 and less than or equal to 1024.




|-
|-
| '''Input'''<br>''(Input)''
| '''Phi Roundness'''<br>''(PhiRoundness)''
|  
|
This property specifies the input to the D3 filter.
This property defines the roundness in the phi (latitudinal) direction. A value of 0 represents a rectangular shape, a value of 1 represents a circular shape, and values greater than 1 produce higher order shapes.
|
|
The selected object must be the result of the following: sources (includes readers), filters.


| 1
|
The value must be greater than or equal to 0.01.


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


|-
| '''Scale'''<br>''(Scale)''
|
The three values in this property are used to scale the superquadric in X, Y, and Z. The surface normals will be computed correctly even with anisotropic scaling.


| 1 1 1
|
|-
|-
| '''Minimal Memory'''<br>''(UseMinimalMemory)''
| '''Size'''<br>''(Size)''
|  
|
If this property is set to 1, the D3 filter requires communication routines to use minimal memory than without this restriction.
The value of this property represents the isotropic size of the superquadric. Note that both the Size and Thickness properties control coefficients of superquadric generation, so the value of this property may not exactly describe the size of the superquadric.
| 0
|
Only the values 0 and 1 are accepted.


| 0.5
|
|-
| '''Theta Resolution'''<br>''(ThetaResolution)''
|
The value of this property represents the number of divisions in the theta (longitudinal) direction. This value will be rounded to the nearest multiple of 8.


|}
| 16
|
The value must be greater than or equal to 8 and less than or equal to 1024.




==Decimate==
|-
| '''Theta Roundness'''<br>''(ThetaRoundness)''
|
This property defines the roundness of the superquadric in the theta (longitudinal) direction. A value of 0 represents a rectangular shape, a value of 1 represents a circular shape, and values greater than 1 produce higher order shapes.


| 1
|
The value must be greater than or equal to 0.01.


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


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Thickness'''<br>''(Thickness)''
| '''Description'''
|
| '''Default Value(s)'''
If the value of the Toroidal property is 1, this value represents the thickness of the superquadric as a value between 0 and 1. A value close to 0 leads to a thin object with a large hole, and a value near 1 leads to a thick object with a very small hole. Changing the thickness does not change the outer radius of the superquadric.
| '''Restrictions'''
 
| 0.3333
|
The value must be greater than or equal to 0.0001 and less than or equal to 1.
 
 
|-
|-
| '''Boundary Vertex Deletion'''<br>''(BoundaryVertexDeletion)''
| '''Toroidal'''<br>''(Toroidal)''
|  
|
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.
If the value of this property is 0, the generated superquadric will not contain a hole (i.e., the superquadric will be ellipsoidal). Otherwise, a toroidal object is generated.
 
| 1  
| 1
|  
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.




|-
|}
| '''Feature Angle'''<br>''(FeatureAngle)''
|
The value of thie property is used in determining where the data set may be split. If the angle between two adjacent triangles is greater than or equal to the FeatureAngle value, then their boundary is considered a feature edge where the dataset can be split.
| 15
|
The value must be greater than or equal to 0 and less than or equal to 180.




|-
==Text==
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Decimate filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.




The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
The Text source generates a table containing text.


The Text source is used to generate a 1x1 vtkTable with a single text string.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Preserve Topology'''<br>''(PreserveTopology)''
| '''Property'''
|  
| '''Description'''
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.
| '''Default Value(s)'''
| '''Restrictions'''
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
|-
| '''Target Reduction'''<br>''(TargetReduction)''
| '''Text'''<br>''(Text)''
|  
|
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.)
This property specifies the text to display.
| 0.9
|
The value must be greater than or equal to 0 and less than or equal to 1.


| Text
|
|}


|}


==Time Source==


==Delaunay 2D==


Produces a single cell uniform grid with data values that vary over a sin(t) wave from t=0 to t=1 (radian).


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,409: Line 1,232:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Alpha'''<br>''(Alpha)''
| '''Analytic'''<br>''(Analytic)''
|  
|
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.
Makes the time source produce discrete steps of or an analytic sin wave.
| 0
|
The value must be greater than or equal to 0.
 


|-
| 0
| '''Bounding Triangulation'''<br>''(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  
|  
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.




|-
|-
| '''Input'''<br>''(Input)''
| '''Growing'''<br>''(Growing)''
|  
|
This property specifies the input dataset to the Delaunay 2D filter.
Makes the time source grow and shrink along Y over time.
|
|
The selected object must be the result of the following: sources (includes readers), filters.


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


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


|-
| '''X Amplitude'''<br>''(X Amplitude)''
|
Controls how far the data set moves along X over time.


| 0
|
|-
|-
| '''Offset'''<br>''(Offset)''
| '''Y Amplitude'''<br>''(Y Amplitude)''
|  
|
This property is a multiplier to control the size of the initial, bounding Delaunay triangulation.
Controls how far the data set moves along Y over time.
| 1
|
The value must be greater than or equal to 0.75.


| 0
|
|}


|-
| '''Projection Plane Mode'''<br>''(ProjectionPlaneMode)''
|
This property determines type of projection plane to use in performing the triangulation.
| 0
|
The value must be one of the following: XY Plane (0), Best-Fitting Plane (2).
|-
| '''Tolerance'''<br>''(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.
| 1e-05
|
The value must be greater than or equal to 0 and less than or equal to 1.
|}


==Wavelet==


==Delaunay 3D==


Create a regular rectilinear grid in up to three dimensions with values varying according to a periodic function.


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,548: Line 1,284:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Alpha'''<br>''(Alpha)''
| '''Center'''<br>''(Center)''
|  
|
This property specifies the alpha (or distance) value to control
This property specifies the 3D coordinates of the center of the dataset.
the output of this filter. For a non-zero alpha value, only
edges, faces, or tetra contained within the circumsphere (of
radius alpha) will be output. Otherwise, only tetrahedra will be
output.
| 0
|
The value must be greater than or equal to 0.


| 0 0 0
|
|-
| '''Maximum'''<br>''(Maximum)''
|
This parameter specifies the maximum value (M) of the function.


| 255
|
|-
|-
| '''Bounding Triangulation'''<br>''(BoundingTriangulation)''
| '''Standard Deviation'''<br>''(StandardDeviation)''
|  
|
This boolean controls whether bounding triangulation points (and
This property specifies the standard deviation of the Gaussian used in computing this function.
associated triangles) are included in the output. (These are
introduced as an initial triangulation to begin the triangulation
process. This feature is nice for debugging output.)
| 0
|
Only the values 0 and 1 are accepted.
 


| 0.5
|
|-
|-
| '''Input'''<br>''(Input)''
| '''Subsample Rate'''<br>''(SubsampleRate)''
|  
|
This property specifies the input dataset to the Delaunay 3D filter.
This property specifies the rate at which to subsample the volume. The extent of the dataset in each dimension will be divided by this value. (See the Whole Extent property.)
|
|
The selected object must be the result of the following: sources (includes readers), filters.


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


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


|-
| '''Whole Extent'''<br>''(WholeExtent)''
|
The six values in this property indicate the X, Y, and Z extent of the output data. The first two values represent the minimum and maximum X indices, the next two are the minimum and maximum Y indices, and the last two are the minimum and maximum Z indices.


| -10 10 -10 10 -10 10
|
|-
|-
| '''Offset'''<br>''(Offset)''
| '''X Freq'''<br>''(XFreq)''
|  
|
This property specifies a multiplier to control the size of the
This property specifies the natural frequency in X (XF in the equation).
initial, bounding Delaunay triangulation.
| 2.5
|
The value must be greater than or equal to 2.5.


| 60
|
|-
| '''X Mag'''<br>''(XMag)''
|
This property specifies the wave amplitude in X (XM in the equation).


| 10
|
|-
|-
| '''Tolerance'''<br>''(Tolerance)''
| '''Y Freq'''<br>''(YFreq)''
|  
|
This property specifies a tolerance to control discarding of
This property specifies the natural frequency in Y (YF in the equation).
closely spaced points. This tolerance is specified as a fraction
of the diagonal length of the bounding box of the points.
| 0.001
|
The value must be greater than or equal to 0 and less than or equal to 1.


| 30
|
|-
| '''Y Mag'''<br>''(YMag)''
|
This property specifies the wave amplitude in Y (YM in the equation).


|}
| 18
|
|-
| '''Z Freq'''<br>''(ZFreq)''
|
This property specifies the natural frequency in Z (ZF in the equation).


 
| 40
==Descriptive Statistics==
|
 
 
Compute a statistical model of a dataset and/or assess the dataset with a statistical model.
This filter either computes a statistical model of a dataset or takes such a model as its second input. Then, the model (however it is obtained) may optionally be used to assess the input dataset.
<br>
This filter computes the min, max, mean, raw moments M2 through M4, standard deviation, skewness, and kurtosis for each array you select.
 
<br>
The model is simply a univariate Gaussian distribution with the mean and standard deviation provided. Data is assessed using this model by detrending the data (i.e., subtracting the mean) and then dividing by the standard deviation. Thus the assessment is an array whose entries are the number of standard deviations from the mean that each input point lies.<br>
 
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Z Mag'''<br>''(ZMag)''
| '''Description'''
|
| '''Default Value(s)'''
This property specifies the wave amplitude in Z (ZM in the equation).
| '''Restrictions'''
|-
| '''Attribute Mode'''<br>''(AttributeMode)''
|
Specify which type of field data the arrays will be drawn from.
| 0
|
Valud array names will be chosen from point and cell data.
 
 
|-
| '''Input'''<br>''(Input)''
|
The input to the filter. Arrays from this dataset will be used for computing statistics and/or assessed by a statistical model.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point or cell array.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData, vtkStructuredGrid, vtkPolyData, vtkUnstructuredGrid, vtkTable, vtkGraph.
 
 
|-
| '''Model Input'''<br>''(ModelInput)''
|
A previously-calculated model with which to assess a separate dataset. This input is optional.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkTable, vtkMultiBlockDataSet.
 
 
|-
| '''Variables of Interest'''<br>''(SelectArrays)''
|
Choose arrays whose entries will be used to form observations for statistical analysis.
|
|
An array of scalars is required.
 
 
|-
| '''Deviations should be'''<br>''(SignedDeviations)''
|
Should the assessed values be signed deviations or unsigned?
| 0
|
The value must be one of the following: Unsigned (0), Signed (1).
 
 
|-
| '''Task'''<br>''(Task)''
|
Specify the task to be performed: modeling and/or assessment.
#  "Statistics of all the data," creates an output table (or tables) summarizing the '''entire''' input dataset;
#  "Model a subset of the data," creates an output table (or tables) summarizing a '''randomly-chosen subset''' of the input dataset;
#  "Assess the data with a model," adds attributes to the first input dataset using a model provided on the second input port; and
#  "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.
 
When the task includes creating a model (i.e., tasks 2, and 4), you may adjust the fraction of the input dataset used for training. You should avoid using a large fraction of the input data for training as you will then not be able to detect overfitting. The ''Training fraction'' setting will be ignored for tasks 1 and 3.
| 3
|
The value must be one of the following: Statistics of all the data (0), Model a subset of the data (1), Assess the data with a model (2), Model and assess the same data (3).
 
 
|-
| '''Training Fraction'''<br>''(TrainingFraction)''
|
Specify the fraction of values from the input dataset to be used for model fitting. The exact set of values is chosen at random from the dataset.
| 0.1
|
The value must be greater than or equal to 0 and less than or equal to 1.
 
 
|}
 
 
==Elevation==
 
 
Create point attribute array by projecting points onto an elevation vector.
The Elevation filter generates point scalar values for an input dataset along a specified direction vector.<br><br><br>
The Input menu allows the user to select the data set to which this filter will be applied. Use the Scalar range entry boxes to specify the minimum and maximum scalar value to be generated. The Low Point and High Point define a line onto which each point of the data set is projected. The minimum scalar value is associated with the Low Point, and the maximum scalar value is associated with the High Point. The scalar value for each point in the data set is determined by the location along the line to which that point projects.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''High Point'''<br>''(HighPoint)''
|
This property defines the other end of the direction vector (large scalar values).
| 0 0 1
|
The coordinate must lie within the bounding box of the dataset. It will default to the maximum in each dimension.
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input dataset to the Elevation filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Low Point'''<br>''(LowPoint)''
|
This property defines one end of the direction vector (small scalar values).
| 0 0 0
|
The coordinate must lie within the bounding box of the dataset. It will default to the minimum in each dimension.
 
 
|-
| '''Scalar Range'''<br>''(ScalarRange)''
|
This property determines the range into which scalars will be mapped.
| 0 1
|
|}
 
 
==Extract AMR Blocks==
 
 
This filter extracts a list of datasets from hierarchical datasets.
This filter extracts a list of datasets from hierarchical datasets.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Extract Datasets filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkHierarchicalBoxDataSet.
 
 
|-
| '''Selected Data Sets'''<br>''(SelectedDataSets)''
|
This property provides a list of datasets to extract.
|
|
|}
 
 
==Extract Block==
 
 
This filter extracts a range of blocks from a multiblock dataset.
This filter extracts a range of groups from a multiblock dataset<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Block Indices'''<br>''(BlockIndices)''
|
This property lists the ids of the blocks to extract
from the input multiblock dataset.
|
|
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Extract Group filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkMultiBlockDataSet.
 
 
|-
| '''Maintain Structure'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Prune Output'''<br>''(PruneOutput)''
|
When set, the output mutliblock dataset will be pruned to remove empty
nodes. On by default.
| 1
|
Only the values 0 and 1 are accepted.
 
 
|}
 
 
==Extract CTH Parts==
 
 
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.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Double Volume Arrays'''<br>''(AddDoubleVolumeArrayName)''
|
This property specifies the name(s) of the volume fraction array(s) for generating parts.
|
|
An array of scalars is required.
 
 
|-
| '''Float Volume Arrays'''<br>''(AddFloatVolumeArrayName)''
|
This property specifies the name(s) of the volume fraction array(s) for generating parts.
|
|
An array of scalars is required.
 
 
|-
| '''Unsigned Character Volume Arrays'''<br>''(AddUnsignedCharVolumeArrayName)''
|
This property specifies the name(s) of the volume fraction array(s) for generating parts.
|
|
An array of scalars is required.
 
 
|-
| '''Clip Type'''<br>''(ClipPlane)''
|
This property specifies whether to clip the dataset, and if so, it also specifies the parameters of the plane with which to clip.
|
|
The value must be set to one of the following: None, Plane, Box, Sphere.
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Extract CTH Parts filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a cell array with 1 components.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Volume Fraction Value'''<br>''(VolumeFractionSurfaceValue)''
|
The value of this property is the volume fraction value for the surface.
| 0.1
|
The value must be greater than or equal to 0 and less than or equal to 1.
 
 
|}
 
 
==Extract Cells By Region==
 
 
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.<br>
To use this filter you must specify a region (implicit function). You must also specify whethter to extract cells lying inside or outside of the region. An option exists to extract cells that are neither inside or outside (i.e., boundary).<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Extract intersected'''<br>''(Extract intersected)''
|
This parameter controls whether to extract cells that are on the boundary of the region.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Extract only intersected'''<br>''(Extract only intersected)''
|
This parameter controls whether to extract only cells that are on the boundary of the region. If this parameter is set, the Extraction Side parameter is ignored. If Extract Intersected is off, this parameter has no effect.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Extraction Side'''<br>''(ExtractInside)''
|
This parameter controls whether to extract cells that are inside or outside the region.
| 1
|
The value must be one of the following: outside (0), inside (1).
 
 
|-
| '''Intersect With'''<br>''(ImplicitFunction)''
|
This property sets the region used to extract cells.
|
|
The value must be set to one of the following: Plane, Box, Sphere.
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Slice filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|}
 
 
==Extract Edges==
 
 
Extract edges of 2D and 3D cells as lines.
The Extract Edges filter produces a wireframe version of the input dataset by extracting all the edges of the dataset's cells as lines. This filter operates on any type of data set and produces polygonal output.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Extract Edges filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|}
 
 
==Extract Level==
 
 
This filter extracts a range of groups from a hierarchical dataset.
This filter extracts a range of levels from a hierarchical dataset<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Extract Group filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkHierarchicalBoxDataSet.
 
 
|-
| '''Levels'''<br>''(Levels)''
|
This property lists the levels to extract
from the input hierarchical dataset.
|
|
|}
 
 
==Extract Selection==
 
 
Extract different type of selections.
This filter extracts a set of cells/points given a selection.<br>
The selection can be obtained from a rubber-band selection<br>
(either cell, visible or in a frustum) or threshold selection<br>
and passed to the filter or specified by providing an ID list.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input from which the selection is extracted.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet, vtkTable.
 
 
|-
| '''Preserve Topology'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Selection'''<br>''(Selection)''
|
The input that provides the selection object.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkSelection.
 
 
|-
| '''Show Bounds'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|}
 
 
==Extract Subset==
 
 
Extract a subgrid from a structured grid with the option of setting subsample strides.
The Extract Grid filter returns a subgrid of a structured input data set (uniform rectilinear, curvilinear, or nonuniform rectilinear). The output data set type of this filter is the same as the input type.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Include Boundary'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Extract Grid filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData, vtkRectilinearGrid, vtkStructuredPoints, vtkStructuredGrid.
 
 
|-
| '''Sample Rate I'''<br>''(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
|
The value must be greater than or equal to 1.
 
 
|-
| '''Sample Rate J'''<br>''(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
|
The value must be greater than or equal to 1.
 
 
|-
| '''Sample Rate K'''<br>''(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
|
The value must be greater than or equal to 1.
 
 
|-
| '''V OI'''<br>''(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
|
The values must lie within the extent of the input dataset.
 
 
|}
 
 
==Extract Surface==
 
 
Extract a 2D boundary surface using neighbor relations to eliminate internal faces.
The Extract Surface filter extracts the polygons forming the outer surface of the input dataset. This filter operates on any type of data and produces polygonal data as output.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Extract Surface filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Nonlinear Subdivision Level'''<br>''(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
|
The value must be greater than or equal to 0 and less than or equal to 4.
 
 
|-
| '''Piece Invariant'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|}
 
 
==FFT Of Selection Over Time==
 
 
Extracts selection over time and plots the FFT
Extracts the data of a selection (e.g. points or cells) over time,<br>
takes the FFT of them, and plots them.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
The input from which the selection is extracted.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet, vtkTable, vtkCompositeDataSet.
 
 
|-
| '''Selection'''<br>''(Selection)''
|
The input that provides the selection object.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkSelection.
 
 
|}
 
 
==FOF/SOD Halo Finder==
 
 
Sorry, no help is currently available.
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''bb (linking length)'''<br>''(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.2
|
The value must be greater than or equal to 0.
 
 
|-
| '''Compute the most bound particle'''<br>''(ComputeMostBoundParticle)''
|
If checked, the most bound particle for an FOF halo will be calculated. WARNING: This can be very slow.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Compute the most connected particle'''<br>''(ComputeMostConnectedParticle)''
|
If checked, the most connected particle for an FOF halo will be calculated. WARNING: This can be very slow.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Compute spherical overdensity (SOD) halos'''<br>''(ComputeSOD)''
|
If checked, spherical overdensity (SOD) halos will be calculated in addition to friends-of-friends (FOF) halos.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Copy FOF halo catalog to original particles'''<br>''(CopyHaloDataToParticles)''
|
If checked, the friends-of-friends (FOF) halo catalog information will be copied to the original particles as well.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Input'''<br>''(Input)''
|
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkUnstructuredGrid.
 
 
|-
| '''np (number of seeded particles in one dimension, i.e., total particles = np^3)'''<br>''(NP)''
|
Number of seeded particles in one dimension. Therefore, total simulation particles is np^3 (cubed).
| 256
|
The value must be greater than or equal to 0.
 
 
|-
| '''overlap (shared point/ghost cell gap distance)'''<br>''(Overlap)''
|
The space (in rL units) to extend processor particle ownership for ghost particles/cells. Needed for correct halo calculation when halos cross processor boundaries in parallel computation.
| 5
|
The value must be greater than or equal to 0.
 
 
|-
| '''pmin (minimum particle threshold for an FOF halo)'''<br>''(PMin)''
|
Minimum number of particles (threshold) needed before a group is called a friends-of-friends (FOF) halo.
| 100
|
The value must be greater than or equal to 1.
 
 
|-
| '''rL (physical box side length)'''<br>''(RL)''
|
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).
| 100
|
The value must be greater than or equal to 0.
 
 
|-
| '''scale factor for rho_c'''<br>''(RhoCScale)''
|
Scale factor for rho_c in SOD halo finding such that rho_c' = rho_c * scale factor. Initial rho_c is 2.77536627e11 (M_sun/h) / (Mpc/h)^3.
| 1
|
|-
| '''initial SOD center'''<br>''(SODCenterType)''
|
The initial friends-of-friends (FOF) center used for calculating a spherical overdensity (SOD) halo. WARNING: Using MBP or MCP can be very slow.
| 0
|
The value must be one of the following: Center of mass (0), Average position (1), Most bound particle (2), Most connected particle (3).
 
 
|-
| '''scale factor for initial SOD mass'''<br>''(SODMassScale)''
|
Scale factor for the initial SOD mass such that mass' = mass * scale factor. Initial SOD mass is 1.0e14 (M_sun/h).
| 1
|
|}
 
 
==Feature Edges==
 
 
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.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Boundary Edges'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Coloring'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Feature Angle'''<br>''(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
|
The value must be greater than or equal to 0 and less than or equal to 180.
 
 
|-
| '''Feature Edges'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Feature Edges filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
 
 
|-
| '''Manifold Edges'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Non-Manifold Edges'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|}
 
 
==Generate 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.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Array Name'''<br>''(ArrayName)''
|
The name of the array that will contain ids.
| Ids
|
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Cell Data to Point Data filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|}
 
 
==Generate Quadrature Points==
 
 
Create a point set with data at quadrature points.
"Create a point set with data at quadrature points."<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a cell array.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkUnstructuredGrid.
 
 
|-
| '''Select Source Array'''<br>''(SelectSourceArray)''
|
Specifies the offset array from which we generate quadrature points.
|
|
An array of scalars is required.
 
 
|}
 
 
==Generate Quadrature Scheme Dictionary==
 
 
Generate quadrature scheme dictionaries in data sets that do not have them.
Generate quadrature scheme dictionaries in data sets that do not have them.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkUnstructuredGrid.
 
 
|}
 
 
==Generate Surface Normals==
 
 
This filter will produce surface normals used for smooth shading. Splitting is used to avoid smoothing across feature edges.
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.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Compute Cell Normals'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Consistency'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Feature Angle'''<br>''(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
|
The value must be greater than or equal to 0 and less than or equal to 180.
 
 
|-
| '''Flip Normals'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Normals Generation filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
 
 
|-
| '''Non-Manifold Traversal'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Piece Invariant'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Splitting'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|}
 
 
==Glyph==
 
 
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.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Glyph Transform'''<br>''(GlyphTransform)''
|
The values in this property allow you to specify the transform
(translation, rotation, and scaling) to apply to the glyph source.
|
|
The value must be set to one of the following: Transform2.
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Glyph filter. This is the dataset to which the glyphs will be applied.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Maximum Number of Points'''<br>''(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
|
The value must be greater than or equal to 0.
 
 
|-
| '''Random Mode'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Scalars'''<br>''(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.)
|
|
An array of scalars is required.
 
 
|-
| '''Vectors'''<br>''(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
|
An array of vectors is required.
 
 
|-
| '''Orient'''<br>''(SetOrient)''
|
If this property is set to 1, the glyphs will be oriented based on the selected vector array.
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Set Scale Factor'''<br>''(SetScaleFactor)''
|
The value of this property will be used as a multiplier for scaling the glyphs before adding them to the output.
| 1
|
The value must be less than the largest dimension of the dataset multiplied by a scale factor of 0.1.
 
 
The value must lie within the range of the selected data array.
 
 
The value must lie within the range of the selected data array.
 
 
|-
| '''Scale Mode'''<br>''(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
|
The value must be one of the following: scalar (0), vector (1), vector_components (2), off (3).
 
 
|-
| '''Glyph Type'''<br>''(Source)''
|
This property determines which type of glyph will be placed at the points in the input dataset.
|
|
The selected object must be the result of the following: sources (includes readers), glyph_sources.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
 
 
The value must be set to one of the following: ArrowSource, ConeSource, CubeSource, CylinderSource, LineSource, SphereSource, GlyphSource2D.
 
 
|-
| '''Mask Points'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|}
 
 
==Glyph With Custom Source==
 
 
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.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Glyph filter. This is the dataset to which the glyphs will be applied.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Maximum Number of Points'''<br>''(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
|
The value must be greater than or equal to 0.
 
 
|-
| '''Random Mode'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Scalars'''<br>''(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.)
|
|
An array of scalars is required.
 
 
|-
| '''Vectors'''<br>''(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
|
An array of vectors is required.
 
 
|-
| '''Orient'''<br>''(SetOrient)''
|
If this property is set to 1, the glyphs will be oriented based on the selected vector array.
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Set Scale Factor'''<br>''(SetScaleFactor)''
|
The value of this property will be used as a multiplier for scaling the glyphs before adding them to the output.
| 1
|
The value must be less than the largest dimension of the dataset multiplied by a scale factor of 0.1.
 
 
The value must lie within the range of the selected data array.
 
 
The value must lie within the range of the selected data array.
 
 
|-
| '''Scale Mode'''<br>''(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
|
The value must be one of the following: scalar (0), vector (1), vector_components (2), off (3).
 
 
|-
| '''Glyph Type'''<br>''(Source)''
|
This property determines which type of glyph will be placed at the points in the input dataset.
|
|
The selected object must be the result of the following: sources (includes readers), glyph_sources.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
 
 
|-
| '''Mask Points'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|}
 
 
==Gradient==
 
 
This filter computes gradient vectors for an image/volume.
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.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Dimensionality'''<br>''(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
|
The value must be one of the following: Two (2), Three (3).
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Gradient filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point array with 1 components.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData.
 
 
|-
| '''Select Input Scalars'''<br>''(SelectInputScalars)''
|
This property lists the name of the array from which to compute the gradient.
|
|
An array of scalars is required.
 
 
|}
 
 
==Gradient Of Unstructured 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.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Compute Vorticity'''<br>''(ComputeVorticity)''
|
When this flag is on, the gradient filter will compute the
vorticity/curl of a 3 component array.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Faster Approximation'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Gradient (Unstructured) filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point or cell array.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPointSet.
 
 
|-
| '''Result Array Name'''<br>''(ResultArrayName)''
|
This property provides a name for the output array containing the gradient vectors.
| Gradients
|
|-
| '''Scalar Array'''<br>''(SelectInputScalars)''
|
This property lists the name of the scalar array from which to compute the gradient.
|
|
An array of scalars is required.
 
 
Valud array names will be chosen from point and cell data.
 
 
|}
 
 
==Grid Connectivity==
 
 
Mass properties of connected fragments for unstructured grids.
This filter works on multiblock unstructured grid inputs and also works in<br>
parallel. It Ignores any cells with a cell data Status value of 0.<br>
It performs connectivity to distict fragments separately. It then integrates<br>
attributes of the fragments.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkUnstructuredGrid, vtkCompositeDataSet.
 
 
|}
 
 
==Group Datasets==
 
 
Group data sets.
Groups multiple datasets to create a multiblock dataset<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property indicates the the inputs to the Group Datasets filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataObject.
 
 
|}
 
 
==Histogram==
 
 
Extract a histogram from field data.
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Bin Count'''<br>''(BinCount)''
|
The value of this property specifies the number of bins for the histogram.
| 10
|
The value must be greater than or equal to 1 and less than or equal to 256.
 
 
|-
| '''Calculate Averages'''<br>''(CalculateAverages)''
|
This option controls whether the algorithm calculates averages
of variables other than the primary variable that fall into each
bin.
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Component'''<br>''(Component)''
|
The value of this property specifies the array component from which the histogram should be computed.
| 0
|
|-
| '''Custom Bin Ranges'''<br>''(CustomBinRanges)''
|
Set custom bin ranges to use. These are used only when
UseCustomBinRanges is set to true.
| 0 100
|
The value must lie within the range of the selected data array.
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Histogram filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point or cell array.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Select Input Array'''<br>''(SelectInputArray)''
|
This property indicates the name of the array from which to compute the histogram.
|
|
An array of scalars is required.
 
 
Valud array names will be chosen from point and cell data.
 
 
|-
| '''Use Custom Bin Ranges'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|}
 
 
==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.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Integrate Attributes filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|}
 
 
==Interpolate to Quadrature Points==
 
 
Create scalar/vector data arrays interpolated to quadrature points.
"Create scalar/vector data arrays interpolated to quadrature points."<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkUnstructuredGrid.
 
 
|-
| '''Select Source Array'''<br>''(SelectSourceArray)''
|
Specifies the offset array from which we interpolate values to quadrature points.
|
|
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<br>
fragments. The filter takes two inputs, the first containing fragment<br>
geometry and the second containing fragment centers. The filter has two<br>
outputs. The first is geometry that results from the intersection. The<br>
second is a set of points that is an approximation of the center of where<br>
each fragment has been intersected.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Slice Type'''<br>''(CutFunction)''
|
This property sets the type of intersecting geometry, and
associated parameters.
|
|
The value must be set to one of the following: Plane, Box, Sphere.
 
 
|-
| '''Input'''<br>''(Input)''
|
This input must contian fragment geometry.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkMultiBlockDataSet.
 
 
|-
| '''Source'''<br>''(Source)''
|
This input must contian fragment centers.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkMultiBlockDataSet.
 
 
|}
 
 
==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.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Threshold filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point or cell array with 1 components.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Input Scalars'''<br>''(SelectInputScalars)''
|
The value of this property contains the name of the scalar array from which to perform thresholding.
|
|
An array of scalars is required.
 
 
Valud array names will be chosen from point and cell data.
 
 
|-
| '''Threshold Range'''<br>''(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.
<br>
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 set.<br>
 
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Attribute Mode'''<br>''(AttributeMode)''
|
Specify which type of field data the arrays will be drawn from.
| 0
|
Valud array names will be chosen from point and cell data.
 
 
|-
| '''Input'''<br>''(Input)''
|
The input to the filter. Arrays from this dataset will be used for computing statistics and/or assessed by a statistical model.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point or cell array.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData, vtkStructuredGrid, vtkPolyData, vtkUnstructuredGrid, vtkTable, vtkGraph.
 
 
|-
| '''k'''<br>''(K)''
|
Specify the number of clusters.
| 5
|
The value must be greater than or equal to 1.
 
 
|-
| '''Max Iterations'''<br>''(MaxNumIterations)''
|
Specify the maximum number of iterations in which cluster centers are moved before the algorithm terminates.
| 50
|
The value must be greater than or equal to 1.
 
 
|-
| '''Model Input'''<br>''(ModelInput)''
|
A previously-calculated model with which to assess a separate dataset. This input is optional.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkTable, vtkMultiBlockDataSet.
 
 
|-
| '''Variables of Interest'''<br>''(SelectArrays)''
|
Choose arrays whose entries will be used to form observations for statistical analysis.
|
|
An array of scalars is required.
 
 
|-
| '''Task'''<br>''(Task)''
|
Specify the task to be performed: modeling and/or assessment.
#  "Statistics of all the data," creates an output table (or tables) summarizing the '''entire''' input dataset;
#  "Model a subset of the data," creates an output table (or tables) summarizing a '''randomly-chosen subset''' of the input dataset;
#  "Assess the data with a model," adds attributes to the first input dataset using a model provided on the second input port; and
#  "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.
 
When the task includes creating a model (i.e., tasks 2, and 4), you may adjust the fraction of the input dataset used for training. You should avoid using a large fraction of the input data for training as you will then not be able to detect overfitting. The ''Training fraction'' setting will be ignored for tasks 1 and 3.
| 3
|
The value must be one of the following: Statistics of all the data (0), Model a subset of the data (1), Assess the data with a model (2), Model and assess the same data (3).
 
 
|-
| '''Tolerance'''<br>''(Tolerance)''
|
Specify the relative tolerance that will cause early termination.
| 0.01
|
The value must be greater than or equal to 0 and less than or equal to 1.
 
 
|-
| '''Training Fraction'''<br>''(TrainingFraction)''
|
Specify the fraction of values from the input dataset to be used for model fitting. The exact set of values is chosen at random from the dataset.
| 0.1
|
The value must be greater than or equal to 0 and less than or equal to 1.
 
 
|}
 
 
==Level Scalars==
 
 
The Level Scalars filter uses colors to show levels of a hierarchical dataset.
The Level Scalars filter uses colors to show levels of a hierarchical dataset.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Level Scalars filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkHierarchicalBoxDataSet.
 
 
|}
 
 
==Linear Extrusion==
 
 
This filter creates a swept surface defined by translating the input along a vector.
The Linear Extrusion filter creates a swept surface by translating the input dataset along a specified vector. This filter is intended to operate on 2D polygonal data. This filter operates on polygonal data and produces polygonal data output.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Capping'''<br>''(Capping)''
|
The value of this property indicates whether to cap the ends of the swept surface. Capping works by placing a copy of the input dataset on either end of the swept surface, so it behaves properly if the input is a 2D surface composed of filled polygons. If the input dataset is a closed solid (e.g., a sphere), then if capping is on (i.e., this property is set to 1), two copies of the data set will be displayed on output (the second translated from the first one along the specified vector). If instead capping is off (i.e., this property is set to 0), then an input closed solid will produce no output.
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Linear Extrusion filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
 
 
|-
| '''Piece Invariant'''<br>''(PieceInvariant)''
|
The value of this property determines whether the output will be the same regardless of the number of processors used to compute the result. The difference is whether there are internal polygonal faces on the processor boundaries. A value of 1 will keep the results the same; a value of 0 will allow internal faces on processor boundaries.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Scale Factor'''<br>''(ScaleFactor)''
|
The value of this property determines the distance along the vector the dataset will be translated. (A scale factor of 0.5 will move the dataset half the length of the vector, and a scale factor of 2 will move it twice the vector's length.)
| 1
|
|-
| '''Vector'''<br>''(Vector)''
|
The value of this property indicates the X, Y, and Z components of the vector along which to sweep the input dataset.
| 0 0 1
|
|}
 
 
==Loop Subdivision==
 
 
This filter iteratively divides each triangle into four triangles. New points are placed so the output surface is smooth.
The Loop Subdivision filter increases the granularity of a polygonal mesh. It works by dividing each triangle in the input into four new triangles. It is named for Charles Loop, the person who devised this subdivision scheme. This filter only operates on triangles, so a data set that contains other types of polygons should be passed through the Triangulate filter before applying this filter to it. This filter only operates on polygonal data (specifically triangle meshes), and it produces polygonal output.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Loop Subdivision filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
 
 
|-
| '''Number of Subdivisions'''<br>''(NumberOfSubdivisions)''
|
Set the number of subdivision iterations to perform. Each subdivision divides single triangles into four new triangles.
| 1
|
The value must be greater than or equal to 1 and less than or equal to 4.
 
 
|}
 
 
==Mask Points==
 
 
Reduce the number of points. This filter is often used before glyphing. Generating vertices is an option.
The Mask Points filter reduces the number of points in the dataset. It operates on any type of dataset, but produces only points / vertices as output. This filter is often used before the Glyph filter, but the basic point-masking functionality is also available on the Properties page for the Glyph filter.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Generate Vertices'''<br>''(GenerateVertices)''
|
This property specifies whether to generate vertex cells as the topography of the output. If set to 1, the geometry (vertices) will be displayed in the rendering window; otherwise no geometry will be displayed.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Mask Points filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Maximum Number of Points'''<br>''(MaximumNumberOfPoints)''
|
The value of this property indicates the maximum number of points in the output dataset.
| 5000
|
The value must be greater than or equal to 0.
 
 
|-
| '''Offset'''<br>''(Offset)''
|
The value of this property indicates the point in the input dataset from which to start masking.
| 0
|
The value must be greater than or equal to 0.
 
 
|-
| '''On Ratio'''<br>''(OnRatio)''
|
The value of this property specifies the ratio of points to retain in the output. (For example, if the on ratio is 3, then the output will contain 1/3 as many points -- up to the value of the MaximumNumberOfPoints property -- as the input.)
| 2
|
The value must be greater than or equal to 1.
 
 
|-
| '''Random'''<br>''(RandomMode)''
|
If the value of this property is set to 0, then the points in the output will be randomly selected from the input; otherwise this filter will subsample regularly. Selecting points at random is helpful to avoid striping when masking the points of a structured dataset.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Single Vertex Per Cell'''<br>''(SingleVertexPerCell)''
|
Tell filter to only generate one vertex per cell instead of multiple vertices in one cell.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|}
 
 
==Material Interface Filter==
 
 
The Material Interface filter finds volumes in the input data containg material above a certain material fraction.
The Material Interface filter finds voxels inside of which a material<br>
fraction (or normalized amount of material) is higher than a given<br>
threshold. As these voxels are identified surfaces enclosing adjacent<br>
voxels above the threshold are generated. The resulting volume and its<br>
surface are what we call a fragment. The filter has the ability to<br>
compute various volumetric attributes such as fragment volume, mass,<br>
center of mass as well as volume and mass weighted averages for any of<br>
the fields present. Any field selected for such computation will be also<br>
be coppied into the fragment surface's point data for visualization. The<br>
filter also has the ability to generate Oriented Bounding Boxes (OBB) for<br>
each fragment.<br><br><br>
The data generated by the filter is organized in three outputs. The<br>
"geometry" output, containing the fragment surfaces. The "statistics"<br>
output, containing a point set of the centers of mass. The "obb<br>
representaion" output, containing OBB representations (poly data). All<br>
computed attributes are coppied into the statistics and geometry output.<br>
The obb representation output is used for validation and debugging<br>
puproses and is turned off by default.<br><br><br>
To measure the size of craters, the filter can invert a volume fraction<br>
and clip the volume fraction with a sphere and/or a plane.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Clip Type'''<br>''(ClipFunction)''
|
This property sets the type of clip geometry, and
associated parameters.
|
|
The value must be set to one of the following: None, Plane, Sphere.
 
 
|-
| '''Compute OBB'''<br>''(ComputeOBB)''
|
Compute Object Oriented Bounding boxes (OBB). When active the result of
this computation is coppied into the statistics output. In the case
that the filter is built in its validation mode, the OBB's are
rendered.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Input'''<br>''(Input)''
|
Input to the filter can be a hierarchical box data set containing image
data or a multi-block of rectilinear grids.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a cell array.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkHierarchicalBoxDataSet.
 
 
|-
| '''Invert Volume Fraction'''<br>''(InvertVolumeFraction)''
|
Inverting the volume fraction generates the negative of the material.
It is useful for analyzing craters.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Material Fraction Threshold'''<br>''(MaterialFractionThreshold)''
|
Material fraction is defined as normalized amount of material per
voxel. Any voxel in the input data set with a material fraction greater
than this value is included in the output data set.
| 0.5
|
The value must be greater than or equal to 0.08 and less than or equal to 1.
 
 
|-
| '''Output Base Name'''<br>''(OutputBaseName)''
|
This property specifies the base including path of where to write the
statistics and gemoetry output text files. It follows the pattern
"/path/to/folder/and/file" here file has no extention, as the filter
will generate a unique extention.
|
|
|-
| '''Select Mass Arrays'''<br>''(SelectMassArray)''
|
Mass arrays are paired with material fraction arrays. This means that
the first selected material fraction array is paired with the first
selected mass array, and so on sequentially. As the filter identifies
voxels meeting the minimum material fraction threshold, these voxel's
mass will be used in fragment center of mass and mass calculation.
 
A warning is generated if no mass array is selected for an individual
material fraction array. However, in that case the filter will run
without issue because the statistics output can be generated using
fragments' centers computed from axis aligned bounding boxes.
|
|
An array of scalars is required.
 
 
|-
| '''Compute mass weighted average over:'''<br>''(SelectMassWtdAvgArray)''
|
For arrays selected a mass weighted average is computed. These arrays
are also coppied into fragment geometry cell data as the fragment
surfaces are generated.
|
|
An array of scalars is required.
 
 
|-
| '''Select Material Fraction Arrays'''<br>''(SelectMaterialArray)''
|
Material fraction is defined as normalized amount of material per
voxel. It is expected that arrays containing material fraction data has
been down converted to a unsigned char.
|
|
An array of scalars is required.
 
 
|-
| '''Compute volume weighted average over:'''<br>''(SelectVolumeWtdAvgArray)''
|
For arrays selected a volume weighted average is computed. The values
of these arrays are also coppied into fragment geometry cell data as
the fragment surfaces are generated.
|
|
An array of scalars is required.
 
 
|-
| '''Write Geometry Output'''<br>''(WriteGeometryOutput)''
|
If this property is set, then the geometry output is written to a text
file. The file name will be coonstructed using the path in the "Output
Base Name" widget.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Write Statistics Output'''<br>''(WriteStatisticsOutput)''
|
If this property is set, then the statistics output is written to a
text file. The file name will be coonstructed using the path in the
"Output Base Name" widget.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|}
 
 
==Median==
 
 
Compute the median scalar values in a specified neighborhood for image/volume datasets.
The Median filter operates on uniform rectilinear (image or volume) data and produces uniform rectilinear output. It replaces the scalar value at each pixel / voxel with the median scalar value in the specified surrounding neighborhood. Since the median operation removes outliers, this filter is useful for removing high-intensity, low-probability noise (shot noise).<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Median filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point array with 1 components.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData.
 
 
|-
| '''Kernel Size'''<br>''(KernelSize)''
|
The value of this property specifies the number of pixels/voxels in each dimension to use in computing the median to assign to each pixel/voxel. If the kernel size in a particular dimension is 1, then the median will not be computed in that direction.
| 1 1 1
|
|-
| '''Select Input Scalars'''<br>''(SelectInputScalars)''
|
The value of thie property lists the name of the scalar array to use in computing the median.
|
|
An array of scalars is required.
 
 
|}
 
 
==Merge Blocks==
 
 
vtkCompositeDataToUnstructuredGridFilter appends all vtkDataSet<br>
leaves of the input composite dataset to a single unstructure grid. The<br>
subtree to be combined can be choosen using the SubTreeCompositeIndex. If<br>
the SubTreeCompositeIndex is a leaf node, then no appending is required.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
Set the input composite dataset.
|
|
The selected dataset must be one of the following types (or a subclass of one of them): vtkCompositeDataSet.
 
 
|}
 
 
==Mesh Quality==
 
 
This filter creates a new cell array containing a geometric measure of each cell's fitness. Different quality measures can be chosen for different cell shapes.
This filter creates a new cell array containing a geometric measure of each cell's fitness. Different quality measures can be chosen for different cell shapes. Supported shapes include triangles, quadrilaterals, tetrahedra, and hexahedra. For other shapes, a value of 0 is assigned.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Hex Quality Measure'''<br>''(HexQualityMeasure)''
|
This property indicates which quality measure will be used to evaluate hexahedral quality.
| 5
|
The value must be one of the following: Diagonal (21), Dimension (22), Distortion (15), Edge Ratio (0), Jacobian (25), Maximum Edge Ratio (16), Maximum Aspect Frobenius (5), Mean Aspect Frobenius (4), Oddy (23), Relative Size Squared (12), Scaled Jacobian (10), Shape (13), Shape and Size (14), Shear (11), Shear and Size (24), Skew (17), Stretch (20), Taper (18), Volume (19).
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Mesh Quality filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Quad Quality Measure'''<br>''(QuadQualityMeasure)''
|
This property indicates which quality measure will be used to evaluate quadrilateral quality.
| 0
|
The value must be one of the following: Area (28), Aspect Ratio (1), Condition (9), Distortion (15), Edge Ratio (0), Jacobian (25), Maximum Aspect Frobenius (5), Maximum Aspect Frobenius (5), Maximum Edge Ratio (16), Mean Aspect Frobenius (4), Minimum Angle (6), Oddy (23), Radius Ratio (2), Relative Size Squared (12), Scaled Jacobian (10), Shape (13), Shape and Size (14), Shear (11), Shear and Size (24), Skew (17), Stretch (20), Taper (18), Warpage (26).
 
 
|-
| '''Tet Quality Measure'''<br>''(TetQualityMeasure)''
|
This property indicates which quality measure will be used to evaluate tetrahedral quality. The radius ratio is the size of a sphere circumscribed by a tetrahedron's 4 vertices divided by the size of a circle tangent to a tetrahedron's 4 faces. The edge ratio is the ratio of the longest edge length to the shortest edge length. The collapse ratio is the minimum ratio of height of a vertex above the triangle opposite it divided by the longest edge of the opposing triangle across all vertex/triangle pairs.
| 2
|
The value must be one of the following: Edge Ratio (0), Aspect Beta (29), Aspect Gamma (27), Aspect Frobenius (3), Aspect Ratio (1), Collapse Ratio (7), Condition (9), Distortion (15), Jacobian (25), Minimum Dihedral Angle (6), Radius Ratio (2), Relative Size Squared (12), Scaled Jacobian (10), Shape (13), Shape and Size (14), Volume (19).
 
 
|-
| '''Triangle Quality Measure'''<br>''(TriangleQualityMeasure)''
|
This property indicates which quality measure will be used to evaluate triangle quality. The radius ratio is the size of a circle circumscribed by a triangle's 3 vertices divided by the size of a circle tangent to a triangle's 3 edges. The edge ratio is the ratio of the longest edge length to the shortest edge length.
| 2
|
The value must be one of the following: Area (28), Aspect Ratio (1), Aspect Frobenius (3), Condition (9), Distortion (15), Edge Ratio (0), Maximum Angle (8), Minimum Angle (6), Scaled Jacobian (10), Radius Ratio (2), Relative Size Squared (12), Shape (13), Shape and Size (14).
 
 
|}
 
 
==Multicorrelative Statistics==
 
 
Compute a statistical model of a dataset and/or assess the dataset with a statistical model.
This filter either computes a statistical model of a dataset or takes such a model as its second input. Then, the model (however it is obtained) may optionally be used to assess the input dataset.
<br>
This filter computes the covariance matrix for all the arrays you select plus the mean of each array. The model is thus a multivariate Gaussian distribution with the mean vector and variances provided. Data is assessed using this model by computing the Mahalanobis distance for each input point. This distance will always be positive.
 
<br>
The learned model output format is rather dense and can be confusing, so it is discussed here. The first filter output is a multiblock dataset consisting of 2 tables:
<br>
#  Raw covariance data.<br>
#  Covariance matrix and its Cholesky decomposition.
<br>
The raw covariance table has 3 meaningful columns: 2 titled "Column1" and "Column2" whose entries generally refer to the N arrays you selected when preparing the filter and 1 column titled "Entries" that contains numeric values. The first row will always contain the number of observations in the statistical analysis. The next N rows contain the mean for each of the N arrays you selected. The remaining rows contain covariances of pairs of arrays.
<br>
The second table (covariance matrix and Cholesky decomposition) contains information derived from the raw covariance data of the first table. The first N rows of the first column contain the name of one array you selected for analysis. These rows are followed by a single entry labeled "Cholesky" for a total of N+1 rows. The second column, Mean contains the mean of each variable in the first N entries and the number of observations processed in the final (N+1) row.
 
<br>
The remaining columns (there are N, one for each array) contain 2 matrices in triangular format. The upper right triangle contains the covariance matrix (which is symmetric, so its lower triangle may be inferred). The lower left triangle contains the Cholesky decomposition of the covariance matrix (which is triangular, so its upper triangle is zero). Because the diagonal must be stored for both matrices, an additional row is required — hence the N+1 rows and the final entry of the column named "Column".<br>
 
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Attribute Mode'''<br>''(AttributeMode)''
|
Specify which type of field data the arrays will be drawn from.
| 0
|
Valud array names will be chosen from point and cell data.
 
 
|-
| '''Input'''<br>''(Input)''
|
The input to the filter. Arrays from this dataset will be used for computing statistics and/or assessed by a statistical model.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point or cell array.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData, vtkStructuredGrid, vtkPolyData, vtkUnstructuredGrid, vtkTable, vtkGraph.
 
 
|-
| '''Model Input'''<br>''(ModelInput)''
|
A previously-calculated model with which to assess a separate dataset. This input is optional.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkTable, vtkMultiBlockDataSet.
 
 
|-
| '''Variables of Interest'''<br>''(SelectArrays)''
|
Choose arrays whose entries will be used to form observations for statistical analysis.
|
|
An array of scalars is required.
 
 
|-
| '''Task'''<br>''(Task)''
|
Specify the task to be performed: modeling and/or assessment.
#  "Statistics of all the data," creates an output table (or tables) summarizing the '''entire''' input dataset;
#  "Model a subset of the data," creates an output table (or tables) summarizing a '''randomly-chosen subset''' of the input dataset;
#  "Assess the data with a model," adds attributes to the first input dataset using a model provided on the second input port; and
#  "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.
 
When the task includes creating a model (i.e., tasks 2, and 4), you may adjust the fraction of the input dataset used for training. You should avoid using a large fraction of the input data for training as you will then not be able to detect overfitting. The ''Training fraction'' setting will be ignored for tasks 1 and 3.
| 3
|
The value must be one of the following: Statistics of all the data (0), Model a subset of the data (1), Assess the data with a model (2), Model and assess the same data (3).
 
 
|-
| '''Training Fraction'''<br>''(TrainingFraction)''
|
Specify the fraction of values from the input dataset to be used for model fitting. The exact set of values is chosen at random from the dataset.
| 0.1
|
The value must be greater than or equal to 0 and less than or equal to 1.
 
 
|}
 
 
==Normal Glyphs==
 
 
Filter computing surface normals.
Filter computing surface normals.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Consistency'''<br>''(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
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Maximum Number of Points'''<br>''(Glyph Max. Points)''
|
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
|
The value must be greater than or equal to 0.
 
 
|-
| '''Random Mode'''<br>''(Glyph Random Mode)''
|
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
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Set Scale Factor'''<br>''(Glyph Scale Factor)''
|
The value of this property will be used as a multiplier for scaling the glyphs before adding them to the output.
| 1
|
The value must be less than the largest dimension of the dataset multiplied by a scale factor of 0.1.
 
 
The value must lie within the range of the selected data array.
 
 
The value must lie within the range of the selected data array.
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Extract Surface filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Invert'''<br>''(InvertArrow)''
|
Inverts the arrow direction.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|}
 
 
==Octree Depth Limit==
 
 
This filter takes in a octree and produces a new octree which is no deeper than the maximum specified depth level.
The Octree Depth Limit filter takes in an octree and produces a new octree that is nowhere deeper than the maximum specified depth level. The attribute data of pruned leaf cells are integrated in to their ancestors at the cut level.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Octree Depth Limit filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkHyperOctree.
 
 
|-
| '''Maximum Level'''<br>''(MaximumLevel)''
|
The value of this property specifies the maximum depth of the output octree.
| 4
|
The value must be greater than or equal to 3 and less than or equal to 255.
 
 
|}
 
 
==Octree Depth Scalars==
 
 
This filter adds a scalar to each leaf of the octree that represents the leaf's depth within the tree.
The vtkHyperOctreeDepth filter adds a scalar to each leaf of the octree that represents the leaf's depth within the tree.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Octree Depth Scalars filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkHyperOctree.
 
 
|}
 
 
==Outline==
 
 
This filter generates a bounding box representation of the input.
The Outline filter generates an axis-aligned bounding box for the input dataset. This filter operates on any type of dataset and produces polygonal output.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Outline filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|}
 
 
==Outline Corners==
 
 
This filter generates a bounding box representation of the input. It only displays the corners of the bounding box.
The Outline Corners filter generates the corners of a bounding box for the input dataset. This filter operates on any type of dataset and produces polygonal output.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Corner Factor'''<br>''(CornerFactor)''
|
The value of this property sets the size of the corners as a percentage of the length of the corresponding bounding box edge.
| 0.2
|
The value must be greater than or equal to 0.001 and less than or equal to 0.5.
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Outline Corners filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|}
 
 
==Outline Curvilinear DataSet==
 
 
This filter generates an outline representation of the input.
The Outline filter generates an outline of the outside edges of the input dataset, rather than the dataset's bounding box. This filter operates on structured grid datasets and produces polygonal output.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the outline (curvilinear) filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkStructuredGrid.
 
 
|}
 
 
==Particle Pathlines==
 
 
Creates polylines representing pathlines of animating particles
Particle Pathlines takes any dataset as input, it extracts the<br>
point locations of all cells over time to build up a polyline<br>
trail. The point number (index) is used as the 'key' if the points<br>
are randomly changing their respective order in the points list,<br>
then you should specify a scalar that represents the unique<br>
ID. This is intended to handle the output of a filter such as the<br>
TemporalStreamTracer.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Id Channel Array'''<br>''(IdChannelArray)''
|
Specify the name of a scalar array which will be used to fetch
the index of each point. This is necessary only if the particles
change position (Id order) on each time step. The Id can be used
to identify particles at each step and hence track them properly.
If this array is set to "Global or Local IDs", the global point
ids are used if they exist or the point index is otherwise.
| Global or Local IDs
|
An array of scalars is required.
 
 
|-
| '''Input'''<br>''(Input)''
|
The input cells to create pathlines for.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPointSet.
 
 
|-
| '''Mask Points'''<br>''(MaskPoints)''
|
Set the number of particles to track as a ratio of the input.
Example: setting MaskPoints to 10 will track every 10th point.
| 100
|
|-
| '''Max Step Distance'''<br>''(MaxStepDistance)''
|
If a particle disappears from one end of a simulation and
reappears on the other side, the track left will be
unrepresentative. Set a MaxStepDistance{x,y,z} which acts as a
threshold above which if a step occurs larger than the value (for
the dimension), the track will be dropped and restarted after the
step. (ie the part before the wrap around will be dropped and the
newer part kept).
| 1 1 1
|
|-
| '''Max Track Length'''<br>''(MaxTrackLength)''
|
If the Particles being traced animate for a long time, the trails
or traces will become long and stringy. Setting the
MaxTraceTimeLength will limit how much of the trace is
displayed. Tracks longer then the Max will disappear and the
trace will apppear like a snake of fixed length which progresses
as the particle moves. This length is given with respect to
timesteps.
| 25
|
|-
| '''Selection'''<br>''(Selection)''
|
Set a second input, which is a selection. Particles with the same
Id in the selection as the primary input will be chosen for
pathlines Note that you must have the same IdChannelArray in the
selection as the input
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|}
 
 
==ParticleTracer==
 
 
Trace Particles through time in a vector field.
The Particle Trace filter generates pathlines in a vector field from a collection of seed points. The vector field used is selected from the Vectors menu, so the input data set is required to have point-centered vectors. The Seed portion of the interface allows you to select whether the seed points for this integration lie in a point cloud or along a line. Depending on which is selected, the appropriate 3D widget (point or line widget) is displayed along with traditional user interface controls for positioning the point cloud or line within the data set. Instructions for using the 3D widgets and the corresponding manual controls can be found in section 7.4.<br>
This filter operates on any type of data set, provided it has point-centered vectors. The output is polygonal data containing polylines. This filter is available on the Toolbar.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Compute Vorticity'''<br>''(ComputeVorticity)''
|
Compute vorticity and angular rotation of particles as they progress
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Enable Particle Writing'''<br>''(EnableParticleWriting)''
|
Turn On/Off particle writing
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Force Reinjection Every NSteps'''<br>''(ForceReinjectionEveryNSteps)''
|
| 1
|
|-
| '''Ignore Pipeline Time'''<br>''(IgnorePipelineTime)''
|
Ignore the TIME_ requests made by the pipeline and only use the TimeStep set manually
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Initial Integration Step'''<br>''(InitialIntegrationStep)''
|
| 0.25
|
|-
| '''Input'''<br>''(Input)''
|
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point array with 3 components.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataObject.
 
 
|-
| '''Particle File Name'''<br>''(ParticleFileName)''
|
Provide a name for the particle file generated if writing is enabled
| /project/csvis/biddisco/ptracer/run-1
|
|-
| '''Select Input Vectors'''<br>''(SelectInputVectors)''
|
|
|
An array of vectors is required.
 
 
|-
| '''Source'''<br>''(Source)''
|
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Static Mesh'''<br>''(StaticMesh)''
|
Force the use of static mesh optimizations
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Static Seeds'''<br>''(StaticSeeds)''
|
Force the use of static seed optimizations
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Term. Speed'''<br>''(TerminalSpeed)''
|
If at any point the speed is below the value of this property, the integration is terminated.
| 1e-12
|
|-
| '''Termination Time'''<br>''(TerminationTime)''
|
| 0
|
|-
| '''Termination Time Unit'''<br>''(TerminationTimeUnit)''
|
The termination time may be specified as TimeSteps or Simulation time
| 1
|
The value must be one of the following: Simulation Time (0), TimeSteps (1).
 
 
|-
| '''Time Step'''<br>''(TimeStep)''
|
| 0
|
|}
 
 
==Plot Data==
 
 
This filter prepare arbitrary data to be plotted in any of the plots.<br>
By default the data is shown in a XY line plot.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
The input.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataObject.
 
 
|}
 
 
==Plot Global Variables Over Time==
 
 
Extracts and plots data in field data over time.
This filter extracts the variables that reside in a dataset's field data and are<br>
defined over time. The output is a 1D rectilinear grid where the x coordinates<br>
correspond to time (the same array is also copied to a point array named Time or<br>
TimeData (if Time exists in the input)).<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
The input from which the selection is extracted.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|}
 
 
==Plot On Intersection Curves==
 
 
Extracts the edges in a 2D plane and plots them
Extracts the surface, intersect it with a 2D plane.<br>
Plot the resulting polylines.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Extract Surface filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Slice Type'''<br>''(Slice Type)''
|
This property sets the parameters of the slice function.
|
|
The value must be set to one of the following: Plane, Box, Sphere.
 
 
|}
 
 
==Plot On Sorted Lines==
 
 
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Plot Edges filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
 
 
|}
 
 
==Plot Over Line==
 
 
Sample data attributes at the points along a line. Probed lines will be displayed in a graph of the attributes.
The Plot Over Line filter samples the data set attributes of the current<br>
data set at the points along a line. The values of the point-centered variables<br>
along that line will be displayed in an XY Plot. This filter uses interpolation<br>
to determine the values at the selected point, whether or not it lies at an<br>
input point. The Probe filter operates on any type of data and produces<br>
polygonal output (a line).<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the dataset from which to obtain probe values.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point or cell array.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet, vtkCompositeDataSet.
 
 
|-
| '''Pass Partial Arrays'''<br>''(PassPartialArrays)''
|
When dealing with composite datasets, partial arrays are common i.e.
data-arrays that are not available in all of the blocks. By default,
this filter only passes those point and cell data-arrays that are
available in all the blocks i.e. partial array are removed. When
PassPartialArrays is turned on, this behavior is changed to take a
union of all arrays present thus partial arrays are passed as well.
However, for composite dataset input, this filter still produces a
non-composite output. For all those locations in a block of where a
particular data array is missing, this filter uses vtkMath::Nan() for
double and float arrays, while 0 for all other types of arrays i.e
int, char etc.
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Probe Type'''<br>''(Source)''
|
This property specifies the dataset whose geometry will be used in determining positions to probe.
|
|
The selected object must be the result of the following: sources (includes readers).
 
 
The value must be set to one of the following: HighResLineSource.
 
 
|}
 
 
==Plot Selection Over Time==
 
 
Extracts selection over time and then plots it.
This filter extracts the selection over time, i.e. cell and/or point<br>
variables at a cells/point selected are extracted over time<br>
The output multi-block consists of 1D rectilinear grids where the x coordinate<br>
corresponds to time (the same array is also copied to a point array named<br>
Time or TimeData (if Time exists in the input)).<br>
If selection input is a Location based selection then the point values are<br>
interpolated from the nearby cells, ie those of the cell the location<br>
lies in.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
The input from which the selection is extracted.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet, vtkTable, vtkCompositeDataSet.
 
 
|-
| '''Selection'''<br>''(Selection)''
|
The input that provides the selection object.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkSelection.
 
 
|}
 
 
==Point Data to Cell Data==
 
 
Create cell attributes by averaging point attributes.
The Point Data to Cell Data filter averages the values of the point attributes of the points of a cell to compute cell attributes. This filter operates on any type of dataset, and the output dataset is the same type as the input.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Point Data to Cell Data filter.
|
|
Once set, the input dataset type cannot be changed.
 
 
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point array.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Pass Point Data'''<br>''(PassPointData)''
|
The value of this property controls whether the input point data will be passed to the output. If set to 1, then the input point data is passed through to the output; otherwise, only generated cell data is placed into the output.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|}
 
 
==Principal Component Analysis==
 
 
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.
<br>
This filter performs additional analysis above and beyond the multicorrelative filter. It computes the eigenvalues and eigenvectors of the covariance matrix from the multicorrelative filter. Data is then assessed by projecting the original tuples into a possibly lower-dimensional space.
 
<br>
Since the PCA filter uses the multicorrelative filter's analysis, it shares the same raw covariance table specified in the multicorrelative documentation. The second table in the multiblock dataset comprising the model output is an expanded version of the multicorrelative version.
 
<br>
As with the multicorrlative filter, the second model table contains the mean values, the upper-triangular portion of the symmetric covariance matrix, and the non-zero lower-triangular portion of the Cholesky decomposition of the covariance matrix. Below these entries are the eigenvalues of the covariance matrix (in the column labeled "Mean") and the eigenvectors (as row vectors) in an additional NxN matrix.<br>
 
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Attribute Mode'''<br>''(AttributeMode)''
|
Specify which type of field data the arrays will be drawn from.
| 0
|
Valud array names will be chosen from point and cell data.
 
 
|-
| '''Basis Energy'''<br>''(BasisEnergy)''
|
The minimum energy to use when determining the dimensionality of the new space into which the assessment will project tuples.
| 0.1
|
The value must be greater than or equal to 0 and less than or equal to 1.
 
 
|-
| '''Basis Scheme'''<br>''(BasisScheme)''
|
When reporting assessments, should the full eigenvector decomposition be used to project the original vector into the new space (Full basis), or should a fixed subset of the decomposition be used (Fixed-size basis), or should the projection be clipped to preserve at least some fixed "energy" (Fixed-energy basis)?
 
 
As an example, suppose the variables of interest were {A,B,C,D,E} and that the eigenvalues of the covariance matrix for these were {5,2,1.5,1,.5}. If the "Full basis" scheme is used, then all 5 components of the eigenvectors will be used to project each {A,B,C,D,E}-tuple in the original data into a new 5-components space.
 
 
 
If the "Fixed-size" scheme is used and the "Basis Size" property is set to 4, then only the first 4 eigenvector components will be used to project each {A,B,C,D,E}-tuple into the new space and that space will be of dimension 4, not 5.
 
 
 
If the "Fixed-energy basis" scheme is used and the "Basis Energy" property is set to 0.8, then only the first 3 eigenvector components will be used to project each {A,B,C,D,E}-tuple into the new space, which will be of dimension 3. The number 3 is chosen because 3 is the lowest N for which the sum of the first N eigenvalues divided by the sum of all eigenvalues is larger than the specified "Basis Energy" (i.e., (5+2+1.5)/10 = 0.85 > 0.8).
 
| 0
|
The value must be one of the following: Full basis (0), Fixed-size basis (1), Fixed-energy basis (2).
 
 
|-
| '''Basis Size'''<br>''(BasisSize)''
|
The maximum number of eigenvector components to use when projecting into the new space.
| 2
|
The value must be greater than or equal to 1.
 
 
|-
| '''Input'''<br>''(Input)''
|
The input to the filter. Arrays from this dataset will be used for computing statistics and/or assessed by a statistical model.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point or cell array.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkImageData, vtkStructuredGrid, vtkPolyData, vtkUnstructuredGrid, vtkTable, vtkGraph.
 
 
|-
| '''Model Input'''<br>''(ModelInput)''
|
A previously-calculated model with which to assess a separate dataset. This input is optional.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkTable, vtkMultiBlockDataSet.
 
 
|-
| '''Normalization Scheme'''<br>''(NormalizationScheme)''
|
Before the eigenvector decomposition of the covariance matrix takes place, you may normalize each (i,j) entry by sqrt( cov(i,i) * cov(j,j) ). This implies that the variance of each variable of interest should be of equal importance.
| 2
|
The value must be one of the following: No normalization (0), Normalize using covariances (3).
 
 
|-
| '''Variables of Interest'''<br>''(SelectArrays)''
|
Choose arrays whose entries will be used to form observations for statistical analysis.
|
|
An array of scalars is required.
 
 
|-
| '''Task'''<br>''(Task)''
|
Specify the task to be performed: modeling and/or assessment.
#  "Statistics of all the data," creates an output table (or tables) summarizing the '''entire''' input dataset;
#  "Model a subset of the data," creates an output table (or tables) summarizing a '''randomly-chosen subset''' of the input dataset;
#  "Assess the data with a model," adds attributes to the first input dataset using a model provided on the second input port; and
#  "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.
 
When the task includes creating a model (i.e., tasks 2, and 4), you may adjust the fraction of the input dataset used for training. You should avoid using a large fraction of the input data for training as you will then not be able to detect overfitting. The ''Training fraction'' setting will be ignored for tasks 1 and 3.
| 3
|
The value must be one of the following: Statistics of all the data (0), Model a subset of the data (1), Assess the data with a model (2), Model and assess the same data (3).
 
 
|-
| '''Training Fraction'''<br>''(TrainingFraction)''
|
Specify the fraction of values from the input dataset to be used for model fitting. The exact set of values is chosen at random from the dataset.
| 0.1
|
The value must be greater than or equal to 0 and less than or equal to 1.
 
 
|}
 
 
==Probe Location==
 
 
Sample data attributes at the points in a point cloud.
The Probe filter samples the data set attributes of the current data set at the points in a point cloud. The Probe filter uses interpolation to determine the values at the selected point, whether or not it lies at an input point. The Probe filter operates on any type of data and produces polygonal output (a point cloud).<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the dataset from which to obtain probe values.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point or cell array.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet, vtkCompositeDataSet.
 
 
|-
| '''Probe Type'''<br>''(Source)''
|
This property specifies the dataset whose geometry will be used in determining positions to probe.
|
|
The selected object must be the result of the following: sources (includes readers).
 
 
The value must be set to one of the following: FixedRadiusPointSource.
 
 
|}
 
 
==Process Id Scalars==
 
 
This filter uses colors to show how data is partitioned across processes.
The Process Id Scalars filter assigns a unique scalar value to each piece of the input according to which processor it resides on. This filter operates on any type of data when ParaView is run in parallel. It is useful for determining whether your data is load-balanced across the processors being used. The output data set type is the same as that of the input.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Process Id Scalars filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Random Mode'''<br>''(RandomMode)''
|
The value of this property determines whether to use random id values for the various pieces. If set to 1, the unique value per piece will be chosen at random; otherwise the unique value will match the id of the process.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|}
 
 
==Programmable Filter==
 
 
Executes a user supplied python script on its input dataset to produce an output dataset.
This filter will execute a python script to produce an output dataset.<br>
The filter keeps a copy of the python script in Script, and creates <br>
Interpretor, a python interpretor to run the script upon the first <br>
execution.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Copy Arrays'''<br>''(CopyArrays)''
|
If this property is set to true, all the cell and point arrays from
first input are copied to the output.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''RequestInformation Script'''<br>''(InformationScript)''
|
This property is a python script that is executed during the RequestInformation pipeline pass. Use this to provide information such as WHOLE_EXTENT to the pipeline downstream.
|
|
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input(s) to the programmable filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Output Data Set Type'''<br>''(OutputDataSetType)''
|
The value of this property determines the dataset type for the output of the programmable filter.
| 8
|
The value must be one of the following: Same as Input (8), vtkPolyData (0), vtkStructuredGrid (2), vtkRectilinearGrid (3), vtkUnstructuredGrid (4), vtkImageData (6), vtkUniformGrid (10), vtkMultiblockDataSet (13), vtkHierarchicalBoxDataSet (15), vtkTable (19).
 
 
|-
| '''Python Path'''<br>''(PythonPath)''
|
A semi-colon (;) separated list of directories to add to the python library
search path.
|
|
|-
| '''Script'''<br>''(Script)''
|
This property contains the text of a python program that the programmable filter runs.
|
|
|-
| '''RequestUpdateExtent Script'''<br>''(UpdateExtentScript)''
|
This property is a python script that is executed during the RequestUpdateExtent pipeline pass. Use this to modify the update extent that your filter ask up stream for.
|
|
|}
 
 
==Python Calculator==
 
 
This filter evaluates a Python expression
This filter uses Python to calculate an expression.<br>
It depends heavily on the numpy and paraview.vtk modules.<br>
To use the parallel functions, mpi4py is also necessary. The expression<br>
is evaluated and the resulting scalar value or numpy array is added<br>
to the output as an array. See numpy and paraview.vtk documentation<br>
for the list of available functions.<br><br><br>
This filter tries to make it easy for the user to write expressions<br>
by defining certain variables. The filter tries to assign each array<br>
to a variable of the same name. If the name of the array is not a <br>
valid Python variable, it has to be accessed through a dictionary called<br>
arrays (i.e. arrays['array_name']). The points can be accessed using the<br>
points variable. <br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Array Association'''<br>''(ArrayAssociation)''
|
This property controls the association of the output array as well as
which arrays are defined as variables.
| 0
|
The value must be one of the following: Point Data (0), Cell Data (1).
 
 
|-
| '''Array Name'''<br>''(ArrayName)''
|
The name of the output array.
| result
|
|-
| '''Copy Arrays'''<br>''(CopyArrays)''
|
If this property is set to true, all the cell and point arrays from
first input are copied to the output.
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Expression'''<br>''(Expression)''
|
The Python expression evaluated during execution.
|
|
|-
| '''Input'''<br>''(Input)''
|
Set the input of the filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|}
 
 
==Quadric Clustering==
 
 
This filter is the same filter used to generate level of detail for ParaView. It uses a structured grid of bins and merges all points contained in each bin.
The Quadric Clustering filter produces a reduced-resolution polygonal approximation of the input polygonal dataset. This filter is the one used by ParaView for computing LODs. It uses spatial binning to reduce the number of points in the data set; points that lie within the same spatial bin are collapsed into one representative point.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Copy Cell Data'''<br>''(CopyCellData)''
|
If this property is set to 1, the cell data from the input will be copied to the output.
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Quadric Clustering filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
 
 
|-
| '''Number of Dimensions'''<br>''(NumberOfDivisions)''
|
This property specifies the number of bins along the X, Y, and Z axes of the data set.
| 50 50 50
|
|-
| '''Use Feature Edges'''<br>''(UseFeatureEdges)''
|
If this property is set to 1, feature edge quadrics will be used to maintain the boundary edges along processor divisions.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Use Feature Points'''<br>''(UseFeaturePoints)''
|
If this property is set to 1, feature point quadrics will be used to maintain the boundary points along processor divisions.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Use Input Points'''<br>''(UseInputPoints)''
|
If the value of this property is set to 1, the representative point for each bin is selected from one of the input points that lies in that bin; the input point that produces the least error is chosen. If the value of this property is 0, the location of the representative point is calculated to produce the least error possible for that bin, but the point will most likely not be one of the input points.
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Use Internal Triangles'''<br>''(UseInternalTriangles)''
|
If this property is set to 1, triangles completely contained in a spatial bin will be included in the computation of the bin's quadrics. When this property is set to 0, the filters operates faster, but the resulting surface may not be as well-behaved.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|}
 
 
==Random Vectors==
 
 
This filter creates a new 3-component point data array and sets it as the default vector array. It uses a random number generator to create values.
The Random Vectors filter generates a point-centered array of random vectors. It uses a random number generator to determine the components of the vectors. This filter operates on any type of data set, and the output data set will be of the same type as the input.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Random Vectors filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Maximum Speed'''<br>''(MaximumSpeed)''
|
This property specifies the maximum length of the random point vectors generated.
| 1
|
The value must be greater than or equal to 0.
 
 
|-
| '''Minimum Speed'''<br>''(MinimumSpeed)''
|
This property specifies the minimum length of the random point vectors generated.
| 0
|
The value must be greater than or equal to 0.
 
 
|}
 
 
==Rectilinear Grid Connectivity==
 
 
Parallel fragments extraction and attributes integration on rectilinear grids.
Extracts material fragments from multi-block vtkRectilinearGrid datasets<br>
based on the selected volume fraction array(s) and a fraction isovalue and<br>
integrates the associated attributes.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Double Volume Arrays'''<br>''(AddDoubleVolumeArrayName)''
|
This property specifies the name(s) of the volume fraction array(s) for generating parts.
|
|
An array of scalars is required.
 
 
|-
| '''Float Volume Arrays'''<br>''(AddFloatVolumeArrayName)''
|
This property specifies the name(s) of the volume fraction array(s) for generating parts.
|
|
An array of scalars is required.
 
 
|-
| '''Unsigned Character Volume Arrays'''<br>''(AddUnsignedCharVolumeArrayName)''
|
This property specifies the name(s) of the volume fraction array(s) for generating parts.
|
|
An array of scalars is required.
 
 
|-
| '''Input'''<br>''(Input)''
|
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a cell array with 1 components.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkRectilinearGrid, vtkCompositeDataSet.
 
 
|-
| '''Volume Fraction Value'''<br>''(VolumeFractionSurfaceValue)''
|
The value of this property is the volume fraction value for the surface.
| 0.1
|
The value must be greater than or equal to 0 and less than or equal to 1.
 
 
|}
 
 
==Reflect==
 
 
This filter takes the union of the input and its reflection over an axis-aligned plane.
The Reflect filter reflects the input dataset across the specified plane. This filter operates on any type of data set and produces an unstructured grid output.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Center'''<br>''(Center)''
|
If the value of the Plane property is X, Y, or Z, then the value of this property specifies the center of the reflection plane.
| 0
|
|-
| '''Copy Input'''<br>''(CopyInput)''
|
If this property is set to 1, the output will contain the union of the input dataset and its reflection. Otherwise the output will contain only the reflection of the input data.
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Reflect filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Plane'''<br>''(Plane)''
|
The value of this property determines which plane to reflect across. If the value is X, Y, or Z, the value of the Center property determines where the plane is placed along the specified axis. The other six options (X Min, X Max, etc.) place the reflection plane at the specified face of the bounding box of the input dataset.
| 0
|
The value must be one of the following: X Min (0), Y Min (1), Z Min (2), X Max (3), Y Max (4), Z Max (5), X (6), Y (7), Z (8).
 
 
|}
 
 
==Resample With Dataset==
 
 
Sample data attributes at the points of a dataset.
Probe is a filter that computes point attributes at specified point positions. The filter has two inputs: the Input and Source. The Input geometric structure is passed through the filter. The point attributes are computed at the Input point positions by interpolating into the source data. For example, we can compute data values on a plane (plane specified as Input) from a volume (Source). The cell data of the source data is copied to the output based on in which source cell each input point is. If an array of the same name exists both in source's point and cell data, only the one from the point data is probed.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the dataset from which to obtain probe values.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point or cell array.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet, vtkCompositeDataSet.
 
 
|-
| '''Source'''<br>''(Source)''
|
This property specifies the dataset whose geometry will be used in determining positions to probe.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|}
 
 
==Ribbon==
 
 
This filter generates ribbon surface from lines. It is useful for displaying streamlines.
The Ribbon filter creates ribbons from the lines in the input data set. This filter is useful for visualizing streamlines. Both the input and output of this filter are polygonal data. The input data set must also have at least one point-centered vector array.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Angle'''<br>''(Angle)''
|
The value of this property specifies the offset angle (in degrees) of the ribbon from the line normal.
| 0
|
The value must be greater than or equal to 0 and less than or equal to 360.
 
 
|-
| '''Default Normal'''<br>''(DefaultNormal)''
|
The value of this property specifies the normal to use when the UseDefaultNormal property is set to 1 or the input contains no vector array (SelectInputVectors property).
| 0 0 1
|
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Ribbon filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
 
 
|-
| '''Scalars'''<br>''(SelectInputScalars)''
|
The value of this property indicates the name of the input scalar array used by this filter. The width of the ribbons will be varied based on the values in the specified array if the value of the Width property is 1.
|
|
An array of scalars is required.
 
 
|-
| '''Vectors'''<br>''(SelectInputVectors)''
|
The value of this property indicates the name of the input vector array used by this filter. If the UseDefaultNormal property is set to 0, the normal vectors for the ribbons come from the specified vector array.
| 1
|
An array of vectors is required.
 
 
|-
| '''Use Default Normal'''<br>''(UseDefaultNormal)''
|
If this property is set to 0, and the input contains no vector array, then default ribbon normals will be generated (DefaultNormal property); if a vector array has been set (SelectInputVectors property), the ribbon normals will be set from the specified array. If this property is set to 1, the default normal (DefaultNormal property) will be used, regardless of whether the SelectInputVectors property has been set.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Vary Width'''<br>''(VaryWidth)''
|
If this property is set to 1, the ribbon width will be scaled according to the scalar array specified in the SelectInputScalars property.
Toggle the variation of ribbon width with scalar value.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Width'''<br>''(Width)''
|
If the VaryWidth property is set to 1, the value of this property is the minimum ribbon width. If the VaryWidth property is set to 0, the value of this property is half the width of the ribbon.
| 1
|
The value must be less than the largest dimension of the dataset multiplied by a scale factor of 0.01.
 
 
|}
 
 
==Rotational Extrusion==
 
 
This filter generates a swept surface while translating the input along a circular path.
The Rotational Extrusion filter forms a surface by rotating the input about the Z axis. This filter is intended to operate on 2D polygonal data. It produces polygonal output.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Angle'''<br>''(Angle)''
|
This property specifies the angle of rotation in degrees. The surface is swept from 0 to the value of this property.
| 360
|
|-
| '''Capping'''<br>''(Capping)''
|
If this property is set to 1, the open ends of the swept surface will be capped with a copy of the input dataset. This works property if the input is a 2D surface composed of filled polygons. If the input dataset is a closed solid (e.g., a sphere), then either two copies of the dataset will be drawn or no surface will be drawn. No surface is drawn if either this property is set to 0 or if the two surfaces would occupy exactly the same 3D space (i.e., the Angle property's value is a multiple of 360, and the values of the Translation and DeltaRadius properties are 0).
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Delta Radius'''<br>''(DeltaRadius)''
|
The value of this property specifies the change in radius during the sweep process.
| 0
|
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Rotational Extrusion filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
 
 
|-
| '''Resolution'''<br>''(Resolution)''
|
The value of this property controls the number of intermediate node points used in performing the sweep (rotating from 0 degrees to the value specified by the Angle property.
| 12
|
The value must be greater than or equal to 1.
 
 
|-
| '''Translation'''<br>''(Translation)''
|
The value of this property specifies the total amount of translation along the Z axis during the sweep process. Specifying a non-zero value for this property allows you to create a corkscrew (value of DeltaRadius > 0) or spring effect.
| 0
|
|}
 
 
==Scatter Plot==
 
 
Creates a scatter plot from a dataset.
This filter creates a scatter plot from a dataset. In point data mode,<br>
it uses the X point coordinates as the default X array. All other arrays<br>
are passed to the output and can be used in the scatter plot. In cell<br>
data mode, the first single component array is used as the default X<br>
array.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|}
 
 
==Shrink==
 
 
This filter shrinks each input cell so they pull away from their neighbors.
The Shrink filter causes the individual cells of a dataset to break apart from each other by moving each cell's points toward the centroid of the cell. (The centroid of a cell is the average position of its points.) This filter operates on any type of dataset and produces unstructured grid output.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Shrink filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Shrink Factor'''<br>''(ShrinkFactor)''
|
The value of this property determines how far the points will move. A value of 0 positions the points at the centroid of the cell; a value of 1 leaves them at their original positions.
| 0.5
|
The value must be greater than or equal to 0 and less than or equal to 1.
 
 
|}
 
 
==Slice==
 
 
This filter slices a data set with a plane. Slicing is similar to a contour. It creates surfaces from volumes and lines from surfaces.
This filter extracts the portion of the input dataset that lies along the specified plane. The Slice filter takes any type of dataset as input. The output of this filter is polygonal data.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Slice Offset Values'''<br>''(ContourValues)''
|
The values in this property specify a list of current offset values. This can be used to create multiple slices with different centers. Each entry represents a new slice with its center shifted by the offset value.
|
|
Determine the length of the dataset's diagonal. The value must lie within -diagonal length to +diagonal length.
 
 
|-
| '''Slice Type'''<br>''(CutFunction)''
|
This property sets the parameters of the slice function.
|
|
The value must be set to one of the following: Plane, Box, Sphere.
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Slice filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|}
 
 
==Smooth==
 
 
This filter smooths a polygonal surface by iteratively moving points toward their neighbors.
The Smooth filter operates on a polygonal data set by iteratively adjusting the position of the points using Laplacian smoothing. (Because this filter only adjusts point positions, the output data set is also polygonal.) This results in better-shaped cells and more evenly distributed points.<br><br><br>
The Convergence slider limits the maximum motion of any point. It is expressed as a fraction of the length of the diagonal of the bounding box of the data set. If the maximum point motion during a smoothing iteration is less than the Convergence value, the smoothing operation terminates.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Convergence'''<br>''(Convergence)''
|
The value of this property limits the maximum motion of any point. It is expressed as a fraction of the length of the diagonal of the bounding box of the input dataset. If the maximum point motion during a smoothing iteration is less than the value of this property, the smoothing operation terminates.
| 0
|
The value must be greater than or equal to 0 and less than or equal to 1.
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Smooth filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
 
 
|-
| '''Number of Iterations'''<br>''(NumberOfIterations)''
|
This property sets the maximum number of smoothing iterations to perform. More iterations produce better smoothing.
| 20
|
The value must be greater than or equal to 0.
 
 
|}
 
 
==Stream Tracer==
 
 
Integrate streamlines in a vector field.
The Stream Tracer filter generates streamlines in a vector field from a collection of seed points. Production of streamlines terminates if a streamline crosses the exterior boundary of the input dataset. Other reasons for termination are listed for the MaximumNumberOfSteps, TerminalSpeed, and MaximumPropagation properties. This filter operates on any type of dataset, provided it has point-centered vectors. The output is polygonal data containing polylines.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Initial Step Length'''<br>''(InitialIntegrationStep)''
|
This property specifies the initial integration step size. For non-adaptive integrators (Runge-Kutta 2 and Runge-Kutta 4), it is fixed (always equal to this initial value) throughout the integration. For an adaptive integrator (Runge-Kutta 4-5), the actual step size varies such that the numerical error is less than a specified threshold.
| 0.2
|
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Stream Tracer filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point array with 3 components.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Integration Direction'''<br>''(IntegrationDirection)''
|
This property determines in which direction(s) a streamline is generated.
| 2
|
The value must be one of the following: FORWARD (0), BACKWARD (1), BOTH (2).
 
 
|-
| '''Integration Step Unit'''<br>''(IntegrationStepUnit)''
|
This property specifies the unit for Minimum/Initial/Maximum integration step size. The Length unit refers to the arc length that a particle travels/advects within a single step. The Cell Length unit represents the step size as a number of cells.
| 2
|
The value must be one of the following: Length (1), Cell Length (2).
 
 
|-
| '''Integrator Type'''<br>''(IntegratorType)''
|
This property determines which integrator (with increasing accuracy) to use for creating streamlines.
| 2
|
The value must be one of the following: Runge-Kutta 2 (0), Runge-Kutta 4 (1), Runge-Kutta 4-5 (2).
 
 
|-
| '''Interpolator Type'''<br>''(InterpolatorType)''
|
This property determines which interpolator to use for evaluating the velocity vector field. The first is faster though the second is more robust in locating cells during streamline integration.
| 0
|
The value must be one of the following: Interpolator with Point Locator (0), Interpolator with Cell Locator (1).
 
 
|-
| '''Maximum Error'''<br>''(MaximumError)''
|
This property specifies the maximum error (for Runge-Kutta 4-5) tolerated throughout streamline integration. The Runge-Kutta 4-5 integrator tries to adjust the step size such that the estimated error is less than this threshold.
| 1e-06
|
|-
| '''Maximum Step Length'''<br>''(MaximumIntegrationStep)''
|
When using the Runge-Kutta 4-5 ingrator, this property specifies the maximum integration step size.
| 0.5
|
|-
| '''Maximum Steps'''<br>''(MaximumNumberOfSteps)''
|
This property specifies the maximum number of steps, beyond which streamline integration is terminated.
| 2000
|
|-
| '''Maximum Streamline Length'''<br>''(MaximumPropagation)''
|
This property specifies the maximum streamline length (i.e., physical arc length), beyond which line integration is terminated.
| 1
|
The value must be less than the largest dimension of the dataset multiplied by a scale factor of 1.
 
 
|-
| '''Minimum Step Length'''<br>''(MinimumIntegrationStep)''
|
When using the Runge-Kutta 4-5 ingrator, this property specifies the minimum integration step size.
| 0.01
|
|-
| '''Vectors'''<br>''(SelectInputVectors)''
|
This property contains the name of the vector array from which to generate streamlines.
|
|
An array of vectors is required.
 
 
|-
| '''Seed Type'''<br>''(Source)''
|
The value of this property determines how the seeds for the streamlines will be generated.
|
|
The selected object must be the result of the following: sources (includes readers).
 
 
The value must be set to one of the following: PointSource, HighResLineSource.
 
 
|-
| '''Terminal Speed'''<br>''(TerminalSpeed)''
|
This property specifies the terminal speed, below which particle advection/integration is terminated.
| 1e-12
|
|}
 
 
==Stream Tracer With Custom Source==
 
 
Integrate streamlines in a vector field.
The Stream Tracer filter generates streamlines in a vector field from a collection of seed points. Production of streamlines terminates if a streamline crosses the exterior boundary of the input dataset. Other reasons for termination are listed for the MaximumNumberOfSteps, TerminalSpeed, and MaximumPropagation properties. This filter operates on any type of dataset, provided it has point-centered vectors. The output is polygonal data containing polylines. This filter takes a Source input that provides the seed points.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Initial Step Length'''<br>''(InitialIntegrationStep)''
|
This property specifies the initial integration step size. For non-adaptive integrators (Runge-Kutta 2 and Runge-Kutta 4), it is fixed (always equal to this initial value) throughout the integration. For an adaptive integrator (Runge-Kutta 4-5), the actual step size varies such that the numerical error is less than a specified threshold.
| 0.2
|
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Stream Tracer filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point array with 3 components.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Integration Direction'''<br>''(IntegrationDirection)''
|
This property determines in which direction(s) a streamline is generated.
| 2
|
The value must be one of the following: FORWARD (0), BACKWARD (1), BOTH (2).
 
 
|-
| '''Integration Step Unit'''<br>''(IntegrationStepUnit)''
|
This property specifies the unit for Minimum/Initial/Maximum integration step size. The Length unit refers to the arc length that a particle travels/advects within a single step. The Cell Length unit represents the step size as a number of cells.
| 2
|
The value must be one of the following: Length (1), Cell Length (2).
 
 
|-
| '''Integrator Type'''<br>''(IntegratorType)''
|
This property determines which integrator (with increasing accuracy) to use for creating streamlines.
| 2
|
The value must be one of the following: Runge-Kutta 2 (0), Runge-Kutta 4 (1), Runge-Kutta 4-5 (2).
 
 
|-
| '''Maximum Error'''<br>''(MaximumError)''
|
This property specifies the maximum error (for Runge-Kutta 4-5) tolerated throughout streamline integration. The Runge-Kutta 4-5 integrator tries to adjust the step size such that the estimated error is less than this threshold.
| 1e-06
|
|-
| '''Maximum Step Length'''<br>''(MaximumIntegrationStep)''
|
When using the Runge-Kutta 4-5 ingrator, this property specifies the maximum integration step size.
| 0.5
|
|-
| '''Maximum Steps'''<br>''(MaximumNumberOfSteps)''
|
This property specifies the maximum number of steps, beyond which streamline integration is terminated.
| 2000
|
|-
| '''Maximum Streamline Length'''<br>''(MaximumPropagation)''
|
This property specifies the maximum streamline length (i.e., physical arc length), beyond which line integration is terminated.
| 1
|
The value must be less than the largest dimension of the dataset multiplied by a scale factor of 1.
 
 
|-
| '''Minimum Step Length'''<br>''(MinimumIntegrationStep)''
|
When using the Runge-Kutta 4-5 ingrator, this property specifies the minimum integration step size.
| 0.01
|
|-
| '''Vectors'''<br>''(SelectInputVectors)''
|
This property contains the name of the vector array from which to generate streamlines.
|
|
An array of vectors is required.
 
 
|-
| '''Source'''<br>''(Source)''
|
This property specifies the input used to obtain the seed points.
|
|
The selected object must be the result of the following: sources (includes readers).
 
 
|-
| '''Terminal Speed'''<br>''(TerminalSpeed)''
|
This property specifies the terminal speed, below which particle advection/integration is terminated.
| 1e-12
|
|}
 
 
==Subdivide==
 
 
This filter iteratively divide triangles into four smaller triangles. New points are placed linearly so the output surface matches the input surface.
The Subdivide filter iteratively divides each triangle in the input dataset into 4 new triangles. Three new points are added per triangle -- one at the midpoint of each edge. This filter operates only on polygonal data containing triangles, so run your polygonal data through the Triangulate filter first if it is not composed of triangles. The output of this filter is also polygonal.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This parameter specifies the input to the Subdivide filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
 
 
|-
| '''Number of Subdivisions'''<br>''(NumberOfSubdivisions)''
|
The value of this property specifies the number of subdivision iterations to perform.
| 1
|
The value must be greater than or equal to 1 and less than or equal to 4.
 
 
|}
 
 
==Surface Flow==
 
 
This filter integrates flow through a surface.
The flow integration fitler integrates the dot product of a point flow vector field and surface normal. It computes the net flow across the 2D surface. It operates on any type of dataset and produces an unstructured grid output.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Surface Flow filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point array with 3 components.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Select Input Vectors'''<br>''(SelectInputVectors)''
|
The value of this property specifies the name of the input vector array containing the flow vector field.
|
|
An array of vectors is required.
 
 
|}
 
 
==Surface Vectors==
 
 
This filter constrains vectors to lie on a surface.
The Surface Vectors filter is used for 2D data sets. It constrains vectors to lie in a surface by removing components of the vectors normal to the local surface.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Constraint Mode'''<br>''(ConstraintMode)''
|
This property specifies whether the vectors will be parallel or perpendicular to the surface. If the value is set to PerpendicularScale (2), then the output will contain a scalar array with the dot product of the surface normal and the vector at each point.
| 0
|
The value must be one of the following: Parallel (0), Perpendicular (1), PerpendicularScale (2).
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Surface Vectors filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point array with 3 components.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Select Input Vectors'''<br>''(SelectInputVectors)''
|
This property specifies the name of the input vector array to process.
|
|
An array of vectors is required.
 
 
|}
 
 
==Table To Points==
 
 
Converts table to set of points.
The TableToPolyData filter converts a vtkTable to a set of points in a<br>
vtkPolyData. One must specifies the columns in the input table to use as<br>
the X, Y and Z coordinates for the points in the output.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input..
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a array with 1 components.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkTable.
 
 
|-
| '''X Column'''<br>''(XColumn)''
|
|
|
An array of scalars is required.
 
 
|-
| '''Y Column'''<br>''(YColumn)''
|
|
|
An array of scalars is required.
 
 
|-
| '''Z Column'''<br>''(ZColumn)''
|
|
|
An array of scalars is required.
 
 
|}
 
 
==Table To Structured Grid==
 
 
Converts to table to structured grid.
The TableToStructuredGrid filter converts a vtkTable to a<br>
vtkStructuredGrid. One must specifies the columns in the input table to<br>
use as the X, Y and Z coordinates for the points in the output, and the<br>
whole extent.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input..
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a array with 1 components.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkTable.
 
 
|-
| '''Whole Extent'''<br>''(WholeExtent)''
|
| 0 0 0 0 0 0
|
|-
| '''X Column'''<br>''(XColumn)''
|
|
|
An array of scalars is required.
 
 
|-
| '''Y Column'''<br>''(YColumn)''
|
|
|
An array of scalars is required.
 
 
|-
| '''Z Column'''<br>''(ZColumn)''
|
|
|
An array of scalars is required.
 
 
|}
 
 
==Temporal Cache==
 
 
Saves a copy of the data set for a fixed number of time steps.
The Temporal Cache can be used to save multiple copies of a data set at different time steps to prevent thrashing in the pipeline caused by downstream filters that adjust the requested time step. For example, assume that there is a downstream Temporal Interpolator filter. This filter will (usually) request two time steps from the upstream filters, which in turn (usually) causes the upstream filters to run twice, once for each time step. The next time the interpolator requests the same two time steps, they might force the upstream filters to re-evaluate the same two time steps. The Temporal Cache can keep copies of both of these time steps and provide the requested data without having to run upstream filters.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Cache Size'''<br>''(CacheSize)''
|
The cache size determines the number of time steps that can be cached at one time. The maximum number is 10. The minimum is 2 (since it makes little sense to cache less than that).
| 2
|
The value must be greater than or equal to 2 and less than or equal to 10.
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input of the Temporal Cache filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataObject.
 
 
|}
 
 
==Temporal Interpolator==
 
 
Interpolate between time steps.
The Temporal Interpolator converts data that is defined at discrete time steps to one that is defined over a continuum of time by linearly interpolating the data's field data between two adjacent time steps. The interpolated values are a simple approximation and should not be interpreted as anything more. The Temporal Interpolator assumes that the topology between adjacent time steps does not change.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Discrete Time Step Interval'''<br>''(DiscreteTimeStepInterval)''
|
If Discrete Time Step Interval is set to 0, then the Temporal Interpolator will provide a continuous region of time on its output. If set to anything else, then the output will define a finite set of time points on its output, each spaced by the Discrete Time Step Interval. The output will have (time range)/(discrete time step interval) time steps. (Note that the time range is defined by the time range of the data of the input filter, which may be different from other pipeline objects or the range defined in the animation inspector.) This is a useful option to use if you have a dataset with one missing time step and wish to 'file-in' the missing data with an interpolated value from the steps on either side.
| 0
|
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input of the Temporal Interpolator.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataObject.
 
 
|}
 
 
==Temporal Shift Scale==
 
 
Shift and scale time values.
The Temporal Shift Scale filter linearly transforms the time values of a pipeline object by applying a shift and then scale. Given a data at time t on the input, it will be transformed to time t*Shift + Scale on the output. Inversely, if this filter has a request for time t, it will request time (t-Shift)/Scale on its input.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
The input to the Temporal Shift Scale filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataObject.
 
 
|-
| '''Maximum Number Of Periods'''<br>''(MaximumNumberOfPeriods)''
|
| 1
|
The value must be greater than or equal to 0 and less than or equal to 100.
 
 
|-
| '''Periodic'''<br>''(Periodic)''
|
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Periodic End Correction'''<br>''(PeriodicEndCorrection)''
|
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Post Shift'''<br>''(PostShift)''
|
The amount of time the input is shifted.
| 0
|
|-
| '''Pre Shift'''<br>''(PreShift)''
|
| 0
|
|-
| '''Scale'''<br>''(Scale)''
|
The factor by which the input time is scaled.
| 1
|
|}
 
 
==Temporal Snap-to-Time-Step==
 
 
Modifies the time range/steps of temporal data.
This file modifies the time range or time steps of<br>
the data without changing the data itself. The data is not resampled<br>
by this filter, only the information accompanying the data is modified.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataObject.
 
 
|-
| '''Snap Mode'''<br>''(SnapMode)''
|
Determine which time step to snap to.
| 0
|
The value must be one of the following: Nearest (0), NextBelowOrEqual (1), NextAboveOrEqual (2).
 
 
|}
 
 
==Temporal Statistics==
 
 
Loads in all time steps of a data set and computes some statistics about how each point and cell variable changes over time.
Given an input that changes over time, vtkTemporalStatistics looks<br>
at the data for each time step and computes some statistical<br>
information of how a point or cell variable changes over time. For<br>
example, vtkTemporalStatistics can compute the average value of<br>
"pressure" over time of each point.<br><br><br>
Note that this filter will require the upstream filter to be run on<br>
every time step that it reports that it can compute. This may be a<br>
time consuming operation.<br><br><br>
vtkTemporalStatistics ignores the temporal spacing. Each timestep<br>
will be weighted the same regardless of how long of an interval it<br>
is to the next timestep. Thus, the average statistic may be quite<br>
different from an integration of the variable if the time spacing<br>
varies.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Compute Average'''<br>''(ComputeAverage)''
|
Compute the average of each point and cell variable over time.
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Compute Maximum'''<br>''(ComputeMaximum)''
|
Compute the maximum of each point and cell variable over time.
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Compute Minimum'''<br>''(ComputeMinimum)''
|
Compute the minimum of each point and cell variable over time.
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Compute Standard Deviation'''<br>''(ComputeStandardDeviation)''
|
Compute the standard deviation of each point and cell variable over time.
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Input'''<br>''(Input)''
|
Set the input to the Temporal Statistics filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|}
 
 
==Tessellate==
 
 
Tessellate nonlinear curves, surfaces, and volumes with lines, triangles, and tetrahedra.
The Tessellate filter tessellates cells with nonlinear geometry and/or scalar fields into a simplicial complex with linearly interpolated field values that more closely approximate the original field. This is useful for datasets containing quadratic cells.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Chord Error'''<br>''(ChordError)''
|
This property controls the maximum chord error allowed at any edge midpoint in the output tessellation. The chord error is measured as the distance between the midpoint of any output edge and the original nonlinear geometry.
| 0.001
|
|-
| '''Field Error'''<br>''(FieldError2)''
|
This proeprty controls the maximum field error allowed at any edge midpoint in the output tessellation. The field error is measured as the difference between a field value at the midpoint of an output edge and the value of the corresponding field in the original nonlinear geometry.
|
|
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Tessellate filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData, vtkDataSet, vtkUnstructuredGrid.
 
 
|-
| '''Maximum Number of Subdivisions'''<br>''(MaximumNumberOfSubdivisions)''
|
This property specifies the maximum number of times an edge may be subdivided. Increasing this number allows further refinement but can drastically increase the computational and storage requirements, especially when the value of the OutputDimension property is 3.
| 3
|
The value must be greater than or equal to 0 and less than or equal to 8.
 
 
|-
| '''Merge Points'''<br>''(MergePoints)''
|
If the value of this property is set to 1, coincident vertices will be merged after tessellation has occurred. Only geometry is considered during the merge and the first vertex encountered is the one whose point attributes will be used. Any discontinuities in point fields will be lost. On the other hand, many operations, such as streamline generation, require coincident vertices to be merged.
Toggle whether to merge coincident vertices.
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Output Dimension'''<br>''(OutputDimension)''
|
The value of this property sets the maximum dimensionality of the output tessellation. When the value of this property is 3, 3D cells produce tetrahedra, 2D cells produce triangles, and 1D cells produce line segments. When the value is 2, 3D cells will have their boundaries tessellated with triangles. When the value is 1, all cells except points produce line segments.
| 3
|
The value must be greater than or equal to 1 and less than or equal to 3.
 
 
|}
 
 
==Tetrahedralize==
 
 
This filter converts 3-d cells to tetrahedrons and polygons to triangles. The output is always of type unstructured grid.
The Tetrahedralize filter converts the 3D cells of any type of dataset to tetrahedrons and the 2D ones to triangles. This filter always produces unstructured grid output.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|  
This property specifies the input to the Tetrahedralize filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|}
 
 
==Texture Map to Cylinder==
 
 
Generate texture coordinates by mapping points to cylinder.
This is a filter that generates 2D texture coordinates by mapping input<br>
dataset points onto a cylinder. The cylinder is generated automatically.<br>
The cylinder is generated automatically by computing the axis of the<br>
cylinder. Note that the generated texture coordinates for the s-coordinate<br>
ranges from (0-1) (corresponding to angle of 0->360 around axis), while the<br>
mapping of the t-coordinate is controlled by the projection of points along<br>
the axis.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
Set the input to the Texture Map to Cylinder filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Prevent Seam'''<br>''(PreventSeam)''
|
Control how the texture coordinates are generated. If Prevent Seam
is set, the s-coordinate ranges from 0->1 and 1->0 corresponding
to the theta angle variation between 0->180 and 180->0
degrees. Otherwise, the s-coordinate ranges from 0->1 between
0->360 degrees.
| 1
|
Only the values 0 and 1 are accepted.
 
 
|}
 
 
==Texture Map to Plane==
 
 
Generate texture coordinates by mapping points to plane.
TextureMapToPlane is a filter that generates 2D texture coordinates by<br>
mapping input dataset points onto a plane. The plane is generated<br>
automatically. A least squares method is used to generate the plane<br>
automatically.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
Set the input to the Texture Map to Plane filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|}
 
 
==Texture Map to Sphere==
 
 
Generate texture coordinates by mapping points to sphere.
This is a filter that generates 2D texture coordinates by mapping input<br>
dataset points onto a sphere. The sphere is generated automatically. The<br>
sphere is generated automatically by computing the center i.e. averaged<br>
coordinates, of the sphere. Note that the generated texture coordinates<br>
range between (0,1). The s-coordinate lies in the angular direction around<br>
the z-axis, measured counter-clockwise from the x-axis. The t-coordinate<br>
lies in the angular direction measured down from the north pole towards<br>
the south pole.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
Set the input to the Texture Map to Sphere filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Prevent Seam'''<br>''(PreventSeam)''
|
Control how the texture coordinates are generated. If Prevent Seam
is set, the s-coordinate ranges from 0->1 and 1->0 corresponding
to the theta angle variation between 0->180 and 180->0
degrees. Otherwise, the s-coordinate ranges from 0->1 between
0->360 degrees.
| 1
|
Only the values 0 and 1 are accepted.
 
 
|}
 
 
==Threshold==
 
 
This filter extracts cells that have point or cell scalars in the specified range.
The Threshold filter extracts the portions of the input dataset whose scalars lie within the specified range. This filter operates on either point-centered or cell-centered data. This filter operates on any type of dataset and produces unstructured grid output.<br><br><br>
To select between these two options, select either Point Data or Cell Data from the Attribute Mode menu. Once the Attribute Mode has been selected, choose the scalar array from which to threshold the data from the Scalars menu. The Lower Threshold and Upper Threshold sliders determine the range of the scalars to retain in the output. The All Scalars check box only takes effect when the Attribute Mode is set to Point Data. If the All Scalars option is checked, then a cell will only be passed to the output if the scalar values of all of its points lie within the range indicated by the Lower Threshold and Upper Threshold sliders. If unchecked, then a cell will be added to the output if the specified scalar value for any of its points is within the chosen range.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''All Scalars'''<br>''(AllScalars)''
|
If the value of this property is 1, then a cell is only included in the output if the value of the selected array for all its points is within the threshold. This is only relevant when thresholding by a point-centered array.
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Threshold filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point or cell array with 1 components.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkDataSet.
 
 
|-
| '''Scalars'''<br>''(SelectInputScalars)''
|
The value of this property contains the name of the scalar array from which to perform thresholding.
|
|
An array of scalars is required.
 
 
Valud array names will be chosen from point and cell data.
 
 
|-
| '''Threshold Range'''<br>''(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.
 
 
|}
 
 
==Transform==
 
 
This filter applies transformation to the polygons.
The Transform filter allows you to specify the position, size, and orientation of polygonal, unstructured grid, and curvilinear data sets.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Transform filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPointSet.
 
 
|-
| '''Transform'''<br>''(Transform)''
|
The values in this property allow you to specify the transform (translation, rotation, and scaling) to apply to the input dataset.
|
|
The selected object must be the result of the following: transforms.
 
 
The value must be set to one of the following: Transform3.
 
 
|}
 
 
==Triangle Strips==
 
 
This filter uses a greedy algorithm to convert triangles into triangle strips
The Triangle Strips filter converts triangles into triangle strips and lines into polylines. This filter operates on polygonal data sets and produces polygonal output.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Triangle Strips filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
 
 
|-
| '''Maximum Length'''<br>''(MaximumLength)''
|
This property specifies the maximum number of triangles/lines to include in a triangle strip or polyline.
| 1000
|
The value must be greater than or equal to 4 and less than or equal to 100000.
 
 
|}
 
 
==Triangulate==
 
 
This filter converts polygons and triangle strips to basic triangles.
The Triangulate filter decomposes polygonal data into only triangles, points, and lines. It separates triangle strips and polylines into individual triangles and lines, respectively. The output is polygonal data. Some filters that take polygonal data as input require that the data be composed of triangles rather than other polygons, so passing your data through this filter first is useful in such situations. You should use this filter in these cases rather than the Tetrahedralize filter because they produce different output dataset types. The filters referenced require polygonal input, and the Tetrahedralize filter produces unstructured grid output.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Triangulate filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
 
 
|}
 
 
==Tube==
 
 
Convert lines into tubes. Normals are used to avoid cracks between tube segments.
The Tube filter creates tubes around the lines in the input polygonal dataset. The output is also polygonal.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Capping'''<br>''(Capping)''
|
If this property is set to 1, endcaps will be drawn on the tube. Otherwise the ends of the tube will be open.
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Default Normal'''<br>''(DefaultNormal)''
|
The value of this property specifies the normal to use when the UseDefaultNormal property is set to 1 or the input contains no vector array (SelectInputVectors property).
| 0 0 1
|
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Tube filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPolyData.
 
 
|-
| '''Number of Sides'''<br>''(NumberOfSides)''
|
The value of this property indicates the number of faces around the circumference of the tube.
| 6
|
The value must be greater than or equal to 3.
 
 
|-
| '''Radius'''<br>''(Radius)''
|
The value of this property sets the radius of the tube. If the radius is varying (VaryRadius property), then this value is the minimum radius.
| 1
|
The value must be less than the largest dimension of the dataset multiplied by a scale factor of 0.01.
 
 
|-
| '''Radius Factor'''<br>''(RadiusFactor)''
|
If varying the radius (VaryRadius property), the property sets the
maximum tube radius in terms of a multiple of the minimum radius. If
not varying the radius, this value has no effect.
| 10
|
|-
| '''Scalars'''<br>''(SelectInputScalars)''
|
This property indicates the name of the scalar array on which to
operate. The indicated array may be used for scaling the tubes.
(See the VaryRadius property.)
|
|
An array of scalars is required.
 
 
|-
| '''Vectors'''<br>''(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 tubes. (See the VaryRadius property.)
| 1
|
An array of vectors is required.
 
 
|-
| '''Use Default Normal'''<br>''(UseDefaultNormal)''
|
If this property is set to 0, and the input contains no vector array, then default ribbon normals will be generated (DefaultNormal property); if a vector array has been set (SelectInputVectors property), the ribbon normals will be set from the specified array. If this property is set to 1, the default normal (DefaultNormal property) will be used, regardless of whether the SelectInputVectors property has been set.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''Vary Radius'''<br>''(VaryRadius)''
|
The property determines whether/how to vary the radius of the tube. If
varying by scalar (1), the tube radius is based on the point-based
scalar values in the dataset. If it is varied by vector, the vector
magnitude is used in varying the radius.
| 0
|
The value must be one of the following: Off (0), By Scalar (1), By Vector (2), By Absolute Scalar (3).
 
 
|}
 
 
==Warp By Scalar==
 
 
This filter moves point coordinates along a vector scaled by a point attribute. It can be used to produce carpet plots.
The Warp (scalar) filter translates the points of the input data set along a vector by a distance determined by the specified scalars. This filter operates on polygonal, curvilinear, and unstructured grid data sets containing single-component scalar arrays. Because it only changes the positions of the points, the output data set type is the same as that of the input. Any scalars in the input dataset are copied to the output, so the data can be colored by them.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Warp (scalar) filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point array with 1 components.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPointSet.
 
 
|-
| '''Normal'''<br>''(Normal)''
|
The values of this property specify the direction along which to warp the dataset if any normals contained in the input dataset are not being used for this purpose. (See the UseNormal property.)
| 0 0 1
|
|-
| '''Scale Factor'''<br>''(ScaleFactor)''
|
The scalar value at a given point is multiplied by the value of this property to determine the magnitude of the change vector for that point.
| 1
|
|-
| '''Scalars'''<br>''(SelectInputScalars)''
|
This property contains the name of the scalar array by which to warp the dataset.
|
|
An array of scalars is required.
 
 
|-
| '''Use Normal'''<br>''(UseNormal)''
|
If point normals are present in the dataset, the value of this property toggles whether to use a single normal value (value = 1) or the normals from the dataset (value = 0).
| 0
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''XY Plane'''<br>''(XYPlane)''
|
If the value of this property is 1, then the Z-coordinates from the input are considered to be the scalar values, and the displacement is along the Z axis. This is useful for creating carpet plots.
| 0
|
Only the values 0 and 1 are accepted.
 
 
|}
 
 
==Warp By Vector==
 
 
This filter displaces point coordinates along a vector attribute. It is useful for showing mechanical deformation.
The Warp (vector) filter translates the points of the input dataset using a specified vector array. The vector array chosen specifies a vector per point in the input. Each point is translated along its vector by a given scale factor. This filter operates on polygonal, curvilinear, and unstructured grid datasets. Because this filter only changes the positions of the points, the output dataset type is the same as that of the input.<br>
<!-- End of Proxy Documentation -->
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Input'''<br>''(Input)''
|
This property specifies the input to the Warp (vector) filter.
|
|
The selected object must be the result of the following: sources (includes readers), filters.
 
 
The dataset must contain a point array with 3 components.
 
 
The selected dataset must be one of the following types (or a subclass of one of them): vtkPointSet.
 
 
|-
| '''Scale Factor'''<br>''(ScaleFactor)''
|
Each component of the selected vector array will be multiplied by the value of this property before being used to compute new point coordinates.
| 1
|
|-
| '''Vectors'''<br>''(SelectInputVectors)''
|
The value of this property contains the name of the vector array by which to warp the dataset's point coordinates.
|
|
An array of vectors is required.
 


| 5
|
|}
|}

Revision as of 03:49, 1 February 2011


2D Glyph

Create a 2D glyph (e.g., arrow, cross, dash, etc.)

The 2D Glyph source is used for generating a family of 2D glyphs, each of which lies in the x-y plane. The output of the 2D Glyph source is polygonal data.

Property Description Default Value(s) Restrictions
Center
(Center)

Set the x, y, z coordinates of the origin of the 2D glyph.

0 0 0
Filled
(Filled)

If the value of this property is 1, the 2D glyph will be a filled polygon; otherwise, only the edges (line segments) will be included in the output. This only applies to closed 2D glyphs.

0

Only the values 0 and 1 are accepted.


Glyph Type
(GlyphType)

This property specifies the type of the 2D glyph.

9

The value must be one of the following: Vertex (1), Dash (2), Cross (3), ThickCross (4), Triangle (5), Square (6), Circle (7), Diamond (8), Arrow (9), ThickArrow (10), HookedArrow (11), EdgeArrow (12).



3D Text

3D geometric representation of a text string

The 3D Text source displays a text string as polygonal data.

Property Description Default Value(s) Restrictions
Text
(Text)

This property contains the text string to be displayed. The ASCII alphanumeric characters a-z, A-Z, and 0-9 are supported; so are ASCII punctuation marks. The only supported control character is "\n", which inserts a new line in the text string.

3D Text


Annotate Time

Shows the animation time as text annnotation in the view.

The Annotate Time source can be used to show the animation time in text annotation.

Property Description Default Value(s) Restrictions
Format
(Format)

This property specifies the format used to display the input time (using printf style).

Time: %f


Arrow

3D arrow with a long cylindrical shaft and a cone for the tip

The Arrow source appends a cylinder to a cone to form a 3D arrow. The length of the whole arrow is 1.0 unit. The output of the Arrow source is polygonal data. This polygonal data will not contain normals, so rendering of the arrow will be performed using flat shading. The appearance of the arrow can be improved without significantly increasing the resolution of the tip and shaft by generating normals. (Use Normals Generation filter).

Property Description Default Value(s) Restrictions
Invert
(Invert)

Inverts the arrow direction.

0

Only the values 0 and 1 are accepted.


Shaft Radius
(ShaftRadius)

This property specifies the radius of the shaft of the arrow (the cylinder).

0.03

The value must be greater than or equal to 0 and less than or equal to 5.


Shaft Resolution
(ShaftResolution)

This property specifies the number of faces of the shaft of the arrow (the cylinder). As the resolution increases, the cylinder will become smoother.

6

The value must be greater than or equal to 0 and less than or equal to 128.


Tip Length
(TipLength)

This property specifies the length of the tip.

0.35

The value must be greater than or equal to 0 and less than or equal to 1.


Tip Radius
(TipRadius)

This property specifies the radius of the widest part of the tip of the arrow (the cone).

0.1

The value must be greater than or equal to 0 and less than or equal to 10.


Tip Resolution
(TipResolution)

This property specifies the number of faces in the representation of the tip of the arrow (the cone). As the resolution increases, the cone will become smoother.

6

The value must be greater than or equal to 1 and less than or equal to 128.



Axes

Three lines representing the axes - red line along X, green line along Y, and blue line along Z

The Axes source can be used to add a representation of the coordinate system axes to the 3D scene. The X axis will be drawn as a blue line, the Y axis as a green line, and the Z axis as a red line. The axes can be drawn either as three lines drawn in the positive direction from the origin or as three lines crossing at the origin (drawn in both the positive and negative directions). The output of the Axes source is polygonal data. This polygonal data has a scalar per line so that the lines can be colored. It also has normals defined.

Property Description Default Value(s) Restrictions
Origin
(Origin)

The values of this property set the X, Y, and Z coordinates of the origin of the axes.

0 0 0
Scale Factor
(ScaleFactor)

By default the axes lines have a length of 1 (or 1 in each direction, for a total length of 2, if value of the Symmetric property is 1). Increasing or decreasing the value of this property will make the axes larger or smaller, respectively.

1

The value must be greater than or equal to 0.


Symmetric
(Symmetric)

When this property is set to 1, the axes extend along each of the positive and negative directions for a distance equal to the value of the Scale Factor property. When set to 0, the axes extend only in the positive direction.

0

Only the values 0 and 1 are accepted.



Box

Create a box with specified X, Y, and Z lengths.

The Box source can be used to add a box to the 3D scene. The output of the Box source is polygonal data containing both normals and texture coordinates.

Property Description Default Value(s) Restrictions
Center
(Center)

This property specifies the center of the box.

0 0 0
X Length
(XLength)

This property specifies the length of the box in the X direction.

1

The value must be greater than or equal to 0.


Y Length
(YLength)

This property specifies the length of the box in the Y direction.

1

The value must be greater than or equal to 0.


Z Length
(ZLength)

This property specifies the length of the box in the Z direction.

1

The value must be greater than or equal to 0.



Cone

Create a 3D cone of a given radius and height.

The Cone source can be used to add a polygonal cone to the 3D scene. The output of the Cone source is polygonal data.

Property Description Default Value(s) Restrictions
Capping
(Capping)

If this property is set to 1, the base of the cone will be capped with a filled polygon. Otherwise, the base of the cone will be open.

1

Only the values 0 and 1 are accepted.


Center
(Center)

This property specifies the center of the cone.

0 0 0
Direction
(Direction)

Set the orientation vector of the cone. The vector does not have to be normalized. The cone will point in the direction specified.

1 0 0
Height
(Height)

This property specifies the height of the cone.

1

The value must be greater than or equal to 0.


Radius
(Radius)

This property specifies the radius of the base of the cone.

0.5

The value must be greater than or equal to 0.


Resolution
(Resolution)

This property indicates the number of divisions around the cone. The higher this number, the closer the polygonal approximation will come to representing a cone, and the more polygons it will contain.

6

The value must be greater than or equal to 0 and less than or equal to 512.



Cylinder

Create a 3D cylinder of a given radius and height.

The Cylinder source can be used to add a polygonal cylinder to the 3D scene. The output of the Cylinder source is polygonal data containing both normals and texture coordinates.

Property Description Default Value(s) Restrictions
Capping
(Capping)

If this property is set to 1, the ends of the cylinder will each be capped with a closed polygon. Otherwise, the ends of the cylinder will be open.

1

Only the values 0 and 1 are accepted.


Center
(Center)

This property specifies the coordinate value at the center of the cylinder.

0 0 0
Height
(Height)

This property specifies the height of the cylinder (along the y axis).

1

The value must be greater than or equal to 0.


Radius
(Radius)

This property specifies the radius of the cylinder.

0.5

The value must be greater than or equal to 0.


Resolution
(Resolution)

This property indicates the number of divisions around the cylinder. The higher this number, the closer the polygonal approximation will come to representing a cylinder, and the more polygons it will contain.

6

The value must be greater than or equal to 2 and less than or equal to 512.



Data Object Generator

Parses a string to produce composite data objects consisting of simple templated datasets.

vtkDataObjectGenerator parses a string and produces dataobjects from the
dataobject template names it sees in the string. For example, if the string
contains "ID1" the generator will create a vtkImageData. "UF1", "RG1",
"SG1", "PD1", and "UG1" will produce vtkUniformGrid, vtkRectilinearGrid,
vtkStructuredGrid, vtkPolyData and vtkUnstructuredGrid respectively.
"PD2" will produce an alternate vtkPolydata.
You can compose composite datasets from the atomic ones listed above
by placing them within one of the two composite dataset identifiers
- "MB{}" or "HB[]". "MB{ ID1 PD1 MB{} }" for example will create a
vtkMultiBlockDataSet consisting of three blocks: image data, poly data,
multi-block (empty). Hierarchical Box data sets additionally require
the notion of groups, declared within "()" braces, to specify AMR depth.
"HB[ (UF1)(UF1)(UF1) ]" will create a vtkHierarchicalBoxDataSet representing
an octree that is three levels deep, in which the firstmost cell in each level
is refined.

Property Description Default Value(s) Restrictions
Program
(Program)

This property contains the string that is parsed to determine the structured of the output data object to produce.

ID1


Disk

Create a 3D disk with a specified inner and outer radius.

The Disk source can be used to add a polygonal disk to the 3D scene. The output of the Disk source is polygonal data.

Property Description Default Value(s) Restrictions
Circumferential Resolution
(CircumferentialResolution)

Set the number of points in circumferential direction.

8

The value must be greater than or equal to 3 and less than or equal to 1024.


Inner Radius
(InnerRadius)

Specify inner radius of hole in disc.

0.5

The value must be greater than or equal to 0.


Outer Radius
(OuterRadius)

Specify outer radius of disc.

1

The value must be greater than or equal to 0.


Radial Resolution
(RadialResolution)

Set the number of points in radial direction.

8

The value must be greater than or equal to 3 and less than or equal to 1024.



Hierarchical Fractal

Test source for AMR with HierarchicalDataSet

The Hierarchical Fractal source is a collection of uniform grids. All have the same dimensions. Each block has a different origin and spacing. This source uses the Mandelbrot source to create cell data. The fractal array is scaled to look like a volme fraction.

Property Description Default Value(s) Restrictions
Asymetric
(Asymetric)

If this property is set to 0, all the blocks will be the same size. If it is set to 1, an asymmetric dataset will be created: some blocks will have an X dimension that is larger by 2 units.

0

Only the values 0 and 1 are accepted.


Dimensions
(Dimensions)

This property specifies the X, Y, Z cell dimensions of a block.

10

The value must be greater than or equal to 2 and less than or equal to 64.


Fractal Value
(FractalValue)

The value of this property will be mapped to 0.5 for use as a volume fraction.

9.5

The value must be greater than or equal to 0.


Ghost Levels
(GhostLevels)

This property specifies whether ghost levels should be generated at processor boundaries.

1

Only the values 0 and 1 are accepted.


Maximum Level
(MaximumLevel)

This property specifies how many levels of refinement should be included in this hierarchical dataset.

5

The value must be greater than or equal to 1 and less than or equal to 10.


Rectilinear Grids
(RectilinearGrids)

If this property is set to 1, the hierarchical dataset will contain rectilinear grids; otherwise it will contain uniform grids.

0

Only the values 0 and 1 are accepted.


Time Step
(TimeStep)

This property specifies the timestep to use for this dataset.

0
Two Dimensional
(TwoDimensional)

If this property is set to 1, the generated dataset will be 2D; otherwise it will be 3D.

1

Only the values 0 and 1 are accepted.



Line

This source creates a line between two points. The resolution indicates how many segments are in the line.

The Line source can be used to interactively (using a 3D widget) or manually (using the entries on the user interface) add a line to the 3D scene. The output of the Line source is polygonal data.

Property Description Default Value(s) Restrictions
Point1
(Point1)

This property controls the coordinates of the first endpoint of the line.

-0.5 0 0
Point2
(Point2)

This property controls the coordinates of the second endpoint of the line.

0.5 0 0
Resolution
(Resolution)

This property specifies the number of pieces into which to divide the line.

6

The value must be greater than or equal to 1.



Mandelbrot

Representation (unsigned char) of the Mandlebrot set in up to 3 dimensions

The Mandelbrot source can be used to add a uniform rectilinear grid with scalar values derived from the Mandelbrot set to the 3D scene. The equation used is z = z^2 + C (where z and C are complex, and C is a constant). The scalar values in the grid are the number of iterations of the equation it takes for the magnitude of the value to become greater than 2. In the equation, the initial value of z is 0. By default, the real component of C is mapped onto the X axis; the imaginary component of C is mapped onto the Y axis; and the imaginary component of the initial value is mapped onto the Z axis. If a two-dimensional extent is specified, the resulting image will be displayed. If a three-dimensional extent is used, then the bounding box of the volume will be displayed. The output of the Mandelbrot source is image (uniform rectilinear) data.

Property Description Default Value(s) Restrictions
Maximum Number of Iterations
(MaximumNumberOfIterations)

The value of this property specifies the limit on computational iterations (i.e., the maximum number of iterations to perform to determine if the value will go above 2). Values less than 2.0 after the specified number of iterations are considered in the fractal set.

100

The value must be greater than or equal to 1 and less than or equal to 5000.


Origin CX
(OriginCX)

The four values of this property indicate (in order) the components of C (real and imaginary) and the components of the initial value, X (real and imaginary).

-1.75 -1.25 0 0
Projection Axes
(ProjectionAxes)

The three values in this property allow you to specify the projection from the 4D space used by the Mandelbrot set to the axes of the 3D volume. By default, the real component of C (represented by 0) is mapped to the X axis; the imaginary component of C (represented by 1) is mapped to the Y axis; and the real component of X, the initial value (represented by 2) is mapped to the Z axis. The imaginary component of X is represented by 3. All values entered must be between 0 and 3, inclusive.

0 1 2
Size CX
(SizeCX)

The four values of this property indicate the length of the output in each of the four dimensions (the real and imaginary components of C and the real and imaginary components of X). The three dimensions specified in the Projection Axes property will determine which of these values specify the length of the axes in the output.

2.5 2.5 2 1.5
Subsample Rate
(SubsampleRate)

This property specifies the rate at which to subsample the volume. The extent of the dataset in each dimension will be divided by this value.

1

The value must be greater than or equal to 1.


Whole Extent
(WholeExtent)

The six values in the property indicate the X, Y, and Z extent of the output data. The first two numbers are the minimum and maximum X extent; the next two are the minimum and maximum Y extent; and the final two are the minimum and maximum Z extent. The numbers are inclusive, so values of 0, 250, 0, 250, 0, 0 indicate that the dimensions of the output will be 251 x 251 x 1.

0 250 0 250 0 0


Octree Fractal

Test source for octree with Mandelbrot fractal

Create an octree from a Mandelbrot fractal. See the Mandelbrot source for a description of the variables used.

Property Description Default Value(s) Restrictions
Dimension
(Dimension)

This property specifies the dimensionality of the fractal: 1D - Binary tree line, 2D - Quadtree plane, 3D - Octree volume.

2

The value must be greater than or equal to 1 and less than or equal to 3.


Maximum Level
(MaximumLevel)

This property specifies the maximum refinement level for the grid.

5

The value must be greater than or equal to 2 and less than or equal to 11.


Maximum Number of Iterations
(MaximumNumberOfIterations)

The value of this property specifies the limit on computational iterations (i.e., the maximum number of iterations to perform to determine if the value will go above 2). Values less than 2.0 after the specified number of iterations are considered in the fractal set.

100

The value must be greater than or equal to 1 and less than or equal to 5000.


Minimum Level
(MinimumLevel)

This property specifies the minimum refinement level for the grid.

3

The value must be greater than or equal to 1 and less than or equal to 10.


Origin CX
(OriginCX)

This property specifies the imaginary and real values for C (constant) and X (initial value). See Mandelbrot source for a description of the C and X variables.

-1.75 -1.25 0 0
Projection Axes
(ProjectionAxes)

This property indicates which axes of the dataset to display. See Mandelbrot source for a description of the possible axes.

0 1 2
Size CX
(SizeCX)

The four values of this property indicate the length of the output in each of the four dimensions (the real and imaginary components of C and the real and imaginary components of X). The three dimensions specified in the Projection Axes property will determine which of these values specify the length of the axes in the output.

2.5 2.5 2 1.5
Threshold
(Threshold)

This property specifies a threshold value that determines when to subdivide a leaf node.

2


Outline

3D outline of the specified bounds.

The Outline source creates an axis aligned bounding box given the user-specified minimum and maximum coordinates for each axis.

Property Description Default Value(s) Restrictions
Bounds
(Bounds)

The values of this property specify the minimum and maximum X, Y, and Z coordinates (X min, X max, Y min, Y max, Z min, Z max) for drawing the outline.

0 1 0 1 0 1


Plane

Create a parallelogram given an origin and two points. The resolution indicates the number of division along each axis of the plane.

The Plane source can be used to add a polygonal parallelogram to the 3D scene. Unlike the sphere, cone, and cylinder sources, the parallelogram is exactly represented at the lowest resolution, but higher resolutions may be desired if this plane is to be used as an input to a filter. The output of the Plane source is polygonal data.

Property Description Default Value(s) Restrictions
Origin
(Origin)

This property specifies the 3D coordinate of the origin (one corner) of the plane.

-0.5 -0.5 0
Point1
(Point1)

This property specifies the 3D coordinate a second corner of the parallelogram. The line connecting this point and that specified by the Origin property define one edge of the parallelogram (its X axis).

0.5 -0.5 0
Point2
(Point2)

This property specifies the 3D coordinate a third corner of the parallelogram. The line connecting this point and that specified by the Origin property define a second edge of the parallelogram (its Y axis).

-0.5 0.5 0
X Resolution
(XResolution)

This property specifies the number of divisions along the X axis of the parallelogram.

1

The value must be greater than or equal to 1.


Y Resolution
(YResolution)

This property specifies the number of divisions along the Y axis of the parallelogram.

1

The value must be greater than or equal to 1.



Point Source

Create a point cloud of a certain size, radius, and center.

The point source creates a specified number of points within a given radius about a specified center point.

Property Description Default Value(s) Restrictions
Center
(Center)

This property specifies the 3D coordinates of the center of the point cloud.

0 0 0
Number Of Points
(NumberOfPoints)

This property specifies the number of points in the point cloud.

1

The value must be greater than or equal to 1.


Radius
(Radius)

This property specifies the radius of the point cloud, measured from the value of the Center property.

0

The value must be greater than or equal to 0.



Programmable Source

Executes a user supplied python script to produce an output dataset.

This source will execute a python script to produce an output dataset.
The source keeps a copy of the python script in Script, and creates
Interpretor, a python interpretor to run the script upon the first
execution.

Property Description Default Value(s) Restrictions
Script (RequestInformation)
(InformationScript)

This property is a python script that is executed during the RequestInformation pipeline pass. Use this to provide information such as WHOLE_EXTENT to the pipeline downstream.

Output Data Set Type
(OutputDataSetType)

The value of this property determines the dataset type for the output of the programmable source.

0

The value must be one of the following: Same as Input (8), vtkPolyData (0), vtkStructuredGrid (2), vtkRectilinearGrid (3), vtkUnstructuredGrid (4), vtkImageData (6), vtkMultiblockDataSet (13), vtkHierarchicalBoxDataSet (15), vtkTable (19).


Python Path
(PythonPath)

A semi-colon (;) separated list of directories to add to the python library search path.

Script
(Script)

This property contains the text of a python program that the programmable source runs.


Ruler

This is a line source that can be used to measure distance between two points

The ruler can be used to interactively (using a 3D widget) or manually
(using the entries on the user interface) specify two points and then
determine the distance between the two points. To place points on the
surface of any dataset, one can use the 'p' key shortcut.

Property Description Default Value(s) Restrictions
Point1
(Point1)

This property controls the coordinates of the first endpoint of the line.

-0.5 0 0
Point2
(Point2)

This property controls the coordinates of the second endpoint of the line.

0.5 0 0


Sphere

Create a 3D sphere given a center and radius.

The Sphere source can be used to add a polygonal sphere to the 3D scene. The output of the Sphere source is polygonal data with point normals defined.

Property Description Default Value(s) Restrictions
Center
(Center)

This property specifies the 3D coordinates for the center of the sphere.

0 0 0
End Phi
(EndPhi)

The value of this property can be adjusted to form only a portion of a sphere. The value is measured in degrees.

180

The value must be greater than or equal to 0 and less than or equal to 180.


End Theta
(EndTheta)

The value of this property can be adjusted to form only a portion of a sphere. This value is measured in degrees.

360

The value must be greater than or equal to 0 and less than or equal to 360.


Phi Resolution
(PhiResolution)

The value of this property represents the number of divisions between Start Phi and End Phi on the sphere. (See the Start Phi and End Phi properties.) The phi divisions are similar to latitude lines on the earth.

8

The value must be greater than or equal to 3.


Radius
(Radius)

This property specifies the radius of the sphere.

0.5

The value must be greater than or equal to 0.


Start Phi
(StartPhi)

To form a complete sphere, the value of this property should be 0 degrees, and the value of the End Phi property should be 180 degrees. The value of this property can be adjusted to form only a portion of a sphere. Set the starting angle (in degrees) in the latitudinal direction.

0

The value must be greater than or equal to 0 and less than or equal to 180.


Start Theta
(StartTheta)

To form a complete sphere, the value of this property should be 0 degrees, and the value of the End Theta property should be 360 degrees. The value of this property can be adjusted to form only a portion of a sphere.

0

The value must be greater than or equal to 0 and less than or equal to 360.


Theta Resolution
(ThetaResolution)

The value of this property represents the number of divisions between Start Theta and End Theta around the sphere. (See the Start Theta and End Theta properties.) The theta divisions are similar to longitude lines on the earth. The higher the resolution, the closer the approximation will come to a sphere, and the more polygons there will be.

8

The value must be greater than or equal to 3.



SplineSource

Tessellate parametric functions.

This class tessellates parametric functions. The user must specify how
many points in the parametric coordinate directions are required (i.e.,
the resolution), and the mode to use to generate scalars.

Property Description Default Value(s) Restrictions
Parametric Function
(ParametricFunction)

The value must be set to one of the following: Spline.



Superquadric

Create a superquadric according to the theta and phi roundness parameters. This one source can generate a wide variety of 3D objects including a box, a sphere, or a torus.

The Superquadric source can be used to add a polygonal superquadric to the 3D scene. This source can be used to create a wide variety of shapes (e.g., a sphere, a box, or a torus) by adjusting the roundness parameters. The output of the Superquadric source is polygonal data with point normals and texture coordinates defined.

Property Description Default Value(s) Restrictions
Center
(Center)

This property specifies the 3D coordinates of the center of the superquadric.

0 0 0
Phi Resolution
(PhiResolution)

The value of this property represents the number of divisions in the phi (latitudinal) direction. This number will be rounded to the nearest multiple of 4.

16

The value must be greater than or equal to 4 and less than or equal to 1024.


Phi Roundness
(PhiRoundness)

This property defines the roundness in the phi (latitudinal) direction. A value of 0 represents a rectangular shape, a value of 1 represents a circular shape, and values greater than 1 produce higher order shapes.

1

The value must be greater than or equal to 0.01.


Scale
(Scale)

The three values in this property are used to scale the superquadric in X, Y, and Z. The surface normals will be computed correctly even with anisotropic scaling.

1 1 1
Size
(Size)

The value of this property represents the isotropic size of the superquadric. Note that both the Size and Thickness properties control coefficients of superquadric generation, so the value of this property may not exactly describe the size of the superquadric.

0.5
Theta Resolution
(ThetaResolution)

The value of this property represents the number of divisions in the theta (longitudinal) direction. This value will be rounded to the nearest multiple of 8.

16

The value must be greater than or equal to 8 and less than or equal to 1024.


Theta Roundness
(ThetaRoundness)

This property defines the roundness of the superquadric in the theta (longitudinal) direction. A value of 0 represents a rectangular shape, a value of 1 represents a circular shape, and values greater than 1 produce higher order shapes.

1

The value must be greater than or equal to 0.01.


Thickness
(Thickness)

If the value of the Toroidal property is 1, this value represents the thickness of the superquadric as a value between 0 and 1. A value close to 0 leads to a thin object with a large hole, and a value near 1 leads to a thick object with a very small hole. Changing the thickness does not change the outer radius of the superquadric.

0.3333

The value must be greater than or equal to 0.0001 and less than or equal to 1.


Toroidal
(Toroidal)

If the value of this property is 0, the generated superquadric will not contain a hole (i.e., the superquadric will be ellipsoidal). Otherwise, a toroidal object is generated.

1

Only the values 0 and 1 are accepted.



Text

The Text source generates a table containing text.

The Text source is used to generate a 1x1 vtkTable with a single text string.

Property Description Default Value(s) Restrictions
Text
(Text)

This property specifies the text to display.

Text


Time Source

Produces a single cell uniform grid with data values that vary over a sin(t) wave from t=0 to t=1 (radian).

Produces a single cell uniform grid with data values that vary over a
sin(t) wave from t=0 to t=1 (radian).

Property Description Default Value(s) Restrictions
Analytic
(Analytic)

Makes the time source produce discrete steps of or an analytic sin wave.

0

Only the values 0 and 1 are accepted.


Growing
(Growing)

Makes the time source grow and shrink along Y over time.

0

Only the values 0 and 1 are accepted.


X Amplitude
(X Amplitude)

Controls how far the data set moves along X over time.

0
Y Amplitude
(Y Amplitude)

Controls how far the data set moves along Y over time.

0


Wavelet

Create a regular rectilinear grid in up to three dimensions with values varying according to a periodic function.

The Wavelet source can be used to create a uniform rectilinear grid in up to three dimensions with values varying according to the following periodic function.
OS = M * G * (XM * sin(XF * x) + YM * sin(YF * y) + ZM * cos(ZF * z))
OS is the output scalar; M represents the maximum value; G represents the Gaussian; XM, YM, and ZM are the X, Y, and Z magnitude values; and XF, YF, and ZF are the X, Y, and Z frequency values. If a two-dimensional extent is specified, the resulting image will be displayed. If a three-dimensional extent is used, then the bounding box of the volume will be displayed.

Property Description Default Value(s) Restrictions
Center
(Center)

This property specifies the 3D coordinates of the center of the dataset.

0 0 0
Maximum
(Maximum)

This parameter specifies the maximum value (M) of the function.

255
Standard Deviation
(StandardDeviation)

This property specifies the standard deviation of the Gaussian used in computing this function.

0.5
Subsample Rate
(SubsampleRate)

This property specifies the rate at which to subsample the volume. The extent of the dataset in each dimension will be divided by this value. (See the Whole Extent property.)

1

The value must be greater than or equal to 1.


Whole Extent
(WholeExtent)

The six values in this property indicate the X, Y, and Z extent of the output data. The first two values represent the minimum and maximum X indices, the next two are the minimum and maximum Y indices, and the last two are the minimum and maximum Z indices.

-10 10 -10 10 -10 10
X Freq
(XFreq)

This property specifies the natural frequency in X (XF in the equation).

60
X Mag
(XMag)

This property specifies the wave amplitude in X (XM in the equation).

10
Y Freq
(YFreq)

This property specifies the natural frequency in Y (YF in the equation).

30
Y Mag
(YMag)

This property specifies the wave amplitude in Y (YM in the equation).

18
Z Freq
(ZFreq)

This property specifies the natural frequency in Z (ZF in the equation).

40
Z Mag
(ZMag)

This property specifies the wave amplitude in Z (ZM in the equation).

5
Retrieved from "https://public.kitware.com/Wiki/index.php?title=Api.php&oldid=37078"