

Line 1: 
Line 1: 
   {{ParaView/Template/DeprecatedUsersGuide}} 
 ==AMR Contour==
 
  
 Iso surface cell array.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"  
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input of the
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkCompositeDataSet
 
 The dataset much contain a field array (cell)
 
  
 with 1 component(s).
 
  
 
 
 '''SelectMaterialArrays''' (SelectMaterialArrays)
 
 
 
 This property specifies the cell arrays from which the
 
 contour filter will compute contour cells.
 
 
 
  
 
 
 An array of scalars is required.
 
 
 
 '''Volume Fraction Value''' (VolumeFractionSurfaceValue)
 
 
 
 This property specifies the values at which to compute
 
 the isosurface.
 
 
 
 0.1
 
 
 
  
 
 
 '''Capping''' (Capping)
 
 
 
 If this property is on, the the boundary of the data set
 
 is capped.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''DegenerateCells''' (DegenerateCells)
 
 
 
 If this property is on, a transition mesh between levels
 
 is created.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''MultiprocessCommunication''' (MultiprocessCommunication)
 
 
 
 If this property is off, each process executes
 
 independantly.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''SkipGhostCopy''' (SkipGhostCopy)
 
 
 
 A simple test to see if ghost values are already set
 
 properly.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''Triangulate''' (Triangulate)
 
 
 
 Use triangles instead of quads on capping
 
 surfaces.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''MergePoints''' (MergePoints)
 
 
 
 Use more memory to merge points on the boundaries of
 
 blocks.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==AMR CutPlane==
 
  
 Planar Cut of an AMR grid datasetThis filter
 
 creates a cutplane of the
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input for this
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkOverlappingAMR
 
 
 
 '''UseNativeCutter''' (UseNativeCutter)
 
 
 
 This property specifies whether the ParaView's generic
 
 dataset cutter is used instead of the specialized AMR
 
 cutter.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''LevelOfResolution''' (LevelOfResolution)
 
 
 
 Set maximum slice resolution.
 
 
 
 0
 
 
 
  
 
 
 '''Center''' (Center)
 
 
 
  
 
 
 0.5 0.5 0.5
 
 
 
  
 
 
 '''Normal''' (Normal)
 
 
 
  
 
 
 0 0 1
 
 
 
  
  
 }
 
  
 ==AMR Dual Clip==
 
  
 Clip with scalars. Tetrahedra.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input of the
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkCompositeDataSet
 
 The dataset much contain a field array (cell)
 
  
 with 1 component(s).
 
  
 
 
 '''SelectMaterialArrays''' (SelectMaterialArrays)
 
 
 
 This property specifies the cell arrays from which the
 
 clip filter will compute clipped cells.
 
 
 
  
 
 
 An array of scalars is required.
 
 
 
 '''Volume Fraction Value''' (VolumeFractionSurfaceValue)
 
 
 
 This property specifies the values at which to compute
 
 the isosurface.
 
 
 
 0.1
 
 
 
  
 
 
 '''InternalDecimation''' (InternalDecimation)
 
 
 
 If this property is on, internal tetrahedra are
 
 decimation
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''MultiprocessCommunication''' (MultiprocessCommunication)
 
 
 
 If this property is off, each process executes
 
 independantly.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''MergePoints''' (MergePoints)
 
 
 
 Use more memory to merge points on the boundaries of
 
 blocks.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==All to N==
 
  
 Redistribute data to a subset of available processes.The All to N filter
 
 is available when ParaView is run in parallel. It
 
 redistributes the data so that it is located on the number
 
 of processes specified in the Number of Processes entry
 
 box. It also does loadbalancing of the data among these
 
 processes. This filter operates on polygonal data and
 
 produces polygonal output.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 Set the input to the All to N filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkPolyData
 
 
 
 '''Number of Processes''' (NumberOfProcesses)
 
 
 
 Set the number of processes across which to split the
 
 input data.
 
 
 
 1
 
 
 
  
  
 }
 
  
 ==Annotate Global Data==
 
  
  
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 Set the input of the filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 The dataset much contain a field array (none)
 
  
 with 1 component(s).
 
  
 
 
 '''SelectArrays''' (SelectArrays)
 
 
 
 Choose arrays that is going to be
 
 displayed
 
 
 
  
 
 
  
 
 
 '''Prefix''' (Prefix)
 
 
 
 Text that is used as a prefix to the field
 
 value
 
 
 
 Value is:
 
 
 
  
  
 }
 
  
 ==Annotate Time Filter==
 
  
 Shows input data time as text annnotation in the view.The Annotate Time
 
 filter can be used to show the data time in a text
 
 annotation.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input dataset for which to
 
 display the time.
 
 
 
  
 
 
  
 
 
 '''Format''' (Format)
 
 
 
 The value of this property is a format string used to
 
 display the input time. The format string is specified using printf
 
 style.
 
 
 
 Time: %f
 
 
 
  
 
 
 '''Shift''' (Shift)
 
 
 
 The amount of time the input is shifted (after
 
 scaling).
 
 
 
 0.0
 
 
 
  
 
 
 '''Scale''' (Scale)
 
 
 
 The factor by which the input time is
 
 scaled.
 
 
 
 1.0
 
 
 
  
  
 }
 
  
 ==Append Attributes==
 
  
 Copies geometry from first input. Puts all of the arrays into the output.
 
 The Append Attributes filter takes multiple input data
 
 sets with the same geometry and merges their point and
 
 cell attributes to produce a single output containing all
 
 the point and cell attributes of the inputs. Any inputs
 
 without the same number of points and cells as the first
 
 input are ignored. The input data sets must already be
 
 collected together, either as a result of a reader that
 
 loads multiple parts (e.g., EnSight reader) or because the
 
 Group Parts filter has been run to form a collection of
 
 data sets.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Append
 
 Attributes filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
  
 }
 
  
 ==Append Datasets==
 
  
 Takes an input of multiple datasets and output has only one unstructured grid.The Append
 
 Datasets filter operates on multiple data sets of any type
 
 (polygonal, structured, etc.). It merges their geometry
 
 into a single data set. Only the point and cell attributes
 
 that all of the input data sets have in common will appear
 
 in the output. The input data sets must already be
 
 collected together, either as a result of a reader that
 
 loads multiple parts (e.g., EnSight reader) or because the
 
 Group Parts filter has been run to form a collection of
 
 data sets.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the datasets to be merged into a
 
 single dataset by the Append Datasets filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
  
 }
 
  
 ==Append Geometry==
 
  
 Takes an input of multiple poly data parts and output has only one part.The Append
 
 Geometry filter operates on multiple polygonal data sets.
 
 It merges their geometry into a single data set. Only the
 
 point and cell attributes that all of the input data sets
 
 have in common will appear in the output.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 Set the input to the Append Geometry
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkPolyData
 
  
 }
 
  
 ==Balance==
 
  
 Balance data among available processes.The Balance filter is
 
 available when ParaView is run in parallel. It does
 
 loadbalancing so that all processes have the same number
 
 of cells. It operates on polygonal data sets and produces
 
 polygonal output.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 Set the input to the Balance filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkPolyData
 
  
 }
 
  
 ==Block Scalars==
 
  
 The Level Scalars filter uses colors to show levels of a multiblock dataset.The Level
 
 Scalars filter uses colors to show levels of a multiblock
 
 dataset.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Level Scalars
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkMultiBlockDataSet
 
  
 }
 
  
 ==CTH Surface==
 
  
 Not finished yet.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input of the
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkCompositeDataSet
 
  
 }
 
  
 ==CacheKeeper==
 
  
 vtkPVCacheKeeper manages data cache for flip book
 
 animations. When caching is disabled, this simply acts as a pass through
 
 filter. When caching is enabled, is the current time step has been
 
 previously cached then this filter shuts the update request, otherwise
 
 propagates the update and then cache the result for later use. The
 
 current time step is set using SetCacheTime().
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 Set the input to the Update Suppressor
 
 filter.
 
 
 
  
 
 
  
 
 
 '''CacheTime''' (CacheTime)
 
 
 
  
 
 
 0.0
 
 
 
  
 
 
 '''CachingEnabled''' (CachingEnabled)
 
 
 
 Toggle whether the caching is enabled.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==Calculator==
 
  
 Compute new attribute arrays as function of existing arrays.The Calculator
 
 filter computes a new data array or new point coordinates
 
 as a function of existing scalar or vector arrays. If
 
 pointcentered arrays are used in the computation of a new
 
 data array, the resulting array will also be
 
 pointcentered. Similarly, computations using
 
 cellcentered arrays will produce a new cellcentered
 
 array. If the function is computing point coordinates, the
 
 result of the function must be a threecomponent vector.
 
 The Calculator interface operates similarly to a
 
 scientific calculator. In creating the function to
 
 evaluate, the standard order of operations applies. Each
 
 of the calculator functions is described below. Unless
 
 otherwise noted, enclose the operand in parentheses using
 
 the ( and ) buttons. Clear: Erase the current function
 
 (displayed in the readonly text box above the calculator
 
 buttons). /: Divide one scalar by another. The operands
 
 for this function are not required to be enclosed in
 
 parentheses. *: Multiply two scalars, or multiply a vector
 
 by a scalar (scalar multiple). The operands for this
 
 function are not required to be enclosed in parentheses.
 
 : Negate a scalar or vector (unary minus), or subtract
 
 one scalar or vector from another. The operands for this
 
 function are not required to be enclosed in parentheses.
 
 +: Add two scalars or two vectors. The operands for this
 
 function are not required to be enclosed in parentheses.
 
 sin: Compute the sine of a scalar. cos: Compute the cosine
 
 of a scalar. tan: Compute the tangent of a scalar. asin:
 
 Compute the arcsine of a scalar. acos: Compute the
 
 arccosine of a scalar. atan: Compute the arctangent of a
 
 scalar. sinh: Compute the hyperbolic sine of a scalar.
 
 cosh: Compute the hyperbolic cosine of a scalar. tanh:
 
 Compute the hyperbolic tangent of a scalar. min: Compute
 
 minimum of two scalars. max: Compute maximum of two
 
 scalars. x^y: Raise one scalar to the power of another
 
 scalar. The operands for this function are not required to
 
 be enclosed in parentheses. sqrt: Compute the square root
 
 of a scalar. e^x: Raise e to the power of a scalar. log:
 
 Compute the logarithm of a scalar (deprecated. same as
 
 log10). log10: Compute the logarithm of a scalar to the
 
 base 10. ln: Compute the logarithm of a scalar to the base
 
 'e'. ceil: Compute the ceiling of a scalar. floor: Compute
 
 the floor of a scalar. abs: Compute the absolute value of
 
 a scalar. v1.v2: Compute the dot product of two vectors.
 
 The operands for this function are not required to be
 
 enclosed in parentheses. cross: Compute cross product of
 
 two vectors. mag: Compute the magnitude of a vector. norm:
 
 Normalize a vector. The operands are described below. The
 
 digits 0  9 and the decimal point are used to enter
 
 constant scalar values. iHat, jHat, and kHat are vector
 
 constants representing unit vectors in the X, Y, and Z
 
 directions, respectively. The scalars menu lists the names
 
 of the scalar arrays and the components of the vector
 
 arrays of either the pointcentered or cellcentered data.
 
 The vectors menu lists the names of the pointcentered or
 
 cellcentered vector arrays. The function will be computed
 
 for each point (or cell) using the scalar or vector value
 
 of the array at that point (or cell). The filter operates
 
 on any type of data set, but the input data set must have
 
 at least one scalar or vector array. The arrays can be
 
 either pointcentered or cellcentered. The Calculator
 
 filter's output is of the same data set type as the
 
 input.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input dataset to the
 
 Calculator filter. The scalar and vector variables may be chosen from
 
 this dataset's arrays.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 The dataset much contain a field array ()
 
  
 
 
 '''AttributeMode''' (AttributeMode)
 
 
 
 This property determines whether the computation is to
 
 be performed on pointcentered or cellcentered data.
 
 
 
 1
 
 
 
 The value(s) is an enumeration of the following:
 
 * Point Data (1)
 
 * Cell Data (2)
 
 
 
 '''CoordinateResults''' (CoordinateResults)
 
 
 
 The value of this property determines whether the
 
 results of this computation should be used as point coordinates or as a
 
 new array.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''ResultArrayName''' (ResultArrayName)
 
 
 
 This property contains the name for the output array
 
 containing the result of this computation.
 
 
 
 Result
 
 
 
  
 
 
 '''Function''' (Function)
 
 
 
 This property contains the equation for computing the
 
 new array.
 
 
 
  
 
 
  
 
 
 '''Replace Invalid Results''' (ReplaceInvalidValues)
 
 
 
 This property determines whether invalid values in the
 
 computation will be replaced with a specific value. (See the
 
 ReplacementValue property.)
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''ReplacementValue''' (ReplacementValue)
 
 
 
 If invalid values in the computation are to be replaced
 
 with another value, this property contains that value.
 
 
 
 0.0
 
 
 
  
  
 }
 
  
 ==Cell Centers==
 
  
 Create a point (no geometry) at the center of each input cell.The Cell Centers
 
 filter places a point at the center of each cell in the
 
 input data set. The center computed is the parametric
 
 center of the cell, not necessarily the geometric or
 
 bounding box center. The cell attributes of the input will
 
 be associated with these newly created points of the
 
 output. You have the option of creating a vertex cell per
 
 point in the outpuut. This is useful because vertex cells
 
 are rendered, but points are not. The points themselves
 
 could be used for placing glyphs (using the Glyph filter).
 
 The Cell Centers filter takes any type of data set as
 
 input and produces a polygonal data set as
 
 output.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Cell Centers
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 
 
 '''VertexCells''' (VertexCells)
 
 
 
 If set to 1, a vertex cell will be generated per point
 
 in the output. Otherwise only points will be generated.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==Cell Data to Point Data==
 
  
 Create point attributes by averaging cell attributes.The Cell
 
 Data to Point Data filter averages the values of the cell
 
 attributes of the cells surrounding a point to compute
 
 point attributes. The Cell Data to Point Data filter
 
 operates on any type of data set, and the output data set
 
 is of the same type as the input.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Cell Data to
 
 Point Data filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 The dataset much contain a field array (cell)
 
  
 
 
 '''PassCellData''' (PassCellData)
 
 
 
 If this property is set to 1, then the input cell data
 
 is passed through to the output; otherwise, only the generated point
 
 data will be available in the output.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''PieceInvariant''' (PieceInvariant)
 
 
 
 If the value of this property is set to 1, this filter
 
 will request ghost levels so that the values at boundary points match
 
 across processes. NOTE: Enabling this option might cause multiple
 
 executions of the data source because more information is needed to
 
 remove internal surfaces.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==Clean==
 
  
 Merge coincident points if they do not meet a feature edge criteria.The Clean filter
 
 takes polygonal data as input and generates polygonal data
 
 as output. This filter can merge duplicate points, remove
 
 unused points, and transform degenerate cells into their
 
 appropriate forms (e.g., a triangle is converted into a
 
 line if two of its points are merged).
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 Set the input to the Clean filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkPolyData
 
 
 
 '''PieceInvariant''' (PieceInvariant)
 
 
 
 If this property is set to 1, the whole data set will be
 
 processed at once so that cleaning the data set always produces the
 
 same results. If it is set to 0, the data set can be processed one
 
 piece at a time, so it is not necessary for the entire data set to fit
 
 into memory; however the results are not guaranteed to be the same as
 
 they would be if the Piece invariant option was on. Setting this option
 
 to 0 may produce seams in the output dataset when ParaView is run in
 
 parallel.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''Tolerance''' (Tolerance)
 
 
 
 If merging nearby points (see PointMerging property) and
 
 not using absolute tolerance (see ToleranceIsAbsolute property), this
 
 property specifies the tolerance for performing merging as a fraction
 
 of the length of the diagonal of the bounding box of the input data
 
 set.
 
 
 
 0.0
 
 
 
  
 
 
 '''AbsoluteTolerance''' (AbsoluteTolerance)
 
 
 
 If merging nearby points (see PointMerging property) and
 
 using absolute tolerance (see ToleranceIsAbsolute property), this
 
 property specifies the tolerance for performing merging in the spatial
 
 units of the input data set.
 
 
 
 1.0
 
 
 
  
 
 
 '''ToleranceIsAbsolute''' (ToleranceIsAbsolute)
 
 
 
 This property determines whether to use absolute or
 
 relative (a percentage of the bounding box) tolerance when performing
 
 point merging.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''ConvertLinesToPoints''' (ConvertLinesToPoints)
 
 
 
 If this property is set to 1, degenerate lines (a "line"
 
 whose endpoints are at the same spatial location) will be converted to
 
 points.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''ConvertPolysToLines''' (ConvertPolysToLines)
 
 
 
 If this property is set to 1, degenerate polygons (a
 
 "polygon" with only two distinct point coordinates) will be converted
 
 to lines.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''ConvertStripsToPolys''' (ConvertStripsToPolys)
 
 
 
 If this property is set to 1, degenerate triangle strips
 
 (a triangle "strip" containing only one triangle) will be converted to
 
 triangles.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''PointMerging''' (PointMerging)
 
 
 
 If this property is set to 1, then points will be merged
 
 if they are within the specified Tolerance or AbsoluteTolerance (see
 
 the Tolerance and AbsoluteTolerance propertys), depending on the value
 
 of the ToleranceIsAbsolute property. (See the ToleranceIsAbsolute
 
 property.) If this property is set to 0, points will not be
 
 merged.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==Clean Cells to Grid==
 
  
 This filter merges cells and converts the data set to unstructured grid.Merges degenerate cells. Assumes
 
 the input grid does not contain duplicate points. You may
 
 want to run vtkCleanUnstructuredGrid first to assert it.
 
 If duplicated cells are found they are removed in the
 
 output. The filter also handles the case, where a cell may
 
 contain degenerate nodes (i.e. one and the same node is
 
 referenced by a cell more than once).
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Clean Cells to
 
 Grid filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkUnstructuredGrid
 
  
 }
 
  
 ==Clean to Grid==
 
  
 This filter merges points and converts the data set to unstructured grid.The Clean to Grid filter merges
 
 points that are exactly coincident. It also converts the
 
 data set to an unstructured grid. You may wish to do this
 
 if you want to apply a filter to your data set that is
 
 available for unstructured grids but not for the initial
 
 type of your data set (e.g., applying warp vector to
 
 volumetric data). The Clean to Grid filter operates on any
 
 type of data set.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Clean to Grid
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
  
 }
 
  
 ==ClientServerMoveData==
 
  
  
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 Set the input to the Client Server Move Data
 
 filter.
 
 
 
  
 
 
  
 
 
 '''OutputDataType''' (OutputDataType)
 
 
 
  
 
 
 0
 
 
 
  
 
 
 '''WholeExtent''' (WholeExtent)
 
 
 
  
 
 
 0 1 0 1 0 1
 
 
 
  
  
 }
 
  
 ==Clip==
 
  
 Clip with an implicit plane. Clipping does not reduce the dimensionality of the data set. The output data type of this filter is always an unstructured grid.The Clip filter
 
 cuts away a portion of the input data set using an
 
 implicit plane. This filter operates on all types of data
 
 sets, and it returns unstructured grid data on
 
 output.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the dataset on which the Clip
 
 filter will operate.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 The dataset much contain a field array ()
 
  
 with 1 component(s).
 
  
 
 
 '''Clip Type''' (ClipFunction)
 
 
 
 This property specifies the parameters of the clip
 
 function (an implicit plane) used to clip the dataset.
 
 
 
  
 
 
 The value can be one of the following:
 
 * Plane (implicit_functions)
 
  
 * Box (implicit_functions)
 
  
 * Sphere (implicit_functions)
 
  
 * Scalar (implicit_functions)
 
  
 
 
 '''InputBounds''' (InputBounds)
 
 
 
  
 
 
  
 
 
  
 
 
 '''Scalars''' (SelectInputScalars)
 
 
 
 If clipping with scalars, this property specifies the
 
 name of the scalar array on which to perform the clip
 
 operation.
 
 
 
  
 
 
 An array of scalars is required.The value must be field array name.
 
 
 
 '''Value''' (Value)
 
 
 
 If clipping with scalars, this property sets the scalar
 
 value about which to clip the dataset based on the scalar array chosen.
 
 (See SelectInputScalars.) If clipping with a clip function, this
 
 property specifies an offset from the clip function to use in the
 
 clipping operation. Neither functionality is currently available in
 
 ParaView's user interface.
 
 
 
 0.0
 
 
 
 The value must lie within the range of the selected data array.
 
 
 
 '''InsideOut''' (InsideOut)
 
 
 
 If this property is set to 0, the clip filter will
 
 return that portion of the dataset that lies within the clip function.
 
 If set to 1, the portions of the dataset that lie outside the clip
 
 function will be returned instead.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''UseValueAsOffset''' (UseValueAsOffset)
 
 
 
 If UseValueAsOffset is true, Value is used as an offset
 
 parameter to the implicit function. Otherwise, Value is used only when
 
 clipping using a scalar array.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''Crinkle clip''' (PreserveInputCells)
 
 
 
 This parameter controls whether to extract entire cells
 
 in the given region or clip those cells so all of the output one stay
 
 only inside that region.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==Clip Closed Surface==
 
  
 Clip a polygonal dataset with a plane to produce closed surfaces
 
 This clip filter cuts away a portion of the input polygonal dataset using
 
 a plane to generate a new polygonal dataset.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the dataset on which the Clip
 
 filter will operate.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkPolyData
 
 The dataset much contain a field array (point)
 
  
 with 1 component(s).
 
  
 
 
 '''Clipping Plane''' (ClippingPlane)
 
 
 
 This property specifies the parameters of the clipping
 
 plane used to clip the polygonal data.
 
 
 
  
 
 
 The value can be one of the following:
 
 * Plane (implicit_functions)
 
  
 
 
 '''GenerateFaces''' (GenerateFaces)
 
 
 
 Generate polygonal faces in the output.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''GenerateOutline''' (GenerateOutline)
 
 
 
 Generate clipping outlines in the output wherever an
 
 input face is cut by the clipping plane.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''Generate Cell Origins''' (ScalarMode)
 
 
 
 Generate (cell) data for coloring purposes such that the
 
 newly generated cells (including capping faces and clipping outlines)
 
 can be distinguished from the input cells.
 
 
 
 0
 
 
 
 The value(s) is an enumeration of the following:
 
 * None (0)
 
 * Color (1)
 
 * Label (2)
 
 
 
 '''InsideOut''' (InsideOut)
 
 
 
 If this flag is turned off, the clipper will return the
 
 portion of the data that lies within the clipping plane. Otherwise, the
 
 clipper will return the portion of the data that lies outside the
 
 clipping plane.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''Clipping Tolerance''' (Tolerance)
 
 
 
 Specify the tolerance for creating new points. A small
 
 value might incur degenerate triangles.
 
 
 
 0.000001
 
 
 
  
 
 
 '''Base Color''' (BaseColor)
 
 
 
 Specify the color for the faces from the
 
 input.
 
 
 
 0.10 0.10 1.00
 
 
 
  
 
 
 '''Clip Color''' (ClipColor)
 
 
 
 Specifiy the color for the capping faces (generated on
 
 the clipping interface).
 
 
 
 1.00 0.11 0.10
 
 
 
  
  
 }
 
  
 ==Clip Generic Dataset==
 
  
 Clip with an implicit plane, sphere or with scalars. Clipping does not reduce the dimensionality of the data set. This output data type of this filter is always an unstructured grid.
 
 The Generic Clip filter cuts away a portion of the input
 
 data set using a plane, a sphere, a box, or a scalar
 
 value. The menu in the Clip Function portion of the
 
 interface allows the user to select which implicit
 
 function to use or whether to clip using a scalar value.
 
 Making this selection loads the appropriate user
 
 interface. For the implicit functions, the appropriate 3D
 
 widget (plane, sphere, or box) is also displayed. The use
 
 of these 3D widgets, including their user interface
 
 components, is discussed in section 7.4. If an implicit
 
 function is selected, the clip filter returns that portion
 
 of the input data set that lies inside the function. If
 
 Scalars is selected, then the user must specify a scalar
 
 array to clip according to. The clip filter will return
 
 the portions of the data set whose value in the selected
 
 Scalars array is larger than the Clip value. Regardless of
 
 the selection from the Clip Function menu, if the Inside
 
 Out option is checked, the opposite portions of the data
 
 set will be returned. This filter operates on all types of
 
 data sets, and it returns unstructured grid data on
 
 output.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 Set the input to the Generic Clip
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkGenericDataSet
 
 The dataset much contain a field array (point)
 
  
 
 
 '''Clip Type''' (ClipFunction)
 
 
 
 Set the parameters of the clip function.
 
 
 
  
 
 
 The value can be one of the following:
 
 * Plane (implicit_functions)
 
  
 * Box (implicit_functions)
 
  
 * Sphere (implicit_functions)
 
  
 * Scalar (implicit_functions)
 
  
 
 
 '''InputBounds''' (InputBounds)
 
 
 
  
 
 
  
 
 
  
 
 
 '''Scalars''' (SelectInputScalars)
 
 
 
 If clipping with scalars, this property specifies the
 
 name of the scalar array on which to perform the clip
 
 operation.
 
 
 
  
 
 
 An array of scalars is required.The value must be field array name.
 
 
 
 '''InsideOut''' (InsideOut)
 
 
 
 Choose which portion of the dataset should be clipped
 
 away.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''Value''' (Value)
 
 
 
 If clipping with a scalar array, choose the clipping
 
 value.
 
 
 
 0.0
 
 
 
 The value must lie within the range of the selected data array.
 
  
 }
 
  
 ==Compute Derivatives==
 
  
 This filter computes derivatives of scalars and vectors.
 
 CellDerivatives is a filter that computes derivatives of
 
 scalars and vectors at the center of cells. You can choose
 
 to generate different output including the scalar gradient
 
 (a vector), computed tensor vorticity (a vector), gradient
 
 of input vectors (a tensor), and strain matrix of the
 
 input vectors (a tensor); or you may choose to pass data
 
 through to the output.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 The dataset much contain a field array (point)
 
  
 with 1 component(s).
 
  
 The dataset much contain a field array (point)
 
  
 with 3 component(s).
 
  
 
 
 '''Scalars''' (SelectInputScalars)
 
 
 
 This property indicates the name of the scalar array to
 
 differentiate.
 
 
 
  
 
 
 An array of scalars is required.
 
 
 
 '''Vectors''' (SelectInputVectors)
 
 
 
 This property indicates the name of the vector array to
 
 differentiate.
 
 
 
 1
 
 
 
 An array of vectors is required.
 
 
 
 '''OutputVectorType''' (OutputVectorType)
 
 
 
 This property Controls how the filter works to generate
 
 vector cell data. You can choose to compute the gradient of the input
 
 scalars, or extract the vorticity of the computed vector gradient
 
 tensor. By default, the filter will take the gradient of the input
 
 scalar data.
 
 
 
 1
 
 
 
 The value(s) is an enumeration of the following:
 
 * Nothing (0)
 
 * Scalar Gradient (1)
 
 * Vorticity (2)
 
 
 
 '''OutputTensorType''' (OutputTensorType)
 
 
 
 This property controls how the filter works to generate
 
 tensor cell data. You can choose to compute the gradient of the input
 
 vectors, or compute the strain tensor of the vector gradient tensor. By
 
 default, the filter will take the gradient of the vector data to
 
 construct a tensor.
 
 
 
 1
 
 
 
 The value(s) is an enumeration of the following:
 
 * Nothing (0)
 
 * Vector Gradient (1)
 
 * Strain (2)
 
  
 }
 
  
 ==Connectivity==
 
  
 Mark connected components with integer point attribute array.The Connectivity
 
 filter assigns a region id to connected components of the
 
 input data set. (The region id is assigned as a point
 
 scalar value.) This filter takes any data set type as
 
 input and produces unstructured grid
 
 output.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Connectivity
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 
 
 '''ExtractionMode''' (ExtractionMode)
 
 
 
 Controls the extraction of connected
 
 surfaces.
 
 
 
 5
 
 
 
 The value(s) is an enumeration of the following:
 
 * Extract Point Seeded Regions (1)
 
 * Extract Cell Seeded Regions (2)
 
 * Extract Specified Regions (3)
 
 * Extract Largest Region (4)
 
 * Extract All Regions (5)
 
 * Extract Closes Point Region (6)
 
 
 
 '''ColorRegions''' (ColorRegions)
 
 
 
 Controls the coloring of the connected
 
 regions.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==Contingency Statistics==
 
  
 Compute a statistical model of a dataset and/or assess the dataset with a statistical model.
 
 This filter either computes a statistical model of a dataset or takes
 
 such a model as its second input. Then, the model (however it is
 
 obtained) may optionally be used to assess the input dataset. This filter
 
 computes contingency tables between pairs of attributes. This result is a
 
 tabular bivariate probability distribution which serves as a
 
 Bayesianstyle prior model. Data is assessed by computing <ul>
 
 <li> the probability of observing both variables simultaneously;
 
 <li> the probability of each variable conditioned on the other (the
 
 two values need not be identical); and <li> the pointwise mutual
 
 information (PMI). </ul> Finally, the summary statistics include
 
 the information entropy of the observations.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 The input to the filter. Arrays from this dataset will
 
 be used for computing statistics and/or assessed by a statistical
 
 model.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkImageData
 
 * vtkStructuredGrid
 
 * vtkPolyData
 
 * vtkUnstructuredGrid
 
 * vtkTable
 
 * vtkGraph
 
 The dataset much contain a field array ()
 
  
 
 
 '''ModelInput''' (ModelInput)
 
 
 
 A previouslycalculated model with which to assess a
 
 separate dataset. This input is optional.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkTable
 
 * vtkMultiBlockDataSet
 
 
 
 '''AttributeMode''' (AttributeMode)
 
 
 
 Specify which type of field data the arrays will be
 
 drawn from.
 
 
 
 0
 
 
 
 The value must be field array name.
 
 
 
 '''Variables of Interest''' (SelectArrays)
 
 
 
 Choose arrays whose entries will be used to form
 
 observations for statistical analysis.
 
 
 
  
 
 
  
 
 
 '''Task''' (Task)
 
 
 
 Specify the task to be performed: modeling and/or
 
 assessment. <ol> <li> "Detailed model of input data,"
 
 creates a set of output tables containing a calculated statistical
 
 model of the <b>entire</b> input dataset;</li>
 
 <li> "Model a subset of the data," creates an output table (or
 
 tables) summarizing a <b>randomlychosen subset</b> of the
 
 input dataset;</li> <li> "Assess the data with a model,"
 
 adds attributes to the first input dataset using a model provided on
 
 the second input port; and</li> <li> "Model and assess the
 
 same data," is really just operations 2 and 3 above applied to the same
 
 input dataset. The model is first trained using a fraction of the input
 
 data and then the entire dataset is assessed using that
 
 model.</li> </ol> When the task includes creating a model
 
 (i.e., tasks 2, and 4), you may adjust the fraction of the input
 
 dataset used for training. You should avoid using a large fraction of
 
 the input data for training as you will then not be able to detect
 
 overfitting. The <i>Training fraction</i> setting will be
 
 ignored for tasks 1 and 3.
 
 
 
 3
 
 
 
 The value(s) is an enumeration of the following:
 
 * Detailed model of input data (0)
 
 * Model a subset of the data (1)
 
 * Assess the data with a model (2)
 
 * Model and assess the same data (3)
 
 
 
 '''TrainingFraction''' (TrainingFraction)
 
 
 
 Specify the fraction of values from the input dataset to
 
 be used for model fitting. The exact set of values is chosen at random
 
 from the dataset.
 
 
 
 0.1
 
 
 
  
  
 }
 
  
 ==Contour==
 
  
 Generate isolines or isosurfaces using point scalars.The Contour
 
 filter computes isolines or isosurfaces using a selected
 
 pointcentered scalar array. The Contour filter operates
 
 on any type of data set, but the input is required to have
 
 at least one pointcentered scalar (singlecomponent)
 
 array. The output of this filter is
 
 polygonal.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input dataset to be used by
 
 the contour filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 The dataset much contain a field array (point)
 
  
 with 1 component(s).
 
  
 
 
 '''Contour By''' (SelectInputScalars)
 
 
 
 This property specifies the name of the scalar array
 
 from which the contour filter will compute isolines and/or
 
 isosurfaces.
 
 
 
  
 
 
 An array of scalars is required.The value must be field array name.
 
 
 
 '''ComputeNormals''' (ComputeNormals)
 
 
 
 If this property is set to 1, a scalar array containing
 
 a normal value at each point in the isosurface or isoline will be
 
 created by the contour filter; otherwise an array of normals will not
 
 be computed. This operation is fairly expensive both in terms of
 
 computation time and memory required, so if the output dataset produced
 
 by the contour filter will be processed by filters that modify the
 
 dataset's topology or geometry, it may be wise to set the value of this
 
 property to 0. Select whether to compute normals.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''ComputeGradients''' (ComputeGradients)
 
 
 
 If this property is set to 1, a scalar array containing
 
 a gradient value at each point in the isosurface or isoline will be
 
 created by this filter; otherwise an array of gradients will not be
 
 computed. This operation is fairly expensive both in terms of
 
 computation time and memory required, so if the output dataset produced
 
 by the contour filter will be processed by filters that modify the
 
 dataset's topology or geometry, it may be wise to set the value of this
 
 property to 0. Not that if ComputeNormals is set to 1, then gradients
 
 will have to be calculated, but they will only be stored in the output
 
 dataset if ComputeGradients is also set to 1.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''ComputeScalars''' (ComputeScalars)
 
 
 
 If this property is set to 1, an array of scalars
 
 (containing the contour value) will be added to the output dataset. If
 
 set to 0, the output will not contain this array.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''GenerateTriangles''' (GenerateTriangles)
 
 
 
 This parameter controls whether to produce triangles in the output.
 
 Warning: Many filters do not properly handle nontrianglular polygons.
 
  
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''Isosurfaces''' (ContourValues)
 
 
 
 This property specifies the values at which to compute
 
 isosurfaces/isolines and also the number of such
 
 values.
 
 
 
  
 
 
 The value must lie within the range of the selected data array.
 
 
 
 '''Point Merge Method''' (Locator)
 
 
 
 This property specifies an incremental point locator for
 
 merging duplicate / coincident points.
 
 
 
  
 
 
 The value can be one of the following:
 
 * MergePoints (incremental_point_locators)
 
  
 * IncrementalOctreeMergePoints (incremental_point_locators)
 
  
 * NonMergingPointLocator (incremental_point_locators)
 
  
  
 }
 
  
 ==Contour Generic Dataset==
 
  
 Generate isolines or isosurfaces using point scalars.The Generic
 
 Contour filter computes isolines or isosurfaces using a
 
 selected pointcentered scalar array. The available scalar
 
 arrays are listed in the Scalars menu. The scalar range of
 
 the selected array will be displayed. The interface for
 
 adding contour values is very similar to the one for
 
 selecting cut offsets (in the Cut filter). To add a single
 
 contour value, select the value from the New Value slider
 
 in the Add value portion of the interface and click the
 
 Add button, or press Enter. To instead add several evenly
 
 spaced contours, use the controls in the Generate range of
 
 values section. Select the number of contour values to
 
 generate using the Number of Values slider. The Range
 
 slider controls the interval in which to generate the
 
 contour values. Once the number of values and range have
 
 been selected, click the Generate button. The new values
 
 will be added to the Contour Values list. To delete a
 
 value from the Contour Values list, select the value and
 
 click the Delete button. (If no value is selected, the
 
 last value in the list will be removed.) Clicking the
 
 Delete All button removes all the values in the list. If
 
 no values are in the Contour Values list when Accept is
 
 pressed, the current value of the New Value slider will be
 
 used. In addition to selecting contour values, you can
 
 also select additional computations to perform. If any of
 
 Compute Normals, Compute Gradients, or Compute Scalars is
 
 selected, the appropriate computation will be performed,
 
 and a corresponding pointcentered array will be added to
 
 the output. The Generic Contour filter operates on a
 
 generic data set, but the input is required to have at
 
 least one pointcentered scalar (singlecomponent) array.
 
 The output of this filter is polygonal.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 Set the input to the Generic Contour
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkGenericDataSet
 
 The dataset much contain a field array (point)
 
  
 with 1 component(s).
 
  
 
 
 '''Contour By''' (SelectInputScalars)
 
 
 
 This property specifies the name of the scalar array
 
 from which the contour filter will compute isolines and/or
 
 isosurfaces.
 
 
 
  
 
 
 An array of scalars is required.The value must be field array name.
 
 
 
 '''ComputeNormals''' (ComputeNormals)
 
 
 
 Select whether to compute normals.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''ComputeGradients''' (ComputeGradients)
 
 
 
 Select whether to compute gradients.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''ComputeScalars''' (ComputeScalars)
 
 
 
 Select whether to compute scalars.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''Isosurfaces''' (ContourValues)
 
 
 
 This property specifies the values at which to compute
 
 isosurfaces/isolines and also the number of such
 
 values.
 
 
 
  
 
 
 The value must lie within the range of the selected data array.
 
 
 
 '''Point Merge Method''' (Locator)
 
 
 
 This property specifies an incremental point locator for
 
 merging duplicate / coincident points.
 
 
 
  
 
 
 The value can be one of the following:
 
 * MergePoints (incremental_point_locators)
 
  
 * IncrementalOctreeMergePoints (incremental_point_locators)
 
  
 * NonMergingPointLocator (incremental_point_locators)
 
  
  
 }
 
  
 ==Convert AMR dataset to Multiblock==
 
  
 Convert AMR to Multiblock
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input for this
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkOverlappingAMR
 
  
 }
 
  
 ==ConvertSelection==
 
  
 Converts a selection from one type to
 
 another.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''DataInput''' (DataInput)
 
 
 
 Set the vtkDataObject input used to convert the
 
 selection.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataObject
 
 
 
 '''Input''' (Input)
 
 
 
 Set the selection to convert.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkSelection
 
 
 
 '''OutputType''' (OutputType)
 
 
 
 Set the ContentType for the output.
 
 
 
 5
 
 
 
 The value(s) is an enumeration of the following:
 
 * SELECTIONS (0)
 
 * GLOBALIDs (1)
 
 * PEDIGREEIDS (2)
 
 * VALUES (3)
 
 * INDICES (4)
 
 * FRUSTUM (5)
 
 * LOCATION (6)
 
 * THRESHOLDS (7)
 
 
 
 '''ArrayNames''' (ArrayNames)
 
 
 
  
 
 
  
 
 
  
 
 
 '''MatchAnyValues''' (MatchAnyValues)
 
 
 
  
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==Crop==
 
  
 Efficiently extract an area/volume of interest from a 2d image or 3d volume.The Crop filter
 
 extracts an area/volume of interest from a 2D image or a
 
 3D volume by allowing the user to specify the minimum and
 
 maximum extents of each dimension of the data. Both the
 
 input and output of this filter are uniform rectilinear
 
 data.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Crop
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkImageData
 
 
 
 '''OutputWholeExtent''' (OutputWholeExtent)
 
 
 
 This property gives the minimum and maximum point index
 
 (extent) in each dimension for the output dataset.
 
 
 
 0 0 0 0 0 0
 
 
 
 The value(s) must lie within the structuredextents of the input dataset.
 
  
 }
 
  
 ==Curvature==
 
  
 This filter will compute the Gaussian or mean curvature of the mesh at each point.The
 
 Curvature filter computes the curvature at each point in a
 
 polygonal data set. This filter supports both Gaussian and
 
 mean curvatures. ; the type can be selected from the
 
 Curvature type menu button.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Curvature
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkPolyData
 
 
 
 '''InvertMeanCurvature''' (InvertMeanCurvature)
 
 
 
 If this property is set to 1, the mean curvature
 
 calculation will be inverted. This is useful for meshes with
 
 inwardpointing normals.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''CurvatureType''' (CurvatureType)
 
 
 
 This propery specifies which type of curvature to
 
 compute.
 
 
 
 0
 
 
 
 The value(s) is an enumeration of the following:
 
 * Gaussian (0)
 
 * Mean (1)
 
  
 }
 
  
 ==D3==
 
  
 Repartition a data set into loadbalanced spatially convex regions. Create ghost cells if requested.The D3 filter is
 
 available when ParaView is run in parallel. It operates on
 
 any type of data set to evenly divide it across the
 
 processors into spatially contiguous regions. The output
 
 of this filter is of type unstructured
 
 grid.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the D3
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 
 
 '''BoundaryMode''' (BoundaryMode)
 
 
 
 This property determines how cells that lie on processor
 
 boundaries are handled. The "Assign cells uniquely" option assigns each
 
 boundary cell to exactly one process, which is useful for isosurfacing.
 
 Selecting "Duplicate cells" causes the cells on the boundaries to be
 
 copied to each process that shares that boundary. The "Divide cells"
 
 option breaks cells across process boundary lines so that pieces of the
 
 cell lie in different processes. This option is useful for volume
 
 rendering.
 
 
 
 0
 
 
 
 The value(s) is an enumeration of the following:
 
 * Assign cells uniquely (0)
 
 * Duplicate cells (1)
 
 * Divide cells (2)
 
 
 
 '''Minimal Memory''' (UseMinimalMemory)
 
 
 
 If this property is set to 1, the D3 filter requires
 
 communication routines to use minimal memory than without this
 
 restriction.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==Decimate==
 
  
 Simplify a polygonal model using an adaptive edge collapse algorithm. This filter works with triangles only.
 
 The Decimate filter reduces the number of triangles in a
 
 polygonal data set. Because this filter only operates on
 
 triangles, first run the Triangulate filter on a dataset
 
 that contains polygons other than
 
 triangles.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Decimate
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkPolyData
 
 
 
 '''TargetReduction''' (TargetReduction)
 
 
 
 This property specifies the desired reduction in the
 
 total number of polygons in the output dataset. For example, if the
 
 TargetReduction value is 0.9, the Decimate filter will attempt to
 
 produce an output dataset that is 10% the size of the
 
 input.)
 
 
 
 0.9
 
 
 
  
 
 
 '''PreserveTopology''' (PreserveTopology)
 
 
 
 If this property is set to 1, decimation will not split
 
 the dataset or produce holes, but it may keep the filter from reaching
 
 the reduction target. If it is set to 0, better reduction can occur
 
 (reaching the reduction target), but holes in the model may be
 
 produced.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''FeatureAngle''' (FeatureAngle)
 
 
 
 The value of this property is used in determining where
 
 the data set may be split. If the angle between two adjacent triangles
 
 is greater than or equal to the FeatureAngle value, then their boundary
 
 is considered a feature edge where the dataset can be
 
 split.
 
 
 
 15.0
 
 
 
  
 
 
 '''BoundaryVertexDeletion''' (BoundaryVertexDeletion)
 
 
 
 If this property is set to 1, then vertices on the
 
 boundary of the dataset can be removed. Setting the value of this
 
 property to 0 preserves the boundary of the dataset, but it may cause
 
 the filter not to reach its reduction target.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==Delaunay 2D==
 
  
 Create 2D Delaunay triangulation of input points. It expects a vtkPointSet as input and produces vtkPolyData as output. The points are expected to be in a mostly planar distribution.
 
 Delaunay2D is a filter that constructs a 2D Delaunay
 
 triangulation from a list of input points. These points
 
 may be represented by any dataset of type vtkPointSet and
 
 subclasses. The output of the filter is a polygonal
 
 dataset containing a triangle mesh. The 2D Delaunay
 
 triangulation is defined as the triangulation that
 
 satisfies the Delaunay criterion for ndimensional
 
 simplexes (in this case n=2 and the simplexes are
 
 triangles). This criterion states that a circumsphere of
 
 each simplex in a triangulation contains only the n+1
 
 defining points of the simplex. In two dimensions, this
 
 translates into an optimal triangulation. That is, the
 
 maximum interior angle of any triangle is less than or
 
 equal to that of any possible triangulation. Delaunay
 
 triangulations are used to build topological structures
 
 from unorganized (or unstructured) points. The input to
 
 this filter is a list of points specified in 3D, even
 
 though the triangulation is 2D. Thus the triangulation is
 
 constructed in the xy plane, and the z coordinate is
 
 ignored (although carried through to the output). You can
 
 use the option ProjectionPlaneMode in order to compute the
 
 bestfitting plane to the set of points, project the
 
 points and that plane and then perform the triangulation
 
 using their projected positions and then use it as the
 
 plane in which the triangulation is performed. The
 
 Delaunay triangulation can be numerically sensitive in
 
 some cases. To prevent problems, try to avoid injecting
 
 points that will result in triangles with bad aspect
 
 ratios (1000:1 or greater). In practice this means
 
 inserting points that are "widely dispersed", and enables
 
 smooth transition of triangle sizes throughout the mesh.
 
 (You may even want to add extra points to create a better
 
 point distribution.) If numerical problems are present,
 
 you will see a warning message to this effect at the end
 
 of the triangulation process. Warning: Points arranged on
 
 a regular lattice (termed degenerate cases) can be
 
 triangulated in more than one way (at least according to
 
 the Delaunay criterion). The choice of triangulation (as
 
 implemented by this algorithm) depends on the order of the
 
 input points. The first three points will form a triangle;
 
 other degenerate points will not break this triangle.
 
 Points that are coincident (or nearly so) may be discarded
 
 by the algorithm. This is because the Delaunay
 
 triangulation requires unique input points. The output of
 
 the Delaunay triangulation is supposedly a convex hull. In
 
 certain cases this implementation may not generate the
 
 convex hull.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input dataset to the
 
 Delaunay 2D filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkPointSet
 
 
 
 '''ProjectionPlaneMode''' (ProjectionPlaneMode)
 
 
 
 This property determines type of projection plane to use
 
 in performing the triangulation.
 
 
 
 0
 
 
 
 The value(s) is an enumeration of the following:
 
 * XY Plane (0)
 
 * BestFitting Plane (2)
 
 
 
 '''Alpha''' (Alpha)
 
 
 
 The value of this property controls the output of this
 
 filter. For a nonzero alpha value, only edges or triangles contained
 
 within a sphere centered at mesh vertices will be output. Otherwise,
 
 only triangles will be output.
 
 
 
 0.0
 
 
 
  
 
 
 '''Tolerance''' (Tolerance)
 
 
 
 This property specifies a tolerance to control
 
 discarding of closely spaced points. This tolerance is specified as a
 
 fraction of the diagonal length of the bounding box of the
 
 points.
 
 
 
 0.00001
 
 
 
  
 
 
 '''Offset''' (Offset)
 
 
 
 This property is a multiplier to control the size of the
 
 initial, bounding Delaunay triangulation.
 
 
 
 1.0
 
 
 
  
 
 
 '''BoundingTriangulation''' (BoundingTriangulation)
 
 
 
 If this property is set to 1, bounding triangulation
 
 points (and associated triangles) are included in the output. These are
 
 introduced as an initial triangulation to begin the triangulation
 
 process. This feature is nice for debugging output.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==Delaunay 3D==
 
  
 Create a 3D Delaunay triangulation of input points. It expects a vtkPointSet as input and produces vtkUnstructuredGrid as output.Delaunay3D is a filter that constructs
 
 a 3D Delaunay triangulation from a list of input points. These points may be
 
 represented by any dataset of type vtkPointSet and subclasses. The output of
 
 the filter is an unstructured grid dataset. Usually the output is a tetrahedral
 
 mesh, but if a nonzero alpha distance value is specified (called the "alpha"
 
 value), then only tetrahedra, triangles, edges, and vertices lying within the
 
 alpha radius are output. In other words, nonzero alpha values may result in
 
 arbitrary combinations of tetrahedra, triangles, lines, and vertices. (The
 
 notion of alpha value is derived from Edelsbrunner's work on "alpha shapes".)
 
 The 3D Delaunay triangulation is defined as the triangulation that satisfies
 
 the Delaunay criterion for ndimensional simplexes (in this case n=3 and the
 
 simplexes are tetrahedra). This criterion states that a circumsphere of each
 
 simplex in a triangulation contains only the n+1 defining points of the
 
 simplex. (See text for more information.) While in two dimensions this
 
 translates into an "optimal" triangulation, this is not true in 3D, since a
 
 measurement for optimality in 3D is not agreed on. Delaunay triangulations are
 
 used to build topological structures from unorganized (or unstructured) points.
 
 The input to this filter is a list of points specified in 3D. (If you wish to
 
 create 2D triangulations see Delaunay2D.) The output is an unstructured grid.
 
 The Delaunay triangulation can be numerically sensitive. To prevent problems,
 
 try to avoid injecting points that will result in triangles with bad aspect
 
 ratios (1000:1 or greater). In practice this means inserting points that are
 
 "widely dispersed", and enables smooth transition of triangle sizes throughout
 
 the mesh. (You may even want to add extra points to create a better point
 
 distribution.) If numerical problems are present, you will see a warning
 
 message to this effect at the end of the triangulation process. Warning: Points
 
 arranged on a regular lattice (termed degenerate cases) can be triangulated in
 
 more than one way (at least according to the Delaunay criterion). The choice of
 
 triangulation (as implemented by this algorithm) depends on the order of the
 
 input points. The first four points will form a tetrahedron; other degenerate
 
 points (relative to this initial tetrahedron) will not break it. Points that
 
 are coincident (or nearly so) may be discarded by the algorithm. This is
 
 because the Delaunay triangulation requires unique input points. You can
 
 control the definition of coincidence with the "Tolerance" instance variable.
 
 The output of the Delaunay triangulation is supposedly a convex hull. In
 
 certain cases this implementation may not generate the convex hull. This
 
 behavior can be controlled by the Offset instance variable. Offset is a
 
 multiplier used to control the size of the initial triangulation. The larger
 
 the offset value, the more likely you will generate a convex hull; and the more
 
 likely you are to see numerical problems. The implementation of this algorithm
 
 varies from the 2D Delaunay algorithm (i.e., Delaunay2D) in an important way.
 
 When points are injected into the triangulation, the search for the enclosing
 
 tetrahedron is quite different. In the 3D case, the closest previously inserted
 
 point point is found, and then the connected tetrahedra are searched to find
 
 the containing one. (In 2D, a "walk" towards the enclosing triangle is
 
 performed.) If the triangulation is Delaunay, then an enclosing tetrahedron
 
 will be found. However, in degenerate cases an enclosing tetrahedron may not be
 
 found and the point will be rejected.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input dataset to the
 
 Delaunay 3D filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkPointSet
 
 
 
 '''Alpha''' (Alpha)
 
 
 
 This property specifies the alpha (or distance) value to
 
 control the output of this filter. For a nonzero alpha value, only
 
 edges, faces, or tetra contained within the circumsphere (of radius
 
 alpha) will be output. Otherwise, only tetrahedra will be
 
 output.
 
 
 
 0.0
 
 
 
  
 
 
 '''Tolerance''' (Tolerance)
 
 
 
 This property specifies a tolerance to control
 
 discarding of closely spaced points. This tolerance is specified as a
 
 fraction of the diagonal length of the bounding box of the
 
 points.
 
 
 
 0.001
 
 
 
  
 
 
 '''Offset''' (Offset)
 
 
 
 This property specifies a multiplier to control the size
 
 of the initial, bounding Delaunay triangulation.
 
 
 
 2.5
 
 
 
  
 
 
 '''BoundingTriangulation''' (BoundingTriangulation)
 
 
 
 This boolean controls whether bounding triangulation
 
 points (and associated triangles) are included in the output. (These
 
 are introduced as an initial triangulation to begin the triangulation
 
 process. This feature is nice for debugging output.)
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==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.<p>
 
 This filter computes the min, max, mean, raw moments M2 through M4,
 
 standard deviation, skewness, and kurtosis for each array you
 
 select.<p> The model is simply a univariate Gaussian distribution
 
 with the mean and standard deviation provided. Data is assessed using
 
 this model by detrending the data (i.e., subtracting the mean) and then
 
 dividing by the standard deviation. Thus the assessment is an array whose
 
 entries are the number of standard deviations from the mean that each
 
 input point lies.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 The input to the filter. Arrays from this dataset will
 
 be used for computing statistics and/or assessed by a statistical
 
 model.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkImageData
 
 * vtkStructuredGrid
 
 * vtkPolyData
 
 * vtkUnstructuredGrid
 
 * vtkTable
 
 * vtkGraph
 
 The dataset much contain a field array ()
 
  
 
 
 '''ModelInput''' (ModelInput)
 
 
 
 A previouslycalculated model with which to assess a
 
 separate dataset. This input is optional.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkTable
 
 * vtkMultiBlockDataSet
 
 
 
 '''AttributeMode''' (AttributeMode)
 
 
 
 Specify which type of field data the arrays will be
 
 drawn from.
 
 
 
 0
 
 
 
 The value must be field array name.
 
 
 
 '''Variables of Interest''' (SelectArrays)
 
 
 
 Choose arrays whose entries will be used to form
 
 observations for statistical analysis.
 
 
 
  
 
 
  
 
 
 '''Task''' (Task)
 
 
 
 Specify the task to be performed: modeling and/or
 
 assessment. <ol> <li> "Detailed model of input data,"
 
 creates a set of output tables containing a calculated statistical
 
 model of the <b>entire</b> input dataset;</li>
 
 <li> "Model a subset of the data," creates an output table (or
 
 tables) summarizing a <b>randomlychosen subset</b> of the
 
 input dataset;</li> <li> "Assess the data with a model,"
 
 adds attributes to the first input dataset using a model provided on
 
 the second input port; and</li> <li> "Model and assess the
 
 same data," is really just operations 2 and 3 above applied to the same
 
 input dataset. The model is first trained using a fraction of the input
 
 data and then the entire dataset is assessed using that
 
 model.</li> </ol> When the task includes creating a model
 
 (i.e., tasks 2, and 4), you may adjust the fraction of the input
 
 dataset used for training. You should avoid using a large fraction of
 
 the input data for training as you will then not be able to detect
 
 overfitting. The <i>Training fraction</i> setting will be
 
 ignored for tasks 1 and 3.
 
 
 
 3
 
 
 
 The value(s) is an enumeration of the following:
 
 * Detailed model of input data (0)
 
 * Model a subset of the data (1)
 
 * Assess the data with a model (2)
 
 * Model and assess the same data (3)
 
 
 
 '''TrainingFraction''' (TrainingFraction)
 
 
 
 Specify the fraction of values from the input dataset to
 
 be used for model fitting. The exact set of values is chosen at random
 
 from the dataset.
 
 
 
 0.1
 
 
 
  
 
 
 '''Deviations should be''' (SignedDeviations)
 
 
 
 Should the assessed values be signed deviations or
 
 unsigned?
 
 
 
 0
 
 
 
 The value(s) is an enumeration of the following:
 
 * Unsigned (0)
 
 * Signed (1)
 
  
 }
 
  
 ==Elevation==
 
  
 Create point attribute array by projecting points onto an elevation vector.
 
 The Elevation filter generates point scalar values for an
 
 input dataset along a specified direction vector. The
 
 Input menu allows the user to select the data set to which
 
 this filter will be applied. Use the Scalar range entry
 
 boxes to specify the minimum and maximum scalar value to
 
 be generated. The Low Point and High Point define a line
 
 onto which each point of the data set is projected. The
 
 minimum scalar value is associated with the Low Point, and
 
 the maximum scalar value is associated with the High
 
 Point. The scalar value for each point in the data set is
 
 determined by the location along the line to which that
 
 point projects.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input dataset to the
 
 Elevation filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 
 
 '''ScalarRange''' (ScalarRange)
 
 
 
 This property determines the range into which scalars
 
 will be mapped.
 
 
 
 0 1
 
 
 
  
 
 
 '''Low Point''' (LowPoint)
 
 
 
 This property defines one end of the direction vector
 
 (small scalar values).
 
 
 
 0 0 0
 
 
 
  
 The value must lie within the bounding box of the dataset.
 
  
 It will default to the min in each dimension.
 
  
 
 
 '''High Point''' (HighPoint)
 
 
 
 This property defines the other end of the direction
 
 vector (large scalar values).
 
 
 
 0 0 1
 
 
 
  
 The value must lie within the bounding box of the dataset.
 
  
 It will default to the max in each dimension.
 
  
  
 }
 
  
 ==Extract AMR Blocks==
 
  
 This filter extracts a list of datasets from hierarchical datasets.This filter extracts a list
 
 of datasets from hierarchical datasets.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Extract
 
 Datasets filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkUniformGridAMR
 
 
 
 '''SelectedDataSets''' (SelectedDataSets)
 
 
 
 This property provides a list of datasets to
 
 extract.
 
 
 
  
 
 
  
  
 }
 
  
 ==Extract Attributes==
 
  
 Extract attribute data as a table.This is a
 
 filter that produces a vtkTable from the chosen attribute
 
 in the input dataobject. This filter can accept composite
 
 datasets. If the input is a composite dataset, the output
 
 is a multiblock with vtkTable leaves.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input of the
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataObject
 
 
 
 '''FieldAssociation''' (FieldAssociation)
 
 
 
 Select the attribute data to pass.
 
 
 
 0
 
 
 
 The value(s) is an enumeration of the following:
 
 * Points (0)
 
 * Cells (1)
 
 * Field Data (2)
 
 * Vertices (4)
 
 * Edges (5)
 
 * Rows (6)
 
 
 
 '''AddMetaData''' (AddMetaData)
 
 
 
 It is possible for this filter to add additional
 
 metadata to the field data such as point coordinates (when point
 
 attributes are selected and input is pointset) or structured
 
 coordinates etc. To enable this addition of extra information, turn
 
 this flag on. Off by default.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==Extract Block==
 
  
 This filter extracts a range of blocks from a multiblock dataset.This filter extracts a range
 
 of groups from a multiblock dataset
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Extract Group
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkMultiBlockDataSet
 
 
 
 '''BlockIndices''' (BlockIndices)
 
 
 
 This property lists the ids of the blocks to extract
 
 from the input multiblock dataset.
 
 
 
  
 
 
  
 
 
 '''PruneOutput''' (PruneOutput)
 
 
 
 When set, the output mutliblock dataset will be pruned
 
 to remove empty nodes. On by default.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''MaintainStructure''' (MaintainStructure)
 
 
 
 This is used only when PruneOutput is ON. By default,
 
 when pruning the output i.e. remove empty blocks, if node has only 1
 
 nonnull child block, then that node is removed. To preserve these
 
 parent nodes, set this flag to true.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==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
 
 cellcentered arrays to pointcentered ones. It then
 
 contours each array at a value of 0.5. The user has the
 
 option of clipping the resulting surface(s) with a plane.
 
 This filter only operates on unstructured data. It
 
 produces polygonal output.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Extract CTH
 
 Parts filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 The dataset much contain a field array (cell)
 
  
 with 1 component(s).
 
  
 
 
 '''Clip Type''' (ClipPlane)
 
 
 
 This property specifies whether to clip the dataset, and
 
 if so, it also specifies the parameters of the plane with which to
 
 clip.
 
 
 
  
 
 
 The value can be one of the following:
 
 * None (implicit_functions)
 
  
 * Plane (implicit_functions)
 
  
 * Box (implicit_functions)
 
  
 * Sphere (implicit_functions)
 
  
 
 
 '''Double Volume Arrays''' (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''' (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''' (AddUnsignedCharVolumeArrayName)
 
 
 
 This property specifies the name(s) of the volume
 
 fraction array(s) for generating parts.
 
 
 
  
 
 
 An array of scalars is required.
 
 
 
 '''Volume Fraction Value''' (VolumeFractionSurfaceValue)
 
 
 
 The value of this property is the volume fraction value
 
 for the surface.
 
 
 
 0.1
 
 
 
  
  
 }
 
  
 ==Extract Cells By Region==
 
  
 This filter extracts cells that are inside/outside a region or at a region boundary.
 
 This filter extracts from its input dataset all cells that are either
 
 completely inside or outside of a specified region (implicit function).
 
 On output, the filter generates an unstructured grid. To use this filter
 
 you must specify a region (implicit function). You must also specify
 
 whethter to extract cells lying inside or outside of the region. An
 
 option exists to extract cells that are neither inside or outside (i.e.,
 
 boundary).
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Slice
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 
 
 '''Intersect With''' (ImplicitFunction)
 
 
 
 This property sets the region used to extract
 
 cells.
 
 
 
  
 
 
 The value can be one of the following:
 
 * Plane (implicit_functions)
 
  
 * Box (implicit_functions)
 
  
 * Sphere (implicit_functions)
 
  
 
 
 '''InputBounds''' (InputBounds)
 
 
 
  
 
 
  
 
 
  
 
 
 '''Extraction Side''' (ExtractInside)
 
 
 
 This parameter controls whether to extract cells that
 
 are inside or outside the region.
 
 
 
 1
 
 
 
 The value(s) is an enumeration of the following:
 
 * outside (0)
 
 * inside (1)
 
 
 
 '''Extract only intersected''' (Extract only intersected)
 
 
 
 This parameter controls whether to extract only cells
 
 that are on the boundary of the region. If this parameter is set, the
 
 Extraction Side parameter is ignored. If Extract Intersected is off,
 
 this parameter has no effect.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''Extract intersected''' (Extract intersected)
 
 
 
 This parameter controls whether to extract cells that
 
 are on the boundary of the region.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==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.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Extract Edges
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
  
 }
 
  
 ==Extract Generic Dataset Surface==
 
  
 Extract geometry from a higherorder dataset
 
 Extract geometry from a higherorder
 
 dataset.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 Set the input to the Generic Geometry
 
 Filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkGenericDataSet
 
 
 
 '''PassThroughCellIds''' (PassThroughCellIds)
 
 
 
 Select whether to forward original ids.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==Extract Level==
 
  
 This filter extracts a range of groups from a hierarchical dataset.This filter extracts a range
 
 of levels from a hierarchical dataset
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Extract Group
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkUniformGridAMR
 
 
 
 '''Levels''' (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.
 
 The selection can be obtained from a rubberband selection
 
 (either cell, visible or in a frustum) or threshold
 
 selection and passed to the filter or specified by
 
 providing an ID list.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input from which the
 
 selection is extracted.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 * vtkTable
 
 
 
 '''Selection''' (Selection)
 
 
 
 The input that provides the selection
 
 object.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkSelection
 
 
 
 '''PreserveTopology''' (PreserveTopology)
 
 
 
 If this property is set to 1 the output preserves the
 
 topology of its input and adds an insidedness array to mark which cells
 
 are inside or out. If 0 then the output is an unstructured grid which
 
 contains only the subset of cells that are inside.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''ShowBounds''' (ShowBounds)
 
 
 
 For frustum selection, if this property is set to 1 the
 
 output is the outline of the frustum instead of the contents of the
 
 input that lie within the frustum.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==Extract Selection (internal)==
 
  
 This filter extracts a given set of cells or points given
 
 a selection. The selection can be obtained from a rubberband selection
 
 (either point, cell, visible or in a frustum) and passed to the filter or
 
 specified by providing an ID list. This is an internal filter, use
 
 "ExtractSelection" instead.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 The input from which the selection is
 
 extracted.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 
 
 '''Selection''' (Selection)
 
 
 
 The input that provides the selection
 
 object.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkSelection
 
  
 }
 
  
 ==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.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Extract Grid
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkImageData
 
 * vtkRectilinearGrid
 
 * vtkStructuredPoints
 
 * vtkStructuredGrid
 
 
 
 '''VOI''' (VOI)
 
 
 
 This property specifies the minimum and maximum point
 
 indices along each of the I, J, and K axes; these values indicate the
 
 volume of interest (VOI). The output will have the (I,J,K) extent
 
 specified here.
 
 
 
 0 0 0 0 0 0
 
 
 
 The value(s) must lie within the structuredextents of the input dataset.
 
 
 
 '''SampleRateI''' (SampleRateI)
 
 
 
 This property indicates the sampling rate in the I
 
 dimension. A value grater than 1 results in subsampling; every nth
 
 index will be included in the output.
 
 
 
 1
 
 
 
  
 
 
 '''SampleRateJ''' (SampleRateJ)
 
 
 
 This property indicates the sampling rate in the J
 
 dimension. A value grater than 1 results in subsampling; every nth
 
 index will be included in the output.
 
 
 
 1
 
 
 
  
 
 
 '''SampleRateK''' (SampleRateK)
 
 
 
 This property indicates the sampling rate in the K
 
 dimension. A value grater than 1 results in subsampling; every nth
 
 index will be included in the output.
 
 
 
 1
 
 
 
  
 
 
 '''IncludeBoundary''' (IncludeBoundary)
 
 
 
 If the value of this property is 1, then if the sample
 
 rate in any dimension is greater than 1, the boundary indices of the
 
 input dataset will be passed to the output even if the boundary extent
 
 is not an even multiple of the sample rate in a given
 
 dimension.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==Extract Surface==
 
  
 Extract 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.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Extract Surface
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 
 
 '''PieceInvariant''' (PieceInvariant)
 
 
 
 If the value of this property is set to 1, internal
 
 surfaces along process boundaries will be removed. NOTE: Enabling this
 
 option might cause multiple executions of the data source because more
 
 information is needed to remove internal surfaces.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''NonlinearSubdivisionLevel''' (NonlinearSubdivisionLevel)
 
 
 
 If the input is an unstructured grid with nonlinear
 
 faces, this parameter determines how many times the face is subdivided
 
 into linear faces. If 0, the output is the equivalent of its linear
 
 couterpart (and the midpoints determining the nonlinear interpolation
 
 are discarded). If 1, the nonlinear face is triangulated based on the
 
 midpoints. If greater than 1, the triangulated pieces are recursively
 
 subdivided to reach the desired subdivision. Setting the value to
 
 greater than 1 may cause some point data to not be passed even if no
 
 quadratic faces exist. This option has no effect if the input is not an
 
 unstructured grid.
 
 
 
 1
 
 
 
  
  
 }
 
  
 ==FOF/SOD Halo Finder==
 
  
  
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input of the
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkUnstructuredGrid
 
 
 
 '''rL (physical box side length)''' (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
 
 
 
  
 
 
 '''overlap (shared point/ghost cell gap distance)''' (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
 
 
 
  
 
 
 '''np (number of seeded particles in one dimension, i.e., total particles = np^3)''' (NP)
 
 
 
 Number of seeded particles in one dimension. Therefore,
 
 total simulation particles is np^3 (cubed).
 
 
 
 256
 
 
 
  
 
 
 '''bb (linking length)''' (BB)
 
 
 
 Linking length measured in units of interparticle
 
 spacing and is dimensionless. Used to link particles into halos for the
 
 friendsoffriends (FOF) algorithm.
 
 
 
 0.20
 
 
 
  
 
 
 '''pmin (minimum particle threshold for an FOF halo)''' (PMin)
 
 
 
 Minimum number of particles (threshold) needed before a
 
 group is called a friendsoffriends (FOF) halo.
 
 
 
 100
 
 
 
  
 
 
 '''Copy FOF halo catalog to original particles''' (CopyHaloDataToParticles)
 
 
 
 If checked, the friendsoffriends (FOF) halo catalog
 
 information will be copied to the original particles as
 
 well.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''Compute the most bound particle''' (ComputeMostBoundParticle)
 
 
 
 If checked, the most bound particle for an FOF halo will
 
 be calculated. WARNING: This can be very slow.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''Compute the most connected particle''' (ComputeMostConnectedParticle)
 
 
 
 If checked, the most connected particle for an FOF halo
 
 will be calculated. WARNING: This can be very slow.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''Compute spherical overdensity (SOD) halos''' (ComputeSOD)
 
 
 
 If checked, spherical overdensity (SOD) halos will be
 
 calculated in addition to friendsoffriends (FOF)
 
 halos.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''initial SOD center''' (SODCenterType)
 
 
 
 The initial friendsoffriends (FOF) center used for
 
 calculating a spherical overdensity (SOD) halo. WARNING: Using MBP or
 
 MCP can be very slow.
 
 
 
 0
 
 
 
 The value(s) is an enumeration of the following:
 
 * Center of mass (0)
 
 * Average position (1)
 
 * Most bound particle (2)
 
 * Most connected particle (3)
 
 
 
 '''rho_c''' (RhoC)
 
 
 
 rho_c (critical density) for SOD halo
 
 finding.
 
 
 
 2.77536627e11
 
 
 
  
 
 
 '''initial SOD mass''' (SODMass)
 
 
 
 The initial SOD mass.
 
 
 
 1.0e14
 
 
 
  
 
 
 '''minimum radius factor''' (MinRadiusFactor)
 
 
 
 Minimum radius factor for SOD finding.
 
 
 
 0.5
 
 
 
  
 
 
 '''maximum radius factor''' (MaxRadiusFactor)
 
 
 
 Maximum radius factor for SOD finding.
 
 
 
 2.0
 
 
 
  
 
 
 '''number of bins''' (SODBins)
 
 
 
 Number of bins for SOD finding.
 
 
 
 20
 
 
 
  
 
 
 '''minimum FOF size''' (MinFOFSize)
 
 
 
 Minimum FOF halo size to calculate an SOD
 
 halo.
 
 
 
 1000
 
 
 
  
 
 
 '''minimum FOF mass''' (MinFOFMass)
 
 
 
 Minimum FOF mass to calculate an SOD
 
 halo.
 
 
 
 5.0e12
 
 
 
  
  
 }
 
  
 ==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.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Feature Edges
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkPolyData
 
 
 
 '''BoundaryEdges''' (BoundaryEdges)
 
 
 
 If the value of this property is set to 1, boundary
 
 edges will be extracted. Boundary edges are defined as lines cells or
 
 edges that are used by only one polygon.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''FeatureEdges''' (FeatureEdges)
 
 
 
 If the value of this property is set to 1, feature edges
 
 will be extracted. Feature edges are defined as edges that are used by
 
 two polygons whose dihedral angle is greater than the feature angle.
 
 (See the FeatureAngle property.) Toggle whether to extract feature
 
 edges.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''NonManifold Edges''' (NonManifoldEdges)
 
 
 
 If the value of this property is set to 1, nonmanifold
 
 ediges will be extracted. Nonmanifold edges are defined as edges that
 
 are use by three or more polygons.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''ManifoldEdges''' (ManifoldEdges)
 
 
 
 If the value of this property is set to 1, manifold
 
 edges will be extracted. Manifold edges are defined as edges that are
 
 used by exactly two polygons.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''Coloring''' (Coloring)
 
 
 
 If the value of this property is set to 1, then the
 
 extracted edges are assigned a scalar value based on the type of the
 
 edge.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''FeatureAngle''' (FeatureAngle)
 
 
 
 Ths value of this property is used to define a feature
 
 edge. If the surface normal between two adjacent triangles is at least
 
 as large as this Feature Angle, a feature edge exists. (See the
 
 FeatureEdges property.)
 
 
 
 30.0
 
 
 
  
  
 }
 
  
 ==FlattenFilter==
 
  
  
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 Set the input to the Flatten Filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkPointSet
 
 * vtkGraph
 
 * vtkCompositeDataSet
 
  
 }
 
  
 ==Gaussian Resampling==
 
  
 Splat points into a volume with an elliptical, Gaussian distribution.vtkGaussianSplatter
 
 is a filter that injects input points into a structured
 
 points (volume) dataset. As each point is injected, it
 
 "splats" or distributes values to nearby voxels. Data is
 
 distributed using an elliptical, Gaussian distribution
 
 function. The distribution function is modified using
 
 scalar values (expands distribution) or normals (creates
 
 ellipsoidal distribution rather than spherical). Warning:
 
 results may be incorrect in parallel as points can't splat
 
 into other processor's cells.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 The dataset much contain a field array (point)
 
  
 with 1 component(s).
 
  
 
 
 '''Resample Field''' (SelectInputScalars)
 
 
 
 Choose a scalar array to splat into the output cells. If
 
 ignore arrays is chosen, point density will be counted
 
 instead.
 
 
 
  
 
 
 An array of scalars is required.The value must be field array name.
 
 
 
 '''Resampling Grid''' (SampleDimensions)
 
 
 
 Set / get the dimensions of the sampling structured
 
 point set. Higher values produce better results but are much
 
 slower.
 
 
 
 50 50 50
 
 
 
  
 
 
 '''Extent to Resample''' (ModelBounds)
 
 
 
 Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding
 
 box in which the sampling is performed. If any of the (min,max) bounds
 
 values are min >= max, then the bounds will be computed
 
 automatically from the input data. Otherwise, the userspecified bounds
 
 will be used.
 
 
 
 0.0 0.0 0.0 0.0 0.0 0.0
 
 
 
  
 
 
 '''Gaussian Splat Radius''' (Radius)
 
 
 
 Set / get the radius of propagation of the splat. This
 
 value is expressed as a percentage of the length of the longest side of
 
 the sampling volume. Smaller numbers greatly reduce execution
 
 time.
 
 
 
 0.1
 
 
 
  
 
 
 '''Gaussian Exponent Factor''' (ExponentFactor)
 
 
 
 Set / get the sharpness of decay of the splats. This is
 
 the exponent constant in the Gaussian equation. Normally this is a
 
 negative value.
 
 
 
 5.0
 
 
 
  
 
 
 '''Scale Splats''' (ScalarWarping)
 
 
 
 Turn on/off the scaling of splats by scalar
 
 value.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''Scale Factor''' (ScaleFactor)
 
 
 
 Multiply Gaussian splat distribution by this value. If
 
 ScalarWarping is on, then the Scalar value will be multiplied by the
 
 ScaleFactor times the Gaussian function.
 
 
 
 1.0
 
 
 
  
 
 
 '''Elliptical Splats''' (NormalWarping)
 
 
 
 Turn on/off the generation of elliptical splats. If
 
 normal warping is on, then the input normals affect the distribution of
 
 the splat. This boolean is used in combination with the Eccentricity
 
 ivar.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''Ellipitical Eccentricity''' (Eccentricity)
 
 
 
 Control the shape of elliptical splatting. Eccentricity
 
 is the ratio of the major axis (aligned along normal) to the minor
 
 (axes) aligned along other two axes. So Eccentricity gt 1 creates
 
 needles with the long axis in the direction of the normal; Eccentricity
 
 lt 1 creates pancakes perpendicular to the normal
 
 vector.
 
 
 
 2.5
 
 
 
  
 
 
 '''Fill Volume Boundary''' (Capping)
 
 
 
 Turn on/off the capping of the outer boundary of the
 
 volume to a specified cap value. This can be used to close surfaces
 
 (after isosurfacing) and create other effects.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''Fill Value''' (CapValue)
 
 
 
 Specify the cap value to use. (This instance variable
 
 only has effect if the ivar Capping is on.)
 
 
 
 0.0
 
 
 
  
 
 
 '''Splat Accumulation Mode''' (Accumulation Mode)
 
 
 
 Specify the scalar accumulation mode. This mode
 
 expresses how scalar values are combined when splats are overlapped.
 
 The Max mode acts like a set union operation and is the most commonly
 
 used; the Min mode acts like a set intersection, and the sum is just
 
 weird.
 
 
 
 1
 
 
 
 The value(s) is an enumeration of the following:
 
 * Min (0)
 
 * Max (1)
 
 * Sum (2)
 
 
 
 '''Empty Cell Value''' (NullValue)
 
 
 
 Set the Null value for output points not receiving a
 
 contribution from the input points. (This is the initial value of the
 
 voxel samples.)
 
 
 
 0.0
 
 
 
  
  
 }
 
  
 ==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.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Cell Data to
 
 Point Data filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 
 
 '''ArrayName''' (ArrayName)
 
 
 
 The name of the array that will contain
 
 ids.
 
 
 
 Ids
 
 
 
  
  
 }
 
  
 ==Generate Quadrature Points==
 
  
 Create a point set with data at quadrature points.
 
 "Create a point set with data at quadrature
 
 points."
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input of the filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkUnstructuredGrid
 
 The dataset much contain a field array (cell)
 
  
 
 
 '''Quadrature Scheme Def''' (QuadratureSchemeDefinition)
 
 
 
 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.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input of the
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * 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.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Normals
 
 Generation filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkPolyData
 
 
 
 '''FeatureAngle''' (FeatureAngle)
 
 
 
 The value of this property defines a feature edge. If
 
 the surface normal between two adjacent triangles is at least as large
 
 as this Feature Angle, a feature edge exists. If Splitting is on,
 
 points are duplicated along these feature edges. (See the Splitting
 
 property.)
 
 
 
 30
 
 
 
  
 
 
 '''Splitting''' (Splitting)
 
 
 
 This property controls the splitting of sharp edges. If
 
 sharp edges are split (property value = 1), then points are duplicated
 
 along these edges, and separate normals are computed for both sets of
 
 points to give crisp (rendered) surface definition.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''Consistency''' (Consistency)
 
 
 
 The value of this property controls whether consistent
 
 polygon ordering is enforced. Generally the normals for a data set
 
 should either all point inward or all point outward. If the value of
 
 this property is 1, then this filter will reorder the points of cells
 
 that whose normal vectors are oriented the opposite direction from the
 
 rest of those in the data set.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''FlipNormals''' (FlipNormals)
 
 
 
 If the value of this property is 1, this filter will
 
 reverse the normal direction (and reorder the points accordingly) for
 
 all polygons in the data set; this changes frontfacing polygons to
 
 backfacing 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
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''NonManifold Traversal''' (NonManifoldTraversal)
 
 
 
 Turn on/off traversal across nonmanifold edges. Not
 
 traversing nonmanifold edges will prevent problems where the
 
 consistency of polygonal ordering is corrupted due to topological
 
 loops.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''ComputeCellNormals''' (ComputeCellNormals)
 
 
 
 This filter computes the normals at the points in the
 
 data set. In the process of doing this it computes polygon normals too.
 
 If you want these normals to be passed to the output of this filter,
 
 set the value of this property to 1.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''PieceInvariant''' (PieceInvariant)
 
 
 
 Turn this option to to produce the same results
 
 regardless of the number of processors used (i.e., avoid seams along
 
 processor boundaries). Turn this off if you do want to process ghost
 
 levels and do not mind seams.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==GeometryFilter==
 
  
  
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 Set the input to the Geoemtry Filter.
 
 
 
  
 
 
  
 
 
 '''UseStrips''' (UseStrips)
 
 
 
 Toggle whether to generate faces containing triangle
 
 strips. This should render faster and use less memory, but no cell data
 
 is copied.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''ForceStrips''' (ForceStrips)
 
 
 
 This makes UseStrips call Modified() after changing its
 
 setting to ensure that the filter's output is immediatley
 
 changed.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''UseOutline''' (UseOutline)
 
 
 
 Toggle whether to generate an outline or a
 
 surface.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''NonlinearSubdivisionLevel''' (NonlinearSubdivisionLevel)
 
 
 
 Nonlinear faces are approximated with flat polygons.
 
 This parameter controls how many times to subdivide nonlinear surface
 
 cells. Higher subdivisions generate closer approximations but take more
 
 memory and rendering time. Subdivision is recursive, so the number of
 
 output polygons can grow exponentially with this
 
 parameter.
 
 
 
 1
 
 
 
  
 
 
 '''PassThroughIds''' (PassThroughIds)
 
 
 
 If on, the output polygonal dataset will have a celldata
 
 array that holds the cell index of the original 3D cell that produced
 
 each output cell. This is useful for cell picking.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''PassThroughPointIds''' (PassThroughPointIds)
 
 
 
 If on, the output polygonal dataset will have a
 
 pointdata array that holds the point index of the original 3D vertex
 
 that produced each output vertex. This is useful for
 
 picking.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''MakeOutlineOfInput''' (MakeOutlineOfInput)
 
 
 
 Causes filter to try to make geometry of input to the
 
 algorithm on its input.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==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 pointcentered scalars and
 
 vectors. The Glyph filter operates on any type of data set. Its output is
 
 polygonal. This filter is available on the Toolbar.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Glyph filter.
 
 This is the dataset to which the glyphs will be
 
 applied.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 The dataset much contain a field array (point)
 
  
 with 1 component(s).
 
  
 The dataset much contain a field array (point)
 
  
 with 3 component(s).
 
  
 
 
 '''Scalars''' (SelectInputScalars)
 
 
 
 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''' (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.
 
 
 
 '''Glyph Type''' (Source)
 
 
 
 This property determines which type of glyph will be
 
 placed at the points in the input dataset.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkPolyDataThe value can be one of the following:
 
 * ArrowSource (sources)
 
  
 * ConeSource (sources)
 
  
 * CubeSource (sources)
 
  
 * CylinderSource (sources)
 
  
 * LineSource (sources)
 
  
 * SphereSource (sources)
 
  
 * GlyphSource2D (sources)
 
  
 
 
 '''GlyphTransform''' (GlyphTransform)
 
 
 
 The values in this property allow you to specify the
 
 transform (translation, rotation, and scaling) to apply to the glyph
 
 source.
 
 
 
  
 
 
 The value can be one of the following:
 
 * Transform2 (extended_sources)
 
  
 
 
 '''Orient''' (SetOrient)
 
 
 
 If this property is set to 1, the glyphs will be
 
 oriented based on the selected vector array.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''Scale Mode''' (SetScaleMode)
 
 
 
 The value of this property specifies how/if the glyphs
 
 should be scaled based on the pointcentered scalars/vectors in the
 
 input dataset.
 
 
 
 1
 
 
 
 The value(s) is an enumeration of the following:
 
 * scalar (0)
 
 * vector (1)
 
 * vector_components (2)
 
 * off (3)
 
 
 
 '''SetScaleFactor''' (SetScaleFactor)
 
 
 
 The value of this property will be used as a multiplier
 
 for scaling the glyphs before adding them to the
 
 output.
 
 
 
 1.0
 
 
 
 The value must lie within the range of the selected data array.The value must lie within the range of the selected data array.
 
 The value must be less than the largest dimension of the
 
 dataset multiplied by a scale factor of
 
 0.1.
 
  
 
 
 '''Maximum Number of Points''' (MaximumNumberOfPoints)
 
 
 
 The value of this property specifies the maximum number
 
 of glyphs that should appear in the output dataset if the value of the
 
 UseMaskPoints property is 1. (See the UseMaskPoints
 
 property.)
 
 
 
 5000
 
 
 
  
 
 
 '''Mask Points''' (UseMaskPoints)
 
 
 
 If the value of this property is set to 1, limit the
 
 maximum number of glyphs to the value indicated by
 
 MaximumNumberOfPoints. (See the MaximumNumberOfPoints
 
 property.)
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''RandomMode''' (RandomMode)
 
 
 
 If the value of this property is 1, then the points to
 
 glyph are chosen randomly. Otherwise the point ids chosen are evenly
 
 spaced.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''KeepRandomPoints''' (KeepRandomPoints)
 
 
 
 If the value of this property is 1 and RandomMode is
 
 1, then the randomly chosen points to glyph are saved and reused for
 
 other timesteps. This is only useful if the coordinates are the same
 
 and in the same order between timesteps.
 
  
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==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 pointcentered scalars
 
 and vectors. The Glyph filter operates on any type of data set. Its
 
 output is polygonal. This filter is available on the
 
 Toolbar.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Glyph filter.
 
 This is the dataset to which the glyphs will be
 
 applied.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 The dataset much contain a field array (point)
 
  
 with 1 component(s).
 
  
 The dataset much contain a field array (point)
 
  
 with 3 component(s).
 
  
 
 
 '''Glyph Type''' (Source)
 
 
 
 This property determines which type of glyph will be
 
 placed at the points in the input dataset.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkPolyData
 
 
 
 '''Scalars''' (SelectInputScalars)
 
 
 
 This property indicates the name of the scalar array on
 
 which to operate. The indicated array may be used for scaling the
 
 glyphs. (See the SetScaleMode property.)
 
 
 
  
 
 
 An array of scalars is required.
 
 
 
 '''Vectors''' (SelectInputVectors)
 
 
 
 This property indicates the name of the vector array on
 
 which to operate. The indicated array may be used for scaling and/or
 
 orienting the glyphs. (See the SetScaleMode and SetOrient
 
 properties.)
 
 
 
 1
 
 
 
 An array of vectors is required.
 
 
 
 '''Orient''' (SetOrient)
 
 
 
 If this property is set to 1, the glyphs will be
 
 oriented based on the selected vector array.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''Scale Mode''' (SetScaleMode)
 
 
 
 The value of this property specifies how/if the glyphs
 
 should be scaled based on the pointcentered scalars/vectors in the
 
 input dataset.
 
 
 
 1
 
 
 
 The value(s) is an enumeration of the following:
 
 * scalar (0)
 
 * vector (1)
 
 * vector_components (2)
 
 * off (3)
 
 
 
 '''SetScaleFactor''' (SetScaleFactor)
 
 
 
 The value of this property will be used as a multiplier
 
 for scaling the glyphs before adding them to the
 
 output.
 
 
 
 1.0
 
 
 
 The value must lie within the range of the selected data array.The value must lie within the range of the selected data array.
 
 The value must be less than the largest dimension of the
 
 dataset multiplied by a scale factor of
 
 0.1.
 
  
 
 
 '''Maximum Number of Points''' (MaximumNumberOfPoints)
 
 
 
 The value of this property specifies the maximum number
 
 of glyphs that should appear in the output dataset if the value of the
 
 UseMaskPoints property is 1. (See the UseMaskPoints
 
 property.)
 
 
 
 5000
 
 
 
  
 
 
 '''Mask Points''' (UseMaskPoints)
 
 
 
 If the value of this property is set to 1, limit the
 
 maximum number of glyphs to the value indicated by
 
 MaximumNumberOfPoints. (See the MaximumNumberOfPoints
 
 property.)
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''RandomMode''' (RandomMode)
 
 
 
 If the value of this property is 1, then the points to
 
 glyph are chosen randomly. Otherwise the point ids chosen are evenly
 
 spaced.
 
 
 
 1
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''KeepRandomPoints''' (KeepRandomPoints)
 
 
 
 If the value of this property is 1 and RandomMode is
 
 1, then the randomly chosen points to glyph are saved and reused for
 
 other timesteps. This is only useful if the coordinates are the same
 
 and in the same order between timesteps.
 
  
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
  
 }
 
  
 ==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.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Gradient
 
 filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkImageData
 
 The dataset much contain a field array (point)
 
  
 with 1 component(s).
 
  
 
 
 '''SelectInputScalars''' (SelectInputScalars)
 
 
 
 This property lists the name of the array from which to
 
 compute the gradient.
 
 
 
  
 
 
 An array of scalars is required.
 
 
 
 '''Dimensionality''' (Dimensionality)
 
 
 
 This property indicates whether to compute the gradient
 
 in two dimensions or in three. If the gradient is being computed in two
 
 dimensions, the X and Y dimensions are used.
 
 
 
 3
 
 
 
 The value(s) is an enumeration of the following:
 
 * Two (2)
 
 * Three (3)
 
  
 }
 
  
 ==Gradient Magnitude==
 
  
 Compute the magnitude of the gradient vectors for an image/volume.The Gradient
 
 Magnitude filter computes the magnitude of the gradient
 
 vector at each point in an image or volume. This filter
 
 operates on uniform rectilinear (image) data and produces
 
 image data output.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Gradient
 
 Magnitude filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkImageData
 
 The dataset much contain a field array (point)
 
  
 with 1 component(s).
 
  
 
 
 '''Dimensionality''' (Dimensionality)
 
 
 
 This property indicates whether to compute the gradient
 
 magnitude in two or three dimensions. If computing the gradient
 
 magnitude in 2D, the gradients in X and Y are used for computing the
 
 gradient magnitude.
 
 
 
 3
 
 
 
 The value(s) is an enumeration of the following:
 
 * Two (2)
 
 * Three (3)
 
  
 }
 
  
 ==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.
 
  
 { class="PropertiesTable" border="1" cellpadding="5"
 
 
 
  '''Property'''
 
  '''Description'''
 
  '''Default Value(s)'''
 
  '''Restrictions'''
 
  
 
 
 '''Input''' (Input)
 
 
 
 This property specifies the input to the Gradient
 
 (Unstructured) filter.
 
 
 
  
 
 
 Accepts input of following types:
 
 * vtkDataSet
 
 The dataset much contain a field array ()
 
  
 
 
 '''Scalar Array''' (SelectInputScalars)
 
 
 
 This property lists the name of the scalar array from
 
 which to compute the gradient.
 
 
 
  
 
 
 An array of scalars is required.The value must be field array name.
 
 
 
 '''ResultArrayName''' (ResultArrayName)
 
 
 
 This property provides a name for the output array
 
 containing the gradient vectors.
 
 
 
 Gradients
 
 
 
  
 
 
 '''FasterApproximation''' (FasterApproximation)
 
 
 
 When this flag is on, the gradient filter will provide a
 
 less accurate (but close) algorithm that performs fewer derivative
 
 calculations (and is therefore faster). The error contains some
 
 smoothing of the output data and some possible errors on the boundary.
 
 This parameter has no effect when performing the gradient of cell
 
 data.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''ComputeVorticity''' (ComputeVorticity)
 
 
 
 When this flag is on, the gradient filter will compute
 
 the vorticity/curl of a 3 component array.
 
 
 
 0
 
 
 
 Accepts boolean values (0 or 1).
 
 
 
 '''VorticityArrayName''' (VorticityArrayName)
 
 
 
 This property provides a name for the output array
 
 