ParaView/Users Guide/Sources: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
No edit summary
No edit summary
Line 1: Line 1:
==2D Glyph==
==2D Glyph==


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 15: Line 17:
|'''GlyphType''' (GlyphType)
|'''GlyphType''' (GlyphType)
|
|
 
This property specifies the type of the 2D
This property specifies the type of the 2D glyph.
glyph.
 
|
|
9
9
Line 37: Line 38:
|'''Filled''' (Filled)
|'''Filled''' (Filled)
|
|
 
If the value of this property is 1, the 2D glyph will be
If the value of this property is 1, the 2D glyph will be a filled polygon; otherwise, only the edges (line segments) will be included in the output. This only applies to closed 2D glyphs.
a filled polygon; otherwise, only the edges (line segments) will be
 
included in the output. This only applies to closed 2D
glyphs.
|
|
0
0
Line 47: Line 49:
|'''Center''' (Center)
|'''Center''' (Center)
|
|
 
Set the x, y, z coordinates of the origin of the 2D
Set the x, y, z coordinates of the origin of the 2D glyph.
glyph.
 
|
|
0.0 0.0 0.0
0.0 0.0 0.0
Line 59: Line 60:
==3D Text==
==3D Text==


3D geometric representation of a text string
3D geometric representation of a text stringThe 3D Text source
The 3D Text source displays a text string as polygonal data.
displays a text string as polygonal data.
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 73: Line 73:
|'''Text''' (Text)
|'''Text''' (Text)
|
|
 
This property contains the text string to be displayed.
This property contains the text string to be displayed. The ASCII alphanumeric characters a-z, A-Z, and 0-9 are supported; so are ASCII punctuation marks. The only supported control character is "\n", which inserts a new line in the text string.
The ASCII alphanumeric characters a-z, A-Z, and 0-9 are supported; so
 
are ASCII punctuation marks. The only supported control character is
"\n", which inserts a new line in the text string.
|
|
3D Text
3D Text
Line 83: Line 84:
|}
|}


==Annotate Time==
==AMR GaussianPulse Source==
 
Shows the animation time as text annnotation in the view.
The Annotate Time source can be used to show the animation time in text annotation.


Create AMR dataset w/ Gaussian PulseAMR
dataset source, used for generating sample Berger-Collela
AMR dataset with a Gaussian Pulse field at the
center.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 97: Line 99:


|-
|-
|'''Format''' (Format)
|'''Dimension''' (Dimension)
|
Sets the desired dimension for the AMR dataset to
generate.
|
3
|
The value(s) is an enumeration of the following:
* 2D (2)
* 3D (3)
|-
|'''Root Spacing''' (Root Spacing)
|
|
 
Set the spacing at level 0.
This property specifies the format used to display the input time (using printf style).
 
|
|
Time: %f
0.5
|
|


|}
==Arrow==
3D arrow with a long cylindrical shaft and a cone for the tip
The Arrow source appends a cylinder to a cone to form a 3D arrow. The length of the whole arrow is 1.0 unit. The output of the Arrow source is polygonal data. This polygonal data will not contain normals, so rendering of the arrow will be performed using flat shading. The appearance of the arrow can be improved without significantly increasing the resolution of the tip and shaft by generating normals. (Use Normals Generation filter).
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
|-
|'''TipResolution''' (TipResolution)
|'''RefinementRatio''' (RefinementRatio)
|
Sets the desired dimension for the AMR dataset to
generate.
|
2
|
The value(s) is an enumeration of the following:
* 2 (2)
* 3 (3)
* 4 (4)
|-
|'''XPulseOrigin''' (XPulseOrigin)
|
|
 
Set x-coordinate for the pulse origin
This property specifies the number of faces in the representation of the tip of the arrow (the cone). As the resolution increases, the cone will become smoother.
 
|
|
6
0.0
|
|


|-
|-
|'''TipRadius''' (TipRadius)
|'''YPulseOrigin''' (YPulseOrigin)
|
|
 
Set y-coordinate for the pulse origin
This property specifies the radius of the widest part of the tip of the arrow (the cone).
 
|
|
0.1
0.0
|
|


|-
|-
|'''TipLength''' (TipLength)
|'''ZPulseOrigin''' (ZPulseOrigin)
|
Set z-coordinate for the pulse origin
|
0.0
|
|


This property specifies the length of the tip.
|-
 
|'''XPulseWidth''' (XPulseWidth)
|
Set x-coordinate for the pulse Width
|
|
0.35
0.5
|
|


|-
|-
|'''ShaftResolution''' (ShaftResolution)
|'''YPulseWidth''' (YPulseWidth)
|
|
 
Set y-coordinate for the pulse Width
This property specifies the number of faces of the shaft of the arrow (the cylinder). As the resolution increases, the cylinder will become smoother.
 
|
|
6
0.5
|
|


|-
|-
|'''ShaftRadius''' (ShaftRadius)
|'''ZPulseWidth''' (ZPulseWidth)
|
|
 
Set z-coordinate for the pulse Width
This property specifies the radius of the shaft of the arrow (the cylinder).
 
|
|
0.03
0.5
|
|


|-
|-
|'''Invert''' (Invert)
|'''PulseAmplitude''' (PulseAmplitude)
|
|
 
Sets the amplitude of the pulse
Inverts the arrow direction.
 
|
|
0
0.5
|
|
Accepts boolean values (0 or 1).
 


|}
|}


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


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 199: Line 202:


|-
|-
|'''ScaleFactor''' (ScaleFactor)
|'''Format''' (Format)
|
|
 
This property specifies the format used to display the
By default the axes lines have a length of 1 (or 1 in each direction, for a total length of 2, if value of the Symmetric property is 1). Increasing or decreasing the value of this property will make the axes larger or smaller, respectively.
input time (using printf style).
 
|
|
1.0
Time: %f
|
|


|-
|'''Origin''' (Origin)
|


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


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


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
|'''Symmetric''' (Symmetric)
| '''Property'''
|
| '''Description'''
 
| '''Default Value(s)'''
When this property is set to 1, the axes extend along each of the positive and negative directions for a distance equal to the value of the Scale Factor property. When set to 0, the axes extend only in the positive direction.
| '''Restrictions'''


|-
|'''TipResolution''' (TipResolution)
|
|
0
This property specifies the number of faces in the
representation of the tip of the arrow (the cone). As the resolution
increases, the cone will become smoother.
|
6
|
|
Accepts boolean values (0 or 1).
|}
==BlockSelectionSource==
BlockSelectionSource is a source producing a block-based selection used
to select blocks from a composite dataset.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''TipRadius''' (TipRadius)
| '''Description'''
|
| '''Default Value(s)'''
This property specifies the radius of the widest part of
| '''Restrictions'''
the tip of the arrow (the cone).
|
0.1
|


|-
|-
|'''Blocks''' (Blocks)
|'''TipLength''' (TipLength)
|
|
 
This property specifies the length of the
The list of blocks that will be added to the selection produced by the
tip.
selection source. The blocks are identified using their composite
index (flat index).
 
|
|
0
0.35
|
|


 
|-
|'''ShaftResolution''' (ShaftResolution)
|
This property specifies the number of faces of the shaft
of the arrow (the cylinder). As the resolution increases, the cylinder
will become smoother.
|
6
|
 
|-
|'''ShaftRadius''' (ShaftRadius)
|
This property specifies the radius of the shaft of the
arrow (the cylinder).
|
0.03
|
 
|-
|'''Invert''' (Invert)
|
Inverts the arrow direction.
|
0
|
Accepts boolean values (0 or 1).
 
|}
|}


==Box==
==Axes==
 
Create a box with specified X, Y, and Z lengths.
The Box source can be used to add a box to the 3D scene. The output of the Box source is polygonal data containing both normals and texture coordinates.


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 274: Line 312:


|-
|-
|'''XLength''' (XLength)
|'''ScaleFactor''' (ScaleFactor)
|
|
 
By default the axes lines have a length of 1 (or 1 in
This property specifies the length of the box in the X direction.
each direction, for a total length of 2, if value of the Symmetric
 
property is 1). Increasing or decreasing the value of this property
will make the axes larger or smaller, respectively.
|
|
1.0
1.0
Line 284: Line 323:


|-
|-
|'''YLength''' (YLength)
|'''Origin''' (Origin)
|
|
 
The values of this property set the X, Y, and Z
This property specifies the length of the box in the Y direction.
coordinates of the origin of the axes.
 
|
|
1.0
0.0 0.0 0.0
|
|


|-
|-
|'''ZLength''' (ZLength)
|'''Symmetric''' (Symmetric)
|
|
 
When this property is set to 1, the axes extend along
This property specifies the length of the box in the Z direction.
each of the positive and negative directions for a distance equal to
 
the value of the Scale Factor property. When set to 0, the axes extend
only in the positive direction.
|
|
1.0
0
|
 
|-
|'''Center''' (Center)
|
 
This property specifies the center of the box.
 
|
0.0 0.0 0.0
|
|
 
Accepts boolean values (0 or 1).


|}
|}


==CompositeDataIDSelectionSource==
==BlockSelectionSource==


BlockSelectionSource is a source producing a block-based
selection used to select blocks from a composite dataset.


CompositeDataIDSelectionSource used to create an ID based selection for
{| class="PropertiesTable" border="1" cellpadding="5"
composite datasets (Multiblock or HierarchicalBox dataset).
 
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
Line 331: Line 358:


|-
|-
|'''IDs''' (IDs)
|'''Blocks''' (Blocks)
|
|
 
The list of blocks that will be added to the selection
The list of IDs that will be added to the selection produced by the
produced by the selection source. The blocks are identified using their
selection source. This takes 3-tuple of values as
composite index (flat index).
(flat-index, process number, id).
 
|
|
0 0 0
0
|
|


Line 345: Line 370:
|}
|}


==Cone==
==Box==
 
Create a 3D cone of a given radius and height.
The Cone source can be used to add a polygonal cone to the 3D scene. The output of the Cone source is polygonal data.


Create a box with specified X, Y, and Z lengths.The
Box source can be used to add a box to the 3D scene. The
output of the Box source is polygonal data containing both
normals and texture coordinates.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 359: Line 385:


|-
|-
|'''Resolution''' (Resolution)
|'''XLength''' (XLength)
|
|
 
This property specifies the length of the box in the X
This property indicates the number of divisions around the cone. The higher this number, the closer the polygonal approximation will come to representing a cone, and the more polygons it will contain.
direction.
 
|
|
6
1.0
|
|


|-
|-
|'''Radius''' (Radius)
|'''YLength''' (YLength)
|
|
 
This property specifies the length of the box in the Y
This property specifies the radius of the base of the cone.
direction.
 
|
|
0.5
1.0
|
|


|-
|-
|'''Height''' (Height)
|'''ZLength''' (ZLength)
|
|
 
This property specifies the length of the box in the Z
This property specifies the height of the cone.
direction.
 
|
|
1.0
1.0
Line 391: Line 414:
|'''Center''' (Center)
|'''Center''' (Center)
|
|
 
This property specifies the center of the
This property specifies the center of the cone.
box.
 
|
|
0.0 0.0 0.0
0.0 0.0 0.0
|
|


|-
|'''Direction''' (Direction)
|
Set the orientation vector of the cone. The vector does not have to be normalized. The cone will point in the direction specified.
|
1.0 0.0 0.0
|
|-
|'''Capping''' (Capping)
|
If this property is set to 1, the base of the cone will be capped with a filled polygon. Otherwise, the base of the cone will be open.
|
1
|
Accepts boolean values (0 or 1).


|}
|}


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


CompositeDataIDSelectionSource used to create an ID based
selection for composite datasets (Multiblock or HierarchicalBox
dataset).


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 435: Line 437:


|-
|-
|'''Resolution''' (Resolution)
|'''IDs''' (IDs)
|
|
The list of IDs that will be added to the selection
produced by the selection source. This takes 3-tuple of values as
(flat-index, process number, id).
|
0 0 0
|
|}
==Cone==


This property indicates the number of divisions around the cylinder. The higher this number, the closer the polygonal approximation will come to representing a cylinder, and the more polygons it will contain.
Create a 3D cone of a given radius and height.The Cone
source can be used to add a polygonal cone to the 3D
scene. The output of the Cone source is polygonal
data.


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


|-
|-
|'''Height''' (Height)
|'''Resolution''' (Resolution)
|
|
 
This property indicates the number of divisions around
This property specifies the height of the cylinder (along the y axis).
the cone. The higher this number, the closer the polygonal
 
approximation will come to representing a cone, and the more polygons
it will contain.
|
|
1.0
6
|
|


Line 457: Line 477:
|'''Radius''' (Radius)
|'''Radius''' (Radius)
|
|
 
This property specifies the radius of the base of the
This property specifies the radius of the cylinder.
cone.
 
|
|
0.5
0.5
Line 465: Line 484:


|-
|-
|'''Center''' (Center)
|'''Height''' (Height)
|
This property specifies the height of the
cone.
|
1.0
|
|


This property specifies the coordinate value at the center of the cylinder.
|-
|'''Center''' (Center)
|
This property specifies the center of the
cone.
|
0.0 0.0 0.0
|


|-
|'''Direction''' (Direction)
|
|
0.0 0.0 0.0
Set the orientation vector of the cone. The vector does
not have to be normalized. The cone will point in the direction
specified.
|
1.0 0.0 0.0
|
|


Line 477: Line 514:
|'''Capping''' (Capping)
|'''Capping''' (Capping)
|
|
 
If this property is set to 1, the base of the cone will
If this property is set to 1, the ends of the cylinder will each be capped with a closed polygon. Otherwise, the ends of the cylinder will be open.
be capped with a filled polygon. Otherwise, the base of the cone will
 
be open.
|
|
1
1
Line 487: Line 524:
|}
|}


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


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 515: Line 540:


|-
|-
|'''Program''' (Program)
|'''Resolution''' (Resolution)
|
|
 
This property indicates the number of divisions around
This property contains the string that is parsed to determine the structured of the output data object to produce.
the cylinder. The higher this number, the closer the polygonal
 
approximation will come to representing a cylinder, and the more
polygons it will contain.
|
|
ID1
6
|
|


|}
==Disk==
Create a 3D disk with a specified inner and outer radius.
The Disk source can be used to add a polygonal disk to the 3D scene. The output of the Disk source is polygonal data.
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''Height''' (Height)
| '''Description'''
|
| '''Default Value(s)'''
This property specifies the height of the cylinder
| '''Restrictions'''
(along the y axis).
|
1.0
|


|-
|-
|'''InnerRadius''' (InnerRadius)
|'''Radius''' (Radius)
|
|
 
This property specifies the radius of the
Specify inner radius of hole in disc.
cylinder.
 
|
|
0.5
0.5
Line 551: Line 569:


|-
|-
|'''OuterRadius''' (OuterRadius)
|'''Center''' (Center)
|
|
 
This property specifies the coordinate value at the
Specify outer radius of disc.  
center of the cylinder.
 
|
|
1.0
0.0 0.0 0.0
|
|


|-
|-
|'''RadialResolution''' (RadialResolution)
|'''Capping''' (Capping)
|
|
 
If this property is set to 1, the ends of the cylinder
Set the number of points in radial direction.
will each be capped with a closed polygon. Otherwise, the ends of the
 
cylinder will be open.
|
|
8
1
|
 
|-
|'''CircumferentialResolution''' (CircumferentialResolution)
|
 
Set the number of points in circumferential direction.
 
|
8
|
|
 
Accepts boolean values (0 or 1).


|}
|}


==FrustumSelectionSource==
==Data Object Generator==
 
 
FrustumSelectionSource is a source producing a frustum selection.


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 597: Line 618:


|-
|-
|'''Frustum''' (Frustum)
|'''Program''' (Program)
|
This property contains the string that is parsed to
determine the structured of the output data object to
produce.
|
|
 
ID1
Vertices that define a frustum for the selection source.
 
|
0.0 0.0 1.0 0.0 0.0 0.0 0.0 0.0 0.0 1.0 1.0 0.0 0.0 1.0 0.0 0.0 1.0 0.0 1.0 0.0 1.0 0.0 0.0 0.0 1.0 1.0 1.0 0.0 1.0 1.0 0.0 0.0
|
|


Line 609: Line 630:
|}
|}


==GlobalIDSelectionSource==
==Disk==
 
 
GlobalIDSelectionSource is a source producing a global ID based
selection.


Create a 3D disk with a specified inner and outer radius.The Disk source can be used
to add a polygonal disk to the 3D scene. The output of the
Disk source is polygonal data.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 624: Line 644:


|-
|-
|'''Global IDs''' (IDs)
|'''InnerRadius''' (InnerRadius)
|
Specify inner radius of hole in disc.
|
0.5
|
|


The list of IDs that will be added to the selection produced by the
|-
selection source.
|'''OuterRadius''' (OuterRadius)
|
Specify outer radius of disc.
|
1.0
|


|-
|'''RadialResolution''' (RadialResolution)
|
Set the number of points in radial
direction.
|
|
0
8
|
|


 
|-
|'''CircumferentialResolution''' (CircumferentialResolution)
|
Set the number of points in circumferential
direction.
|
8
|
 
 
|}
|}


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


FrustumSelectionSource is a source producing a frustum
selection.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 651: Line 693:


|-
|-
|'''Dimensions''' (Dimensions)
|'''Frustum''' (Frustum)
|
|
 
Vertices that define a frustum for the selection
This property specifies the X, Y, Z cell dimensions of a block.
source.
 
|
|
10
0.0 0.0 1.0 0.0 0.0 0.0 0.0 0.0 0.0 1.0 1.0 0.0 0.0 1.0 0.0 0.0 1.0 0.0 1.0 0.0 1.0 0.0 0.0 0.0 1.0 1.0 1.0 0.0 1.0 1.0 0.0 0.0
|
|


|-
|'''FractalValue''' (FractalValue)
|


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


|
GlobalIDSelectionSource is a source producing a global ID
9.5
based selection.
|


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
|'''MaximumLevel''' (MaximumLevel)
| '''Property'''
|
| '''Description'''
 
| '''Default Value(s)'''
This property specifies how many levels of refinement should be included in this hierarchical dataset.
| '''Restrictions'''


|-
|'''Global IDs''' (IDs)
|
The list of IDs that will be added to the selection
produced by the selection source.
|
|
5
0
|
|


|-
|'''GhostLevels''' (GhostLevels)
|


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


|
==Hierarchical Fractal==
1
|
Accepts boolean values (0 or 1).
|-
|'''TwoDimensional''' (TwoDimensional)
|


If this property is set to 1, the generated dataset will be 2D; otherwise it will be 3D.
Test source for AMR with HierarchicalDataSetThe Hierarchical Fractal
source is a collection of uniform grids. All have the same
dimensions. Each block has a different origin and spacing.
This source uses the Mandelbrot source to create cell
data. The fractal array is scaled to look like a volume
fraction.


|
{| class="PropertiesTable" border="1" cellpadding="5"
1
|
Accepts boolean values (0 or 1).
|-
|-
|'''Asymetric''' (Asymetric)
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''Dimensions''' (Dimensions)
|
|
 
This property specifies the X, Y, Z cell dimensions of a
If this property is set to 0, all the blocks will be the same size. If it is set to 1, an asymmetric dataset will be created: some blocks will have an X dimension that is larger by 2 units.
block.
 
|
|
0
10
|
|
Accepts boolean values (0 or 1).
 
|-
|-
|'''RectilinearGrids''' (RectilinearGrids)
|'''FractalValue''' (FractalValue)
|
|
 
The value of this property will be mapped to 0.5 for use
If this property is set to 1, the hierarchical dataset will contain rectilinear grids; otherwise it will contain uniform grids.
as a volume fraction.
 
|
|
0
9.5
|
|
Accepts boolean values (0 or 1).
 
|-
|-
|'''TimeStepRangeInfo''' (TimeStepRangeInfo)
|'''MaximumLevel''' (MaximumLevel)
|
|
 
This property specifies how many levels of refinement
should be included in this hierarchical dataset.
|
|
 
5
|
|


|-
|-
|'''TimeStep''' (TimeStep)
|'''GhostLevels''' (GhostLevels)
|
|
 
This property specifies whether ghost levels should be
This property specifies the timestep to use for this dataset.
generated at processor boundaries.
 
|
|
0
1
|
|
 
Accepts boolean values (0 or 1).
 
|}
 
==HierarchicalDataIDSelectionSource==
 
 
HierarchicalDataIDSelectionSource used to create an ID based selection for
HierarchicalBox datasets.
 
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''TwoDimensional''' (TwoDimensional)
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''IDs''' (IDs)
|
|
 
If this property is set to 1, the generated dataset will
The list of IDs that will be added to the selection produced by the
be 2D; otherwise it will be 3D.
selection source. This takes 3-tuple of values as
(level, index, id).
 
|
|
0 0 0
1
|
Accepts boolean values (0 or 1).
|-
|'''Asymetric''' (Asymetric)
|
If this property is set to 0, all the blocks will be the
same size. If it is set to 1, an asymmetric dataset will be created:
some blocks will have an X dimension that is larger by 2
units.
|
0
|
Accepts boolean values (0 or 1).
|-
|'''RectilinearGrids''' (RectilinearGrids)
|
If this property is set to 1, the hierarchical dataset
will contain rectilinear grids; otherwise it will contain uniform
grids.
|
0
|
Accepts boolean values (0 or 1).
|-
|'''TimeStepRangeInfo''' (TimeStepRangeInfo)
|
|


|


|}
|


==IDSelectionSource==
|-
|'''TimeStep''' (TimeStep)
|
This property specifies the timestep to use for this
dataset.
|
0
|




IDSelectionSource is a source producing a ID based selection. This
|}
cannot be used for selecting composite datasets.
 
==HierarchicalDataIDSelectionSource==


HierarchicalDataIDSelectionSource used to create an ID
based selection for HierarchicalBox datasets.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 787: Line 845:
|'''IDs''' (IDs)
|'''IDs''' (IDs)
|
|
 
The list of IDs that will be added to the selection
The list of IDs that will be added to the selection produced by the
produced by the selection source. This takes 3-tuple of values as
selection source. This takes pairs of values as
(level, index, id).
(process number, id).
 
|
|
0 0
0 0 0
|
|


Line 799: Line 855:
|}
|}


==Line==
==Hyper Tree Grid==
 
This source creates a line between two points. The resolution indicates how many segments are in the line.
The Line source can be used to interactively (using a 3D widget) or manually (using the entries on the user interface) add a line to the 3D scene. The output of the Line source is polygonal data.


Hyper tree grid representing a tree-based AMR data setThis source uses input parameters,
most notably a string descriptor, to generate a vtkHyperTreeGrid instance
representing the corresponding a tree-based AMR grid with arbitrary rectilinear
geometry and either binary or ternary subdivision.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 813: Line 870:


|-
|-
|'''Point1''' (Point1)
|'''GridSize''' (GridSize)
|
|
 
The three values in this property specify the number
This property controls the coordinates of the first endpoint of the line.
of root cells in each dimension of the hyper tree grid.
 
|
|
-0.5 0.0 0.0
1 1 1
|
|


|-
|-
|'''Point2''' (Point2)
|'''Dimension''' (Dimension)
|
|
 
This property specifies the dimensionality of  
This property controls the coordinates of the second endpoint of the line.
the hyper tree grid.
 
|
|
0.5 0.0 0.0
3
|
|


|-
|-
|'''Resolution''' (Resolution)
|'''AxisBranchFactor''' (AxisBranchFactor)
|
|
 
This property specifies the subdivision scheme
This property specifies the number of pieces into which to divide the line.
(binary or ternary) of the hyper tree grid.
 
|
|
6
3
|
|


|-
|'''MaximumLevel''' (MaximumLevel)
|
The value of this property specifies the maximum
number of levels in the hyper tree grid.
|
1
|


|}
==LocationSelectionSource==


|}


LocationSelectionSource is used to create a location based selection.
==IDSelectionSource==


IDSelectionSource is a source producing a ID based
selection. This cannot be used for selecting composite
datasets.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 859: Line 922:


|-
|-
|'''Locations''' (Locations)
|'''IDs''' (IDs)
|
|
 
The list of IDs that will be added to the selection
The list of locations that will be added to the selection produced by
produced by the selection source. This takes pairs of values as
the selection source.
(process number, id).
 
|
|
0 0 0
0 0
|
|


Line 872: Line 934:
|}
|}


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


This source creates a line between two points. The resolution indicates how many segments are in the line.The Line
source can be used to interactively (using a 3D widget) or
manually (using the entries on the user interface) add a
line to the 3D scene. The output of the Line source is
polygonal data.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 886: Line 950:


|-
|-
|'''WholeExtent''' (WholeExtent)
|'''Point1''' (Point1)
|
|
 
This property controls the coordinates of the first
The six values in the property indicate the X, Y, and Z extent of the output data. The first two numbers are the minimum and maximum X extent; the next two are the minimum and maximum Y extent; and the final two are the minimum and maximum Z extent. The numbers are inclusive, so values of 0, 250, 0, 250, 0, 0 indicate that the dimensions of the output will be 251 x 251 x 1.
endpoint of the line.
 
|
|
0 250 0 250 0 0
-0.5 0.0 0.0
|
|


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


|-
|-
|'''OriginCX''' (OriginCX)
|'''Resolution''' (Resolution)
|
|
 
This property specifies the number of pieces into which
The four values of this property indicate (in order) the components of C (real and imaginary) and the components of the initial value, X (real and imaginary).
to divide the line.
 
|
|
-1.75 -1.25 0.0 0.0
6
|
|


|-
|'''SizeCX''' (SizeCX)
|


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


|
LocationSelectionSource is used to create a location based
2.5 2.5 2.0 1.5
selection.
|


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
|'''Maximum Number of Iterations''' (MaximumNumberOfIterations)
| '''Property'''
|
| '''Description'''
 
| '''Default Value(s)'''
The value of this property specifies the limit on computational iterations (i.e., the maximum number of iterations to perform to determine if the value will go above 2). Values less than 2.0 after the specified number of iterations are considered in the fractal set.
| '''Restrictions'''
 
|
100
|


|-
|-
|'''SubsampleRate''' (SubsampleRate)
|'''Locations''' (Locations)
|
|
 
The list of locations that will be added to the
This property specifies the rate at which to subsample the volume. The extent of the dataset in each dimension will be divided by this value.
selection produced by the selection source.
 
|
|
1
0 0 0
|
|


Line 948: Line 1,003:
|}
|}


==NetworkImageSource==
==Mandelbrot==
 


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 960: Line 1,031:


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


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


|-
|'''OriginCX''' (OriginCX)
|
The four values of this property indicate (in order) the
components of C (real and imaginary) and the components of the initial
value, X (real and imaginary).
|
-1.75 -1.25 0.0 0.0
|


|}
==Octree Fractal==
Test source for octree with Mandelbrot fractal
Create an octree from a Mandelbrot fractal. See the Mandelbrot source for a description of the variables used.
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''SizeCX''' (SizeCX)
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''Dimension''' (Dimension)
|
|
 
The four values of this property indicate the length of
This property specifies the dimensionality of the fractal: 1D - Binary tree line, 2D - Quadtree plane, 3D - Octree volume.
the output in each of the four dimensions (the real and imaginary
 
components of C and the real and imaginary components of X). The three
dimensions specified in the Projection Axes property will determine
which of these values specify the length of the axes in the
output.
|
|
2
2.5 2.5 2.0 1.5
|
|


|-
|-
|'''MaximumLevel''' (MaximumLevel)
|'''Maximum Number of Iterations''' (MaximumNumberOfIterations)
|
|
 
The value of this property specifies the limit on
This property specifies the maximum refinement level for the grid.
computational iterations (i.e., the maximum number of iterations to
 
perform to determine if the value will go above 2). Values less than
2.0 after the specified number of iterations are considered in the
fractal set.
|
|
5
100
|
|


|-
|-
|'''MinimumLevel''' (MinimumLevel)
|'''SubsampleRate''' (SubsampleRate)
|
This property specifies the rate at which to subsample
the volume. The extent of the dataset in each dimension will be divided
by this value.
|
1
|
|


This property specifies the minimum refinement level for the grid.


|
|}
3
 
|
==NetworkImageSource==
 
 


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
|'''ProjectionAxes''' (ProjectionAxes)
| '''Property'''
|
| '''Description'''
 
| '''Default Value(s)'''
This property indicates which axes of the dataset to display. See Mandelbrot source for a description of the possible axes.
| '''Restrictions'''


|-
|'''FileName''' (FileName)
|
|
0 1 2
Set the name of image file to load.
|
|


|-
|'''OriginCX''' (OriginCX)
|
|


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


|
|}
-1.75 -1.25 0.0 0.0
|


|-
==Octree Fractal==
|'''SizeCX''' (SizeCX)
|


The four values of this property indicate the length of the output in each of the four dimensions (the real and imaginary components of C and the real and imaginary components of X). The three dimensions specified in the Projection Axes property will determine which of these values specify the length of the axes in the output.
Test source for octree with Mandelbrot fractalCreate an octree from a
Mandelbrot fractal. See the Mandelbrot source for a
description of the variables used.


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


|-
|-
|'''Maximum Number of Iterations''' (MaximumNumberOfIterations)
|'''Dimension''' (Dimension)
|
|
 
This property specifies the dimensionality of the
The value of this property specifies the limit on computational iterations (i.e., the maximum number of iterations to perform to determine if the value will go above 2). Values less than 2.0 after the specified number of iterations are considered in the fractal set.
fractal: 1D - Binary tree line, 2D - Quadtree plane, 3D - Octree
 
volume.
|
|
100
2
|
|


|-
|-
|'''Threshold''' (Threshold)
|'''MaximumLevel''' (MaximumLevel)
|
|
 
This property specifies the maximum refinement level for
This property specifies a threshold value that determines when to subdivide a leaf node.
the grid.
 
|
|
2.0
5
|
|


|-
|'''MinimumLevel''' (MinimumLevel)
|
This property specifies the minimum refinement level for
the grid.
|
3
|


|}
==Outline==
3D outline of the specified bounds.
The Outline source creates an axis aligned bounding box given the user-specified minimum and maximum coordinates for each axis.
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''ProjectionAxes''' (ProjectionAxes)
| '''Description'''
|
| '''Default Value(s)'''
This property indicates which axes of the dataset to
| '''Restrictions'''
display. See Mandelbrot source for a description of the possible
axes.
|
0 1 2
|


|-
|-
|'''Bounds''' (Bounds)
|'''OriginCX''' (OriginCX)
|
|
 
This property specifies the imaginary and real values
The values of this property specify the minimum and maximum X, Y, and Z coordinates (X min, X max, Y min, Y max, Z min, Z max) for drawing the outline.
for C (constant) and X (initial value). See Mandelbrot source for a
 
description of the C and X variables.
|
|
0 1 0 1 0 1
-1.75 -1.25 0.0 0.0
|
 
|-
|'''SizeCX''' (SizeCX)
|
The four values of this property indicate the length of
the output in each of the four dimensions (the real and imaginary
components of C and the real and imaginary components of X). The three
dimensions specified in the Projection Axes property will determine
which of these values specify the length of the axes in the
output.
|
2.5 2.5 2.0 1.5
|
 
|-
|'''Maximum Number of Iterations''' (MaximumNumberOfIterations)
|
The value of this property specifies the limit on
computational iterations (i.e., the maximum number of iterations to
perform to determine if the value will go above 2). Values less than
2.0 after the specified number of iterations are considered in the
fractal set.
|
100
|
 
|-
|'''Threshold''' (Threshold)
|
This property specifies a threshold value that
determines when to subdivide a leaf node.
|
2.0
|
|


Line 1,094: Line 1,226:
|}
|}


==PVTrivialProducer==
==Outline==
 


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,106: Line 1,241:


|-
|-
|'''WholeExtent''' (WholeExtent)
|'''Bounds''' (Bounds)
|
|
 
The values of this property specify the minimum and
The values of this property specify the whole extent of the topologically regular grid.
maximum X, Y, and Z coordinates (X min, X max, Y min, Y max, Z min, Z
 
max) for drawing the outline.
|
0 1 0 1 0 1
|
 
 
|}
 
==PVTrivialProducer==
 
 
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''WholeExtent''' (WholeExtent)
|
The values of this property specify the whole extent of
the topologically regular grid.
|
|
0 -1 0 -1 0 -1
0 -1 0 -1 0 -1
Line 1,120: Line 1,278:
==PedigreeIDSelectionSource==
==PedigreeIDSelectionSource==


 
PedigreeIDSelectionSource is a source producing a pedigree
PedigreeIDSelectionSource is a source producing a pedigree ID based
ID based selection.
selection.  
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,135: Line 1,291:
|'''Pedigree IDs''' (IDs)
|'''Pedigree IDs''' (IDs)
|
|
 
The list of integer IDs that will be added to the
The list of integer IDs that will be added to the selection produced by the
selection produced by the selection source, specified by the pair
selection source, specified by the pair (domain, id).
(domain, id).
 
|
|
id 0
id 0
Line 1,146: Line 1,301:
|'''Pedigree String IDs''' (StringIDs)
|'''Pedigree String IDs''' (StringIDs)
|
|
 
The list of string IDs that will be added to the
The list of string IDs that will be added to the selection produced by the
selection produced by the selection source, specified by the pair
selection source, specified by the pair (domain, id).
(domain, id).
 
|
|
id foo
id foo
Line 1,160: Line 1,314:


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,173: Line 1,332:
|'''Origin''' (Origin)
|'''Origin''' (Origin)
|
|
 
This property specifies the 3D coordinate of the origin
This property specifies the 3D coordinate of the origin (one corner) of the plane.
(one corner) of the plane.
 
|
|
-0.5 -0.5 0.0
-0.5 -0.5 0.0
Line 1,183: Line 1,341:
|'''Point1''' (Point1)
|'''Point1''' (Point1)
|
|
 
This property specifies the 3D coordinate a second
This property specifies the 3D coordinate a second corner of the parallelogram. The line connecting this point and that specified by the Origin property define one edge of the parallelogram (its X axis).
corner of the parallelogram. The line connecting this point and that
 
specified by the Origin property define one edge of the parallelogram
(its X axis).
|
|
0.5 -0.5 0.0
0.5 -0.5 0.0
Line 1,193: Line 1,352:
|'''Point2''' (Point2)
|'''Point2''' (Point2)
|
|
 
This property specifies the 3D coordinate a third corner
This property specifies the 3D coordinate a third corner of the parallelogram. The line connecting this point and that specified by the Origin property define a second edge of the parallelogram (its Y axis).
of the parallelogram. The line connecting this point and that specified
 
by the Origin property define a second edge of the parallelogram (its Y
axis).
|
|
-0.5 0.5 0.0
-0.5 0.5 0.0
Line 1,203: Line 1,363:
|'''XResolution''' (XResolution)
|'''XResolution''' (XResolution)
|
|
 
This property specifies the number of divisions along
This property specifies the number of divisions along the X axis of the parallelogram.
the X axis of the parallelogram.
 
|
|
1
1
Line 1,213: Line 1,372:
|'''YResolution''' (YResolution)
|'''YResolution''' (YResolution)
|
|
 
This property specifies the number of divisions along
This property specifies the number of divisions along the Y axis of the parallelogram.
the Y axis of the parallelogram.
 
|
|
1
1
Line 1,225: Line 1,383:
==Point Source==
==Point Source==


Create a point cloud of a certain size, radius, and center.
Create a point cloud of a certain size, radius, and center.The point source creates
The point source creates a specified number of points within a given radius about a specified center point.  
a specified number of points within a given radius about a
 
specified center point.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,239: Line 1,397:
|'''Center''' (Center)
|'''Center''' (Center)
|
|
 
This property specifies the 3D coordinates of the center
This property specifies the 3D coordinates of the center of the point cloud.
of the point cloud.
 
|
|
0.0 0.0 0.0
0.0 0.0 0.0
Line 1,249: Line 1,406:
|'''NumberOfPoints''' (NumberOfPoints)
|'''NumberOfPoints''' (NumberOfPoints)
|
|
 
This property specifies the number of points in the
This property specifies the number of points in the point cloud.
point cloud.
 
|
|
1
1
Line 1,259: Line 1,415:
|'''Radius''' (Radius)
|'''Radius''' (Radius)
|
|
 
This property specifies the radius of the point cloud,
This property specifies the radius of the point cloud, measured from the value of the Center property.
measured from the value of the Center property.
 
|
|
0.0
0.0
Line 1,272: Line 1,427:


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,288: Line 1,443:
|'''OutputDataSetType''' (OutputDataSetType)
|'''OutputDataSetType''' (OutputDataSetType)
|
|
 
The value of this property determines the dataset type
The value of this property determines the dataset type for the output of the programmable source.
for the output of the programmable source.
 
|
|
0
0
Line 1,306: Line 1,460:
|'''Script''' (Script)
|'''Script''' (Script)
|
|
 
This property contains the text of a python program that
This property contains the text of a python program that the programmable source runs.
the programmable source runs.
 
|
|


Line 1,316: Line 1,469:
|'''Script (RequestInformation)''' (InformationScript)
|'''Script (RequestInformation)''' (InformationScript)
|
|
 
This property is a python script that is executed during
This property is a python script that is executed during the RequestInformation pipeline pass. Use this to provide information such as WHOLE_EXTENT to the pipeline downstream.
the RequestInformation pipeline pass. Use this to provide information
 
such as WHOLE_EXTENT to the pipeline downstream.
|
|


Line 1,334: Line 1,487:
|'''PythonPath''' (PythonPath)
|'''PythonPath''' (PythonPath)
|
|
 
A semi-colon (;) separated list of directories to add to
A semi-colon (;) separated list of directories to add to the python library
the python library search path.
search path.
 
|
|


Line 1,347: Line 1,498:
==Ruler==
==Ruler==


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,364: Line 1,515:
|'''Point1''' (Point1)
|'''Point1''' (Point1)
|
|
 
This property controls the coordinates of the first
This property controls the coordinates of the first endpoint of the line.
endpoint of the line.
 
|
|
-0.5 0.0 0.0
-0.5 0.0 0.0
|
|
Line 1,374: Line 1,524:
|'''Point2''' (Point2)
|'''Point2''' (Point2)
|
|
 
This property controls the coordinates of the second
This property controls the coordinates of the second endpoint of the line.
endpoint of the line.
 
|
|
0.5 0.0 0.0
0.5 0.0 0.0
Line 1,398: Line 1,547:
|'''FieldType''' (FieldType)
|'''FieldType''' (FieldType)
|
|
 
The location of the array the selection came from (ex,
The location of the array the selection came from (ex, point, cell).
point, cell).
 
|
|
0
0
Line 1,412: Line 1,560:
* ROW (5)
* ROW (5)
|-
|-
|'''TermMode''' (TermMode)
|'''QueryString''' (QueryString)
|
 
|
0
|
The value(s) is an enumeration of the following:
* None (0)
* ID (1)
* GLOBALID (2)
* ARRAY (3)
* LOCATION (4)
* BLOCK (5)
|-
|'''Operator''' (Operator)
|
 
|
0
|
The value(s) is an enumeration of the following:
* None (0)
* IS_ONE_OF (1)
* IS_BETWEEN (2)
* IS_GE (3)
* IS_LE (4)
|-
|'''ArrayName''' (ArrayName)
|
 
|
 
|
 
|-
|'''ArrayComponent''' (ArrayComponent)
|
 
|
0
|
 
|-
|'''IdTypeValues''' (IdTypeValues)
|
 
|
 
|
 
|-
|'''DoubleValues''' (DoubleValues)
|
|


Line 1,502: Line 1,599:
|
|


|-
|'''ContainingCells''' (ContainingCells)
|
Useful only when FieldType==POINT. This results in selecting the cells
that contain the matching points.
|
0
|
Accepts boolean values (0 or 1).
|-
|-
|'''UserFriendlyText''' (UserFriendlyText)
|'''UserFriendlyText''' (UserFriendlyText)
|
|
 
Reconstructs the query as a user friendly text eg. "IDs
Reconstructs the query as a user friendly text eg. "IDs >= 12".
>= 12".
 
|
 
|
|


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


When this property is false the selection describes everything that
should be extracted. When this is true the selection describes
everything that should NOT be extracted.
|
0
|
Accepts boolean values (0 or 1).


|}
|}
Line 1,540: Line 1,613:
==SelectionSourceBase==
==SelectionSourceBase==


 
Internal proxy used to define the common API for Selection
Internal proxy used to define the common API for Selection Source
Source proxies. Do not use.
proxies. Do not use.
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,555: Line 1,626:
|'''FieldType''' (FieldType)
|'''FieldType''' (FieldType)
|
|
 
The location of the array the selection came from (ex,
The location of the array the selection came from (ex, point, cell).
point, cell).
 
|
|
0
0
Line 1,571: Line 1,641:
|'''ContainingCells''' (ContainingCells)
|'''ContainingCells''' (ContainingCells)
|
|
 
When field type is POINT, this controls whether single
When field type is POINT, this controls whether single vertex cells
vertex cells will be produced for each selected point, or whether the
will be produced for each selected point, or whether the cells that
cells that contain each selected point will be produced. When field
contain each selected point will be produced. When field type is CELL
type is CELL this has no effect.
this has no effect.
 
|
|
0
0
Line 1,584: Line 1,652:
|'''InsideOut''' (InsideOut)
|'''InsideOut''' (InsideOut)
|
|
 
When this property is false the selection describes
When this property is false the selection describes everything that
everything that should be extracted. When this is true the selection
should be extracted. When this is true the selection describes
describes everything that should NOT be extracted.
everything that should NOT be extracted.
 
|
|
0
0
Line 1,598: Line 1,664:
==Sphere==
==Sphere==


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,612: Line 1,679:
|'''Center''' (Center)
|'''Center''' (Center)
|
|
 
This property specifies the 3D coordinates for the
This property specifies the 3D coordinates for the center of the sphere.
center of the sphere.
 
|
|
0.0 0.0 0.0
0.0 0.0 0.0
Line 1,622: Line 1,688:
|'''Radius''' (Radius)
|'''Radius''' (Radius)
|
|
 
This property specifies the radius of the
This property specifies the radius of the sphere.
sphere.
 
|
|
0.5
0.5
Line 1,632: Line 1,697:
|'''ThetaResolution''' (ThetaResolution)
|'''ThetaResolution''' (ThetaResolution)
|
|
 
The value of this property represents the number of
The value of this property represents the number of divisions between Start Theta and End Theta around the sphere. (See the Start Theta and End Theta properties.) The theta divisions are similar to longitude lines on the earth. The higher the resolution, the closer the approximation will come to a sphere, and the more polygons there will be.
divisions between Start Theta and End Theta around the sphere. (See the
 
Start Theta and End Theta properties.) The theta divisions are similar
to longitude lines on the earth. The higher the resolution, the closer
the approximation will come to a sphere, and the more polygons there
will be.
|
|
8
8
Line 1,642: Line 1,710:
|'''StartTheta''' (StartTheta)
|'''StartTheta''' (StartTheta)
|
|
 
To form a complete sphere, the value of this property
To form a complete sphere, the value of this property should be 0 degrees, and the value of the End Theta property should be 360 degrees. The value of this property can be adjusted to form only a portion of a sphere.
should be 0 degrees, and the value of the End Theta property should be
 
360 degrees. The value of this property can be adjusted to form only a
portion of a sphere.
|
|
0
0
Line 1,652: Line 1,721:
|'''EndTheta''' (EndTheta)
|'''EndTheta''' (EndTheta)
|
|
 
The value of this property can be adjusted to form only
The value of this property can be adjusted to form only a portion of a sphere. This value is measured in degrees.
a portion of a sphere. This value is measured in
 
degrees.
|
|
360
360
Line 1,662: Line 1,731:
|'''PhiResolution''' (PhiResolution)
|'''PhiResolution''' (PhiResolution)
|
|
 
The value of this property represents the number of
The value of this property represents the number of divisions between Start Phi and End Phi on the sphere. (See the Start Phi and End Phi properties.) The phi divisions are similar to latitude lines on the earth.
divisions between Start Phi and End Phi on the sphere. (See the Start
 
Phi and End Phi properties.) The phi divisions are similar to latitude
lines on the earth.
|
|
8
8
Line 1,672: Line 1,742:
|'''StartPhi''' (StartPhi)
|'''StartPhi''' (StartPhi)
|
|
 
To form a complete sphere, the value of this property
To form a complete sphere, the value of this property should be 0 degrees, and the value of the End Phi property should be 180 degrees. The value of this property can be adjusted to form only a portion of a sphere.
should be 0 degrees, and the value of the End Phi property should be
Set the starting angle (in degrees) in the latitudinal direction.
180 degrees. The value of this property can be adjusted to form only a
 
portion of a sphere. Set the starting angle (in degrees) in the
latitudinal direction.
|
|
0
0
Line 1,683: Line 1,754:
|'''EndPhi''' (EndPhi)
|'''EndPhi''' (EndPhi)
|
|
 
The value of this property can be adjusted to form only
The value of this property can be adjusted to form only a portion of a sphere. The value is measured in degrees.
a portion of a sphere. The value is measured in
 
degrees.
|
|
180
180
Line 1,695: Line 1,766:
==SplineSource==
==SplineSource==


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,711: Line 1,782:
|'''Parametric Function''' (ParametricFunction)
|'''Parametric Function''' (ParametricFunction)
|
|
 
Property used to reference the parametric function as
Property used to reference the parametric function as data generator.
data generator.
 
|
|


Line 1,726: Line 1,796:


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,739: Line 1,812:
|'''Center''' (Center)
|'''Center''' (Center)
|
|
 
This property specifies the 3D coordinates of the center
This property specifies the 3D coordinates of the center of the superquadric.
of the superquadric.
 
|
|
0.0 0.0 0.0
0.0 0.0 0.0
Line 1,749: Line 1,821:
|'''Scale''' (Scale)
|'''Scale''' (Scale)
|
|
 
The three values in this property are used to scale the
The three values in this property are used to scale the superquadric in X, Y, and Z. The surface normals will be computed correctly even with anisotropic scaling.
superquadric in X, Y, and Z. The surface normals will be computed
 
correctly even with anisotropic scaling.
|
|
1.0 1.0 1.0
1.0 1.0 1.0
Line 1,759: Line 1,831:
|'''ThetaResolution''' (ThetaResolution)
|'''ThetaResolution''' (ThetaResolution)
|
|
 
The value of this property represents the number of
The value of this property represents the number of divisions in the theta (longitudinal) direction. This value will be rounded to the nearest multiple of 8.
divisions in the theta (longitudinal) direction. This value will be
 
rounded to the nearest multiple of 8.
|
|
16
16
Line 1,769: Line 1,841:
|'''PhiResolution''' (PhiResolution)
|'''PhiResolution''' (PhiResolution)
|
|
 
The value of this property represents the number of
The value of this property represents the number of divisions in the phi (latitudinal) direction. This number will be rounded to the nearest multiple of 4.
divisions in the phi (latitudinal) direction. This number will be
 
rounded to the nearest multiple of 4.
|
|
16
16
Line 1,779: Line 1,851:
|'''Thickness''' (Thickness)
|'''Thickness''' (Thickness)
|
|
 
If the value of the Toroidal property is 1, this value
If the value of the Toroidal property is 1, this value represents the thickness of the superquadric as a value between 0 and 1. A value close to 0 leads to a thin object with a large hole, and a value near 1 leads to a thick object with a very small hole. Changing the thickness does not change the outer radius of the superquadric.
represents the thickness of the superquadric as a value between 0 and
 
1. A value close to 0 leads to a thin object with a large hole, and a
value near 1 leads to a thick object with a very small hole. Changing
the thickness does not change the outer radius of the
superquadric.
|
|
0.3333
0.3333
Line 1,789: Line 1,864:
|'''ThetaRoundness''' (ThetaRoundness)
|'''ThetaRoundness''' (ThetaRoundness)
|
|
 
This property defines the roundness of the superquadric
This property defines the roundness of the superquadric in the theta (longitudinal) direction. A value of 0 represents a rectangular shape, a value of 1 represents a circular shape, and values greater than 1 produce higher order shapes.
in the theta (longitudinal) direction. A value of 0 represents a
 
rectangular shape, a value of 1 represents a circular shape, and values
greater than 1 produce higher order shapes.
|
|
1
1
Line 1,799: Line 1,875:
|'''PhiRoundness''' (PhiRoundness)
|'''PhiRoundness''' (PhiRoundness)
|
|
 
This property defines the roundness in the phi
This property defines the roundness in the phi (latitudinal) direction. A value of 0 represents a rectangular shape, a value of 1 represents a circular shape, and values greater than 1 produce higher order shapes.
(latitudinal) direction. A value of 0 represents a rectangular shape, a
 
value of 1 represents a circular shape, and values greater than 1
produce higher order shapes.
|
|
1
1
Line 1,809: Line 1,886:
|'''Size''' (Size)
|'''Size''' (Size)
|
|
 
The value of this property represents the isotropic size
The value of this property represents the isotropic size of the superquadric. Note that both the Size and Thickness properties control coefficients of superquadric generation, so the value of this property may not exactly describe the size of the superquadric.
of the superquadric. Note that both the Size and Thickness properties
 
control coefficients of superquadric generation, so the value of this
property may not exactly describe the size of the
superquadric.
|
|
0.5
0.5
Line 1,819: Line 1,898:
|'''Toroidal''' (Toroidal)
|'''Toroidal''' (Toroidal)
|
|
 
If the value of this property is 0, the generated
If the value of this property is 0, the generated superquadric will not contain a hole (i.e., the superquadric will be ellipsoidal). Otherwise, a toroidal object is generated.
superquadric will not contain a hole (i.e., the superquadric will be
 
ellipsoidal). Otherwise, a toroidal object is
generated.
|
|
1
1
Line 1,843: Line 1,923:
|'''Resolution''' (Resolution)
|'''Resolution''' (Resolution)
|
|
 
Set the number of faces used to generate the
Set the number of faces used to generate the cone.
cone.
 
|
|
6
6
Line 1,855: Line 1,934:
==Text==
==Text==


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,869: Line 1,948:
|'''Text''' (Text)
|'''Text''' (Text)
|
|
 
This property specifies the text to
This property specifies the text to display.
display.
 
|
|
Text
Text
Line 1,881: Line 1,959:
==ThresholdSelectionSource==
==ThresholdSelectionSource==


 
ThresholdSelectionSource is used to create a threshold
ThresholdSelectionSource is used to create a threshold based selection.
based selection.
 


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,895: Line 1,972:
|'''Thresholds''' (Thresholds)
|'''Thresholds''' (Thresholds)
|
|
 
The list of thresholds that will be added to the
The list of thresholds that will be added to the selection produced by
selection produced by the selection source.
the selection source.
 
|
|


Line 1,906: Line 1,981:
|'''ArrayName''' (ArrayName)
|'''ArrayName''' (ArrayName)
|
|
 
For threshold and value selection, this controls the
For threshold and value selection, this controls the name of the
name of the scalar array that will be thresholded
scalar array that will be thresholded within.
within.
 
|
|
none
none
Line 1,919: Line 1,993:
==Time Source==
==Time Source==


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,934: Line 2,007:
|'''Analytic''' (Analytic)
|'''Analytic''' (Analytic)
|
|
 
Makes the time source produce discrete steps of or an
Makes the time source produce discrete steps of or an analytic sin wave.
analytic sin wave.
 
|
|
0
0
Line 1,944: Line 2,016:
|'''X Amplitude''' (X Amplitude)
|'''X Amplitude''' (X Amplitude)
|
|
 
Controls how far the data set moves along X over
Controls how far the data set moves along X over time.
time.
 
|
|
0.0
0.0
Line 1,954: Line 2,025:
|'''Y Amplitude''' (Y Amplitude)
|'''Y Amplitude''' (Y Amplitude)
|
|
 
Controls how far the data set moves along Y over
Controls how far the data set moves along Y over time.
time.
 
|
|
0.0
0.0
Line 1,964: Line 2,034:
|'''Growing''' (Growing)
|'''Growing''' (Growing)
|
|
 
Makes the time source grow and shrink along Y over
Makes the time source grow and shrink along Y over time.
time.
 
|
|
0
0
Line 1,999: Line 2,068:


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


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,012: Line 2,088:


|-
|-
|'''WholeExtent''' (WholeExtent)
|'''Whole Extent''' (WholeExtent)
|
|
 
The six values in this property indicate the X, Y, and Z
The six values in this property indicate the X, Y, and Z extent of the output data. The first two values represent the minimum and maximum X indices, the next two are the minimum and maximum Y indices, and the last two are the minimum and maximum Z indices.
extent of the output data. The first two values represent the minimum
 
and maximum X indices, the next two are the minimum and maximum Y
indices, and the last two are the minimum and maximum Z
indices.
|
|
-10 10 -10 10 -10 10
-10 10 -10 10 -10 10
Line 2,024: Line 2,102:
|'''Center''' (Center)
|'''Center''' (Center)
|
|
 
This property specifies the 3D coordinates of the center
This property specifies the 3D coordinates of the center of the dataset.
of the dataset.
 
|
|
0.0 0.0 0.0
0.0 0.0 0.0
Line 2,034: Line 2,111:
|'''Maximum''' (Maximum)
|'''Maximum''' (Maximum)
|
|
 
This parameter specifies the maximum value (M) of the
This parameter specifies the maximum value (M) of the function.
function.
 
|
|
255.0
255.0
Line 2,044: Line 2,120:
|'''XFreq''' (XFreq)
|'''XFreq''' (XFreq)
|
|
 
This property specifies the natural frequency in X (XF
This property specifies the natural frequency in X (XF in the equation).
in the equation).
 
|
|
60.0
60.0
Line 2,054: Line 2,129:
|'''YFreq''' (YFreq)
|'''YFreq''' (YFreq)
|
|
 
This property specifies the natural frequency in Y (YF
This property specifies the natural frequency in Y (YF in the equation).
in the equation).
 
|
|
30.0
30.0
Line 2,064: Line 2,138:
|'''ZFreq''' (ZFreq)
|'''ZFreq''' (ZFreq)
|
|
 
This property specifies the natural frequency in Z (ZF
This property specifies the natural frequency in Z (ZF in the equation).
in the equation).
 
|
|
40.0
40.0
Line 2,074: Line 2,147:
|'''XMag''' (XMag)
|'''XMag''' (XMag)
|
|
 
This property specifies the wave amplitude in X (XM in
This property specifies the wave amplitude in X (XM in the equation).
the equation).
 
|
|
10.0
10.0
Line 2,084: Line 2,156:
|'''YMag''' (YMag)
|'''YMag''' (YMag)
|
|
 
This property specifies the wave amplitude in Y (YM in
This property specifies the wave amplitude in Y (YM in the equation).
the equation).
 
|
|
18.0
18.0
Line 2,094: Line 2,165:
|'''ZMag''' (ZMag)
|'''ZMag''' (ZMag)
|
|
 
This property specifies the wave amplitude in Z (ZM in
This property specifies the wave amplitude in Z (ZM in the equation).
the equation).
 
|
|
5.0
5.0
Line 2,104: Line 2,174:
|'''StandardDeviation''' (StandardDeviation)
|'''StandardDeviation''' (StandardDeviation)
|
|
 
This property specifies the standard deviation of the
This property specifies the standard deviation of the Gaussian used in computing this function.
Gaussian used in computing this function.
 
|
|
0.5
0.5
Line 2,114: Line 2,183:
|'''SubsampleRate''' (SubsampleRate)
|'''SubsampleRate''' (SubsampleRate)
|
|
 
This property specifies the rate at which to subsample
This property specifies the rate at which to subsample the volume. The extent of the dataset in each dimension will be divided by this value. (See the Whole Extent property.)
the volume. The extent of the dataset in each dimension will be divided
 
by this value. (See the Whole Extent property.)
|
|
1
1

Revision as of 18:53, 7 November 2012

2D Glyph

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

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

This property specifies the type of the 2D glyph.

9

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

  • Vertex (1)
  • Dash (2)
  • Cross (3)
  • ThickCross (4)
  • Triangle (5)
  • Square (6)
  • Circle (7)
  • Diamond (8)
  • Arrow (9)
  • ThickArrow (10)
  • HookedArrow (11)
  • EdgeArrow (12)
Filled (Filled)

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

0

Accepts boolean values (0 or 1).

Center (Center)

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

0.0 0.0 0.0


3D Text

3D geometric representation of a text stringThe 3D Text source displays a text string as polygonal data.

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

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

3D Text


AMR GaussianPulse Source

Create AMR dataset w/ Gaussian PulseAMR dataset source, used for generating sample Berger-Collela AMR dataset with a Gaussian Pulse field at the center.

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

Sets the desired dimension for the AMR dataset to generate.

3

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

  • 2D (2)
  • 3D (3)
Root Spacing (Root Spacing)

Set the spacing at level 0.

0.5

RefinementRatio (RefinementRatio)

Sets the desired dimension for the AMR dataset to generate.

2

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

  • 2 (2)
  • 3 (3)
  • 4 (4)
XPulseOrigin (XPulseOrigin)

Set x-coordinate for the pulse origin

0.0

YPulseOrigin (YPulseOrigin)

Set y-coordinate for the pulse origin

0.0

ZPulseOrigin (ZPulseOrigin)

Set z-coordinate for the pulse origin

0.0

XPulseWidth (XPulseWidth)

Set x-coordinate for the pulse Width

0.5

YPulseWidth (YPulseWidth)

Set y-coordinate for the pulse Width

0.5

ZPulseWidth (ZPulseWidth)

Set z-coordinate for the pulse Width

0.5

PulseAmplitude (PulseAmplitude)

Sets the amplitude of the pulse

0.5


Annotate Time

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

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

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

Time: %f


Arrow

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

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

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

6

TipRadius (TipRadius)

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

0.1

TipLength (TipLength)

This property specifies the length of the tip.

0.35

ShaftResolution (ShaftResolution)

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

6

ShaftRadius (ShaftRadius)

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

0.03

Invert (Invert)

Inverts the arrow direction.

0

Accepts boolean values (0 or 1).

Axes

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

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

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

1.0

Origin (Origin)

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

0.0 0.0 0.0

Symmetric (Symmetric)

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

0

Accepts boolean values (0 or 1).

BlockSelectionSource

BlockSelectionSource is a source producing a block-based selection used to select blocks from a composite dataset.

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

The list of blocks that will be added to the selection produced by the selection source. The blocks are identified using their composite index (flat index).

0


Box

Create a box with specified X, Y, and Z lengths.The Box source can be used to add a box to the 3D scene. The output of the Box source is polygonal data containing both normals and texture coordinates.

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

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

1.0

YLength (YLength)

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

1.0

ZLength (ZLength)

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

1.0

Center (Center)

This property specifies the center of the box.

0.0 0.0 0.0


CompositeDataIDSelectionSource

CompositeDataIDSelectionSource used to create an ID based selection for composite datasets (Multiblock or HierarchicalBox dataset).

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

The list of IDs that will be added to the selection produced by the selection source. This takes 3-tuple of values as (flat-index, process number, id).

0 0 0


Cone

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

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

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

6

Radius (Radius)

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

0.5

Height (Height)

This property specifies the height of the cone.

1.0

Center (Center)

This property specifies the center of the cone.

0.0 0.0 0.0

Direction (Direction)

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

1.0 0.0 0.0

Capping (Capping)

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

1

Accepts boolean values (0 or 1).

Cylinder

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

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

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

6

Height (Height)

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

1.0

Radius (Radius)

This property specifies the radius of the cylinder.

0.5

Center (Center)

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

0.0 0.0 0.0

Capping (Capping)

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

1

Accepts boolean values (0 or 1).

Data Object Generator

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

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

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

ID1


Disk

Create a 3D disk with a specified inner and outer radius.The Disk source can be used to add a polygonal disk to the 3D scene. The output of the Disk source is polygonal data.

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

Specify inner radius of hole in disc.

0.5

OuterRadius (OuterRadius)

Specify outer radius of disc.

1.0

RadialResolution (RadialResolution)

Set the number of points in radial direction.

8

CircumferentialResolution (CircumferentialResolution)

Set the number of points in circumferential direction.

8


FrustumSelectionSource

FrustumSelectionSource is a source producing a frustum selection.

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

Vertices that define a frustum for the selection source.

0.0 0.0 1.0 0.0 0.0 0.0 0.0 0.0 0.0 1.0 1.0 0.0 0.0 1.0 0.0 0.0 1.0 0.0 1.0 0.0 1.0 0.0 0.0 0.0 1.0 1.0 1.0 0.0 1.0 1.0 0.0 0.0


GlobalIDSelectionSource

GlobalIDSelectionSource is a source producing a global ID based selection.

Property Description Default Value(s) Restrictions
Global IDs (IDs)

The list of IDs that will be added to the selection produced by the selection source.

0


Hierarchical Fractal

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

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

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

10

FractalValue (FractalValue)

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

9.5

MaximumLevel (MaximumLevel)

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

5

GhostLevels (GhostLevels)

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

1

Accepts boolean values (0 or 1).

TwoDimensional (TwoDimensional)

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

1

Accepts boolean values (0 or 1).

Asymetric (Asymetric)

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

0

Accepts boolean values (0 or 1).

RectilinearGrids (RectilinearGrids)

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

0

Accepts boolean values (0 or 1).

TimeStepRangeInfo (TimeStepRangeInfo)
TimeStep (TimeStep)

This property specifies the timestep to use for this dataset.

0


HierarchicalDataIDSelectionSource

HierarchicalDataIDSelectionSource used to create an ID based selection for HierarchicalBox datasets.

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

The list of IDs that will be added to the selection produced by the selection source. This takes 3-tuple of values as (level, index, id).

0 0 0


Hyper Tree Grid

Hyper tree grid representing a tree-based AMR data setThis source uses input parameters, most notably a string descriptor, to generate a vtkHyperTreeGrid instance representing the corresponding a tree-based AMR grid with arbitrary rectilinear geometry and either binary or ternary subdivision.

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

The three values in this property specify the number of root cells in each dimension of the hyper tree grid.

1 1 1

Dimension (Dimension)

This property specifies the dimensionality of the hyper tree grid.

3

AxisBranchFactor (AxisBranchFactor)

This property specifies the subdivision scheme (binary or ternary) of the hyper tree grid.

3

MaximumLevel (MaximumLevel)

The value of this property specifies the maximum number of levels in the hyper tree grid.

1


IDSelectionSource

IDSelectionSource is a source producing a ID based selection. This cannot be used for selecting composite datasets.

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

The list of IDs that will be added to the selection produced by the selection source. This takes pairs of values as (process number, id).

0 0


Line

This source creates a line between two points. The resolution indicates how many segments are in the line.The Line source can be used to interactively (using a 3D widget) or manually (using the entries on the user interface) add a line to the 3D scene. The output of the Line source is polygonal data.

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

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

-0.5 0.0 0.0

Point2 (Point2)

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

0.5 0.0 0.0

Resolution (Resolution)

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

6


LocationSelectionSource

LocationSelectionSource is used to create a location based selection.

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

The list of locations that will be added to the selection produced by the selection source.

0 0 0


Mandelbrot

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

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

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

0 250 0 250 0 0

ProjectionAxes (ProjectionAxes)

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

0 1 2

OriginCX (OriginCX)

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

-1.75 -1.25 0.0 0.0

SizeCX (SizeCX)

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

2.5 2.5 2.0 1.5

Maximum Number of Iterations (MaximumNumberOfIterations)

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

100

SubsampleRate (SubsampleRate)

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

1


NetworkImageSource

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

Set the name of image file to load.


Octree Fractal

Test source for octree with Mandelbrot fractalCreate an octree from a Mandelbrot fractal. See the Mandelbrot source for a description of the variables used.

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

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

2

MaximumLevel (MaximumLevel)

This property specifies the maximum refinement level for the grid.

5

MinimumLevel (MinimumLevel)

This property specifies the minimum refinement level for the grid.

3

ProjectionAxes (ProjectionAxes)

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

0 1 2

OriginCX (OriginCX)

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

-1.75 -1.25 0.0 0.0

SizeCX (SizeCX)

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

2.5 2.5 2.0 1.5

Maximum Number of Iterations (MaximumNumberOfIterations)

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

100

Threshold (Threshold)

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

2.0


Outline

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

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

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

0 1 0 1 0 1


PVTrivialProducer

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

The values of this property specify the whole extent of the topologically regular grid.

0 -1 0 -1 0 -1


PedigreeIDSelectionSource

PedigreeIDSelectionSource is a source producing a pedigree ID based selection.

Property Description Default Value(s) Restrictions
Pedigree IDs (IDs)

The list of integer IDs that will be added to the selection produced by the selection source, specified by the pair (domain, id).

id 0

Pedigree String IDs (StringIDs)

The list of string IDs that will be added to the selection produced by the selection source, specified by the pair (domain, id).

id foo


Plane

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

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

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

-0.5 -0.5 0.0

Point1 (Point1)

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

0.5 -0.5 0.0

Point2 (Point2)

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

-0.5 0.5 0.0

XResolution (XResolution)

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

1

YResolution (YResolution)

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

1


Point Source

Create a point cloud of a certain size, radius, and center.The point source creates a specified number of points within a given radius about a specified center point.

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

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

0.0 0.0 0.0

NumberOfPoints (NumberOfPoints)

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

1

Radius (Radius)

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

0.0


Programmable Source

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

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

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

0

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

  • vtkPolyData (0)
  • vtkStructuredGrid (2)
  • vtkRectilinearGrid (3)
  • vtkUnstructuredGrid (4)
  • vtkImageData (6)
  • vtkMultiblockDataSet (13)
  • vtkHierarchicalBoxDataSet (15)
  • vtkTable (19)
Script (Script)

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

Script (RequestInformation) (InformationScript)

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

Parameters (Parameters)
PythonPath (PythonPath)

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


Ruler

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

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

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

-0.5 0.0 0.0

Point2 (Point2)

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

0.5 0.0 0.0


SelectionQuerySource

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

The location of the array the selection came from (ex, point, cell).

0

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

  • CELL (0)
  • POINT (1)
  • FIELD (2)
  • VERTEX (3)
  • EDGE (4)
  • ROW (5)
QueryString (QueryString)
CompositeIndex (CompositeIndex)

-1

HierarchicalLevel (HierarchicalLevel)

-1

HierarchicalIndex (HierarchicalIndex)

-1

ProcessID (ProcessID)

-1

UserFriendlyText (UserFriendlyText)

Reconstructs the query as a user friendly text eg. "IDs >= 12".


SelectionSourceBase

Internal proxy used to define the common API for Selection Source proxies. Do not use.

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

The location of the array the selection came from (ex, point, cell).

0

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

  • CELL (0)
  • POINT (1)
  • FIELD (2)
  • VERTEX (3)
  • EDGE (4)
  • ROW (5)
ContainingCells (ContainingCells)

When field type is POINT, this controls whether single vertex cells will be produced for each selected point, or whether the cells that contain each selected point will be produced. When field type is CELL this has no effect.

0

Accepts boolean values (0 or 1).

InsideOut (InsideOut)

When this property is false the selection describes everything that should be extracted. When this is true the selection describes everything that should NOT be extracted.

0

Accepts boolean values (0 or 1).

Sphere

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

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

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

0.0 0.0 0.0

Radius (Radius)

This property specifies the radius of the sphere.

0.5

ThetaResolution (ThetaResolution)

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

8

StartTheta (StartTheta)

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

0

EndTheta (EndTheta)

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

360

PhiResolution (PhiResolution)

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

8

StartPhi (StartPhi)

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

0

EndPhi (EndPhi)

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

180


SplineSource

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

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

Property used to reference the parametric function as data generator.

The value can be one of the following:

  • Spline (parametric_functions)


Superquadric

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

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

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

0.0 0.0 0.0

Scale (Scale)

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

1.0 1.0 1.0

ThetaResolution (ThetaResolution)

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

16

PhiResolution (PhiResolution)

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

16

Thickness (Thickness)

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

0.3333

ThetaRoundness (ThetaRoundness)

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

1

PhiRoundness (PhiRoundness)

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

1

Size (Size)

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

0.5

Toroidal (Toroidal)

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

1

Accepts boolean values (0 or 1).

Test3DWidget

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

Set the number of faces used to generate the cone.

6


Text

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

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

This property specifies the text to display.

Text


ThresholdSelectionSource

ThresholdSelectionSource is used to create a threshold based selection.

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

The list of thresholds that will be added to the selection produced by the selection source.

ArrayName (ArrayName)

For threshold and value selection, this controls the name of the scalar array that will be thresholded within.

none


Time Source

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

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

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

0

Accepts boolean values (0 or 1).

X Amplitude (X Amplitude)

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

0.0

Y Amplitude (Y Amplitude)

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

0.0

Growing (Growing)

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

0

Accepts boolean values (0 or 1).

TimestepValues (TimestepValues)


TrivialProducer

Property Description Default Value(s) Restrictions


Wavelet

Create a regular rectilinear grid in up to three dimensions with values varying according to a periodic function. The Wavelet source can be used to create a uniform rectilinear grid in up to three dimensions with values varying according to the following periodic function. OS = M * G * (XM * sin(XF * x) + YM * sin(YF * y) + ZM * cos(ZF

  • z)) OS is the output scalar; M represents the maximum

value; G represents the Gaussian; XM, YM, and ZM are the X, Y, and Z magnitude values; and XF, YF, and ZF are the X, Y, and Z frequency values. If a two-dimensional extent is specified, the resulting image will be displayed. If a three-dimensional extent is used, then the bounding box of the volume will be displayed.

Property Description Default Value(s) Restrictions
Whole Extent (WholeExtent)

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

-10 10 -10 10 -10 10

Center (Center)

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

0.0 0.0 0.0

Maximum (Maximum)

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

255.0

XFreq (XFreq)

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

60.0

YFreq (YFreq)

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

30.0

ZFreq (ZFreq)

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

40.0

XMag (XMag)

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

10.0

YMag (YMag)

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

18.0

ZMag (ZMag)

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

5.0

StandardDeviation (StandardDeviation)

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

0.5

SubsampleRate (SubsampleRate)

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

1


Retrieved from "https://public.kitware.com/Wiki/index.php?title=ParaView/Users_Guide/Sources&oldid=49260"