vtkThreshold Class Reference
#include <vtkThreshold.h>
Detailed Description
extracts cells where scalar value in cell satisfies threshold criterionvtkThreshold 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.
- Examples:
- vtkThreshold (Examples)
- Tests:
- vtkThreshold (Tests)
Definition at line 58 of file vtkThreshold.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkThreshold::vtkThreshold | ( | ) | [protected] |
| vtkThreshold::~vtkThreshold | ( | ) | [protected] |
Member Function Documentation
| static vtkThreshold* vtkThreshold::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkUnstructuredGridAlgorithm.
| virtual const char* vtkThreshold::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkUnstructuredGridAlgorithm.
| static int vtkThreshold::IsTypeOf | ( | const char * | name | ) | [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 vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkUnstructuredGridAlgorithm.
| virtual int vtkThreshold::IsA | ( | const char * | name | ) | [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 vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkUnstructuredGridAlgorithm.
| static vtkThreshold* vtkThreshold::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkUnstructuredGridAlgorithm.
| 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 vtkUnstructuredGridAlgorithm.
| 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 92 of file vtkThreshold.h.
| 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 94 of file vtkThreshold.h.
| 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 96 of file vtkThreshold.h.
| 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 112 of file vtkThreshold.h.
| 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 114 of file vtkThreshold.h.
| 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 116 of file vtkThreshold.h.
| 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.
| void vtkThreshold::SetPointsDataTypeToDouble | ( | ) | [inline] |
Set the data type of the output points (See the data types defined in vtkType.h). The default data type is float.
Definition at line 141 of file vtkThreshold.h.
| void vtkThreshold::SetPointsDataTypeToFloat | ( | ) | [inline] |
Set the data type of the output points (See the data types defined in vtkType.h). The default data type is float.
Definition at line 142 of file vtkThreshold.h.
| virtual void vtkThreshold::SetPointsDataType | ( | int | ) | [virtual] |
Set the data type of the output points (See the data types defined in vtkType.h). The default data type is float.
| virtual int vtkThreshold::GetPointsDataType | ( | ) | [virtual] |
Set the data type of the output points (See the data types defined in vtkType.h). The default data type is float.
| virtual int vtkThreshold::RequestData | ( | vtkInformation * | request, | |
| vtkInformationVector ** | inputVector, | |||
| vtkInformationVector * | outputVector | |||
| ) | [protected, virtual] |
This is called by the superclass. This is the method you should override.
Reimplemented from vtkUnstructuredGridAlgorithm.
| virtual int vtkThreshold::FillInputPortInformation | ( | int | port, | |
| vtkInformation * | info | |||
| ) | [protected, virtual] |
Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.
Reimplemented from vtkUnstructuredGridAlgorithm.
| virtual int vtkThreshold::ProcessRequest | ( | vtkInformation * | , | |
| vtkInformationVector ** | , | |||
| vtkInformationVector * | ||||
| ) | [protected, virtual] |
see vtkAlgorithm for details
Reimplemented from vtkUnstructuredGridAlgorithm.
| int vtkThreshold::Lower | ( | double | s | ) | [inline, protected] |
Definition at line 170 of file vtkThreshold.h.
| int vtkThreshold::Upper | ( | double | s | ) | [inline, protected] |
Definition at line 171 of file vtkThreshold.h.
| int vtkThreshold::Between | ( | double | s | ) | [inline, protected] |
Definition at line 172 of file vtkThreshold.h.
| int vtkThreshold::EvaluateComponents | ( | vtkDataArray * | scalars, | |
| vtkIdType | id | |||
| ) | [protected] |
Member Data Documentation
int vtkThreshold::AllScalars [protected] |
Definition at line 158 of file vtkThreshold.h.
double vtkThreshold::LowerThreshold [protected] |
Definition at line 159 of file vtkThreshold.h.
double vtkThreshold::UpperThreshold [protected] |
Definition at line 160 of file vtkThreshold.h.
int vtkThreshold::AttributeMode [protected] |
Definition at line 161 of file vtkThreshold.h.
int vtkThreshold::ComponentMode [protected] |
Definition at line 162 of file vtkThreshold.h.
int vtkThreshold::SelectedComponent [protected] |
Definition at line 163 of file vtkThreshold.h.
int vtkThreshold::PointsDataType [protected] |
Definition at line 164 of file vtkThreshold.h.
int(vtkThreshold::* vtkThreshold::ThresholdFunction)(double s) [protected] |
The documentation for this class was generated from the following file:
- dox/Graphics/vtkThreshold.h
