extracts cells where scalar value in cell satisfies threshold criterion
More...
#include <vtkThreshold.h>
Inherits vtkUnstructuredGridAlgorithm.
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
- Examples:
- vtkThreshold (Examples)
- Tests:
- vtkThreshold (Tests)
Definition at line 60 of file vtkThreshold.h.
vtkThreshold::vtkThreshold |
( |
| ) |
|
|
protected |
vtkThreshold::~vtkThreshold |
( |
| ) |
|
|
protected |
static int vtkThreshold::IsTypeOf |
( |
const char * |
type | ) |
|
|
static |
virtual int vtkThreshold::IsA |
( |
const char * |
type | ) |
|
|
virtual |
static vtkThreshold* vtkThreshold::SafeDownCast |
( |
vtkObjectBase * |
o | ) |
|
|
static |
virtual vtkObjectBase* vtkThreshold::NewInstanceInternal |
( |
| ) |
const |
|
protectedvirtual |
void vtkThreshold::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
| |
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 94 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 96 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 98 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 114 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 116 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 118 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.
virtual void vtkThreshold::SetUseContinuousCellRange |
( |
int |
| ) |
|
|
virtual |
If this is on (default is off), we will use the continuous interval [minimum cell scalar, maxmimum cell scalar] to intersect the threshold bound , rather than the set of discrete scalar values from the vertices WARNING: For higher order cells, the scalar range of the cell is not the same as the vertex scalar interval used here, so the result will not be accurate.
virtual int vtkThreshold::GetUseContinuousCellRange |
( |
| ) |
|
|
virtual |
If this is on (default is off), we will use the continuous interval [minimum cell scalar, maxmimum cell scalar] to intersect the threshold bound , rather than the set of discrete scalar values from the vertices WARNING: For higher order cells, the scalar range of the cell is not the same as the vertex scalar interval used here, so the result will not be accurate.
virtual void vtkThreshold::UseContinuousCellRangeOn |
( |
| ) |
|
|
virtual |
If this is on (default is off), we will use the continuous interval [minimum cell scalar, maxmimum cell scalar] to intersect the threshold bound , rather than the set of discrete scalar values from the vertices WARNING: For higher order cells, the scalar range of the cell is not the same as the vertex scalar interval used here, so the result will not be accurate.
virtual void vtkThreshold::UseContinuousCellRangeOff |
( |
| ) |
|
|
virtual |
If this is on (default is off), we will use the continuous interval [minimum cell scalar, maxmimum cell scalar] to intersect the threshold bound , rather than the set of discrete scalar values from the vertices WARNING: For higher order cells, the scalar range of the cell is not the same as the vertex scalar interval used here, so the result will not be accurate.
void vtkThreshold::SetPointsDataTypeToDouble |
( |
| ) |
|
|
inline |
void vtkThreshold::SetPointsDataTypeToFloat |
( |
| ) |
|
|
inline |
void vtkThreshold::SetPointsDataType |
( |
int |
type | ) |
|
int vtkThreshold::GetPointsDataType |
( |
| ) |
|
void vtkThreshold::SetOutputPointsPrecision |
( |
int |
precision | ) |
|
Set/get the desired precision for the output types. See the documentation for the vtkAlgorithm::DesiredOutputPrecision enum for an explanation of the available precision settings.
int vtkThreshold::GetOutputPointsPrecision |
( |
| ) |
const |
Set/get the desired precision for the output types. See the documentation for the vtkAlgorithm::DesiredOutputPrecision enum for an explanation of the available precision settings.
virtual int vtkThreshold::ProcessRequest |
( |
vtkInformation * |
, |
|
|
vtkInformationVector ** |
, |
|
|
vtkInformationVector * |
|
|
) |
| |
|
virtual |
virtual int vtkThreshold::RequestData |
( |
vtkInformation * |
, |
|
|
vtkInformationVector ** |
, |
|
|
vtkInformationVector * |
|
|
) |
| |
|
protectedvirtual |
virtual int vtkThreshold::FillInputPortInformation |
( |
int |
port, |
|
|
vtkInformation * |
info |
|
) |
| |
|
protectedvirtual |
int vtkThreshold::Lower |
( |
double |
s | ) |
|
|
inlineprotected |
int vtkThreshold::Upper |
( |
double |
s | ) |
|
|
inlineprotected |
int vtkThreshold::Between |
( |
double |
s | ) |
|
|
inlineprotected |
int vtkThreshold::EvaluateComponents |
( |
vtkDataArray * |
scalars, |
|
|
vtkIdType |
id |
|
) |
| |
|
protected |
int vtkThreshold::EvaluateCell |
( |
vtkDataArray * |
scalars, |
|
|
vtkIdList * |
cellPts, |
|
|
int |
numCellPts |
|
) |
| |
|
protected |
int vtkThreshold::EvaluateCell |
( |
vtkDataArray * |
scalars, |
|
|
int |
c, |
|
|
vtkIdList * |
cellPts, |
|
|
int |
numCellPts |
|
) |
| |
|
protected |
int vtkThreshold::AllScalars |
|
protected |
double vtkThreshold::LowerThreshold |
|
protected |
double vtkThreshold::UpperThreshold |
|
protected |
int vtkThreshold::AttributeMode |
|
protected |
int vtkThreshold::ComponentMode |
|
protected |
int vtkThreshold::SelectedComponent |
|
protected |
int vtkThreshold::OutputPointsPrecision |
|
protected |
int vtkThreshold::UseContinuousCellRange |
|
protected |
int(vtkThreshold::* vtkThreshold::ThresholdFunction)(double s) |
|
protected |
The documentation for this class was generated from the following file: