vtkThreshold Class Reference
#include <vtkThreshold.h>
Inheritance diagram for vtkThreshold:
[legend]Collaboration diagram for vtkThreshold:
[legend]List of all members.
Detailed Description
extracts cells where scalar value in cell satisfies threshold criterion
vtkThreshold is a filter that extracts cells from any dataset type that satisfy a threshold criterion. A cell satisfies the criterion if the scalar value of (every or any) point satisfies the criterion. The criterion can take three forms: 1) greater than a particular value; 2) less than a particular value; or 3) between two values. The output of this filter is an unstructured grid.
Note that scalar values are available from the point and cell attribute data. By default, point data is used to obtain scalars, but you can control this behavior. See the AttributeMode ivar below.
By default only the first scalar value is used in the decision. Use the ComponentMode and SelectedComponent ivars to control this behavior.
- See also:
- vtkThresholdPoints vtkThresholdTextureCoords
- Created by:
-
- CVS contributions (if > 5%):
- Law, Charles (34%)
- Schroeder, Will (30%)
- Martin, Ken (13%)
- Avila, Lisa (8%)
- Geveci, Berk (5%)
- CVS logs (CVSweb):
/Graphics/vtkThreshold.h)/Graphics/vtkThreshold.cxx)
- Examples:
- vtkThreshold (Examples)
- Tests:
- vtkThreshold (Tests)
Definition at line 72 of file vtkThreshold.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkThreshold::vtkThreshold |
( |
|
) |
[protected] |
|
Member Function Documentation
|
|
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkAlgorithm. |
| virtual const char* vtkThreshold::GetClassName |
( |
|
) |
[virtual] |
|
| int vtkThreshold::IsTypeOf |
( |
const char * |
type |
) |
[static] |
|
|
|
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkDataSetToUnstructuredGridFilter. |
| virtual int vtkThreshold::IsA |
( |
const char * |
type |
) |
[virtual] |
|
|
|
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkDataSetToUnstructuredGridFilter. |
| void vtkThreshold::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
[virtual] |
|
|
|
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkDataSetToUnstructuredGridFilter. |
| void vtkThreshold::ThresholdByLower |
( |
double |
lower |
) |
|
|
|
|
Criterion is cells whose scalars are less or equal to lower threshold. |
| void vtkThreshold::ThresholdByUpper |
( |
double |
upper |
) |
|
|
|
|
Criterion is cells whose scalars are greater or equal to upper threshold. |
| void vtkThreshold::ThresholdBetween |
( |
double |
lower, |
|
|
double |
upper |
|
) |
|
|
|
|
Criterion is cells whose scalars are between lower and upper thresholds (inclusive of the end values). |
| virtual double vtkThreshold::GetUpperThreshold |
( |
|
) |
[virtual] |
|
|
|
Get the Upper and Lower thresholds. |
| virtual double vtkThreshold::GetLowerThreshold |
( |
|
) |
[virtual] |
|
|
|
Get the Upper and Lower thresholds. |
| virtual void vtkThreshold::SetAttributeMode |
( |
int |
|
) |
[virtual] |
|
|
|
Control how the filter works with scalar point data and cell attribute data. By default (AttributeModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData). |
| virtual int vtkThreshold::GetAttributeMode |
( |
|
) |
[virtual] |
|
|
|
Control how the filter works with scalar point data and cell attribute data. By default (AttributeModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData). |
| void vtkThreshold::SetAttributeModeToDefault |
( |
|
) |
[inline] |
|
|
|
Control how the filter works with scalar point data and cell attribute data. By default (AttributeModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData).
Definition at line 106 of file vtkThreshold.h.
References VTK_ATTRIBUTE_MODE_DEFAULT. |
| void vtkThreshold::SetAttributeModeToUsePointData |
( |
|
) |
[inline] |
|
|
|
Control how the filter works with scalar point data and cell attribute data. By default (AttributeModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData).
Definition at line 108 of file vtkThreshold.h.
References VTK_ATTRIBUTE_MODE_USE_POINT_DATA. |
| void vtkThreshold::SetAttributeModeToUseCellData |
( |
|
) |
[inline] |
|
|
|
Control how the filter works with scalar point data and cell attribute data. By default (AttributeModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData).
Definition at line 110 of file vtkThreshold.h.
References VTK_ATTRIBUTE_MODE_USE_CELL_DATA. |
| const char* vtkThreshold::GetAttributeModeAsString |
( |
|
) |
|
|
|
|
Control how the filter works with scalar point data and cell attribute data. By default (AttributeModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData). |
| virtual void vtkThreshold::SetComponentMode |
( |
int |
|
) |
[virtual] |
|
|
|
Control how the decision of in / out is made with multi-component data. The choices are to use the selected component (specified in the SelectedComponent ivar), or to look at all components. When looking at all components, the evaluation can pass if all the components satisfy the rule (UseAll) or if any satisfy is (UseAny). The default value is UseSelected. |
| virtual int vtkThreshold::GetComponentMode |
( |
|
) |
[virtual] |
|
|
|
Control how the decision of in / out is made with multi-component data. The choices are to use the selected component (specified in the SelectedComponent ivar), or to look at all components. When looking at all components, the evaluation can pass if all the components satisfy the rule (UseAll) or if any satisfy is (UseAny). The default value is UseSelected. |
| void vtkThreshold::SetComponentModeToUseSelected |
( |
|
) |
[inline] |
|
|
|
Control how the decision of in / out is made with multi-component data. The choices are to use the selected component (specified in the SelectedComponent ivar), or to look at all components. When looking at all components, the evaluation can pass if all the components satisfy the rule (UseAll) or if any satisfy is (UseAny). The default value is UseSelected.
Definition at line 126 of file vtkThreshold.h.
References VTK_COMPONENT_MODE_USE_SELECTED. |
| void vtkThreshold::SetComponentModeToUseAll |
( |
|
) |
[inline] |
|
|
|
Control how the decision of in / out is made with multi-component data. The choices are to use the selected component (specified in the SelectedComponent ivar), or to look at all components. When looking at all components, the evaluation can pass if all the components satisfy the rule (UseAll) or if any satisfy is (UseAny). The default value is UseSelected.
Definition at line 128 of file vtkThreshold.h.
References VTK_COMPONENT_MODE_USE_ALL. |
| void vtkThreshold::SetComponentModeToUseAny |
( |
|
) |
[inline] |
|
|
|
Control how the decision of in / out is made with multi-component data. The choices are to use the selected component (specified in the SelectedComponent ivar), or to look at all components. When looking at all components, the evaluation can pass if all the components satisfy the rule (UseAll) or if any satisfy is (UseAny). The default value is UseSelected.
Definition at line 130 of file vtkThreshold.h.
References VTK_COMPONENT_MODE_USE_ANY. |
| const char* vtkThreshold::GetComponentModeAsString |
( |
|
) |
|
|
|
|
Control how the decision of in / out is made with multi-component data. The choices are to use the selected component (specified in the SelectedComponent ivar), or to look at all components. When looking at all components, the evaluation can pass if all the components satisfy the rule (UseAll) or if any satisfy is (UseAny). The default value is UseSelected. |
| virtual void vtkThreshold::SetSelectedComponent |
( |
int |
|
) |
[virtual] |
|
|
|
When the component mode is UseSelected, this ivar indicated the selected component. The default value is 0. |
| virtual int vtkThreshold::GetSelectedComponent |
( |
|
) |
[virtual] |
|
|
|
When the component mode is UseSelected, this ivar indicated the selected component. The default value is 0. |
| virtual void vtkThreshold::SetAllScalars |
( |
int |
|
) |
[virtual] |
|
|
|
If using scalars from point data, all scalars for all points in a cell must satisfy the threshold criterion if AllScalars is set. Otherwise, just a single scalar value satisfying the threshold criterion enables will extract the cell. |
| virtual int vtkThreshold::GetAllScalars |
( |
|
) |
[virtual] |
|
|
|
If using scalars from point data, all scalars for all points in a cell must satisfy the threshold criterion if AllScalars is set. Otherwise, just a single scalar value satisfying the threshold criterion enables will extract the cell. |
| virtual void vtkThreshold::AllScalarsOn |
( |
|
) |
[virtual] |
|
|
|
If using scalars from point data, all scalars for all points in a cell must satisfy the threshold criterion if AllScalars is set. Otherwise, just a single scalar value satisfying the threshold criterion enables will extract the cell. |
| virtual void vtkThreshold::AllScalarsOff |
( |
|
) |
[virtual] |
|
|
|
If using scalars from point data, all scalars for all points in a cell must satisfy the threshold criterion if AllScalars is set. Otherwise, just a single scalar value satisfying the threshold criterion enables will extract the cell. |
| virtual char* vtkThreshold::GetInputScalarsSelection |
( |
|
) |
[virtual] |
|
|
|
If you want to threshold by an arbitrary array, then set its name here. By default this in NULL and the filter will use the active scalar array. |
| virtual void vtkThreshold::SelectInputScalars |
( |
const char * |
fieldName |
) |
[inline, virtual] |
|
|
|
If you want to threshold by an arbitrary array, then set its name here. By default this in NULL and the filter will use the active scalar array.
Definition at line 157 of file vtkThreshold.h. |
| void vtkThreshold::Execute |
( |
|
) |
[protected, virtual] |
|
|
|
This method is the old style execute method
Reimplemented from vtkSource. |
| int vtkThreshold::Lower |
( |
double |
s |
) |
[inline, protected] |
|
| int vtkThreshold::Upper |
( |
double |
s |
) |
[inline, protected] |
|
| int vtkThreshold::Between |
( |
double |
s |
) |
[inline, protected] |
|
| virtual void vtkThreshold::SetInputScalarsSelection |
( |
const char * |
|
) |
[protected, virtual] |
|
Member Data Documentation
The documentation for this class was generated from the following file: