extracts cells where scalar value in cell satisfies threshold criterion More...

#include <vtkThreshold.h>

Inheritance diagram for vtkThreshold:

Collaboration diagram for vtkThreshold:

Public Types
typedef vtkUnstructuredGridAlgorithm	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkThreshold *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	ThresholdByLower (double lower)
void	ThresholdByUpper (double upper)
void	ThresholdBetween (double lower, double upper)
virtual int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual double	GetUpperThreshold ()
virtual double	GetLowerThreshold ()

virtual void	SetAttributeMode (int)
virtual int	GetAttributeMode ()
void	SetAttributeModeToDefault ()
void	SetAttributeModeToUsePointData ()
void	SetAttributeModeToUseCellData ()
const char *	GetAttributeModeAsString ()

virtual void	SetComponentMode (int)
virtual int	GetComponentMode ()
void	SetComponentModeToUseSelected ()
void	SetComponentModeToUseAll ()
void	SetComponentModeToUseAny ()
const char *	GetComponentModeAsString ()

virtual void	SetSelectedComponent (int)
virtual int	GetSelectedComponent ()

virtual void	SetAllScalars (int)
virtual int	GetAllScalars ()
virtual void	AllScalarsOn ()
virtual void	AllScalarsOff ()

virtual void	SetUseContinuousCellRange (int)
virtual int	GetUseContinuousCellRange ()
virtual void	UseContinuousCellRangeOn ()
virtual void	UseContinuousCellRangeOff ()

void	SetPointsDataTypeToDouble ()
void	SetPointsDataTypeToFloat ()
void	SetPointsDataType (int type)
int	GetPointsDataType ()

void	SetOutputPointsPrecision (int precision)
int	GetOutputPointsPrecision () const
Static Public Member Functions
static vtkThreshold *	New ()
static int	IsTypeOf (const char *type)
static vtkThreshold *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkThreshold ()
	~vtkThreshold ()
virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual int	FillInputPortInformation (int port, vtkInformation *info)
int	Lower (double s)
int	Upper (double s)
int	Between (double s)
int	EvaluateComponents (vtkDataArray *scalars, vtkIdType id)
int	EvaluateCell (vtkDataArray scalars, vtkIdList cellPts, int numCellPts)
int	EvaluateCell (vtkDataArray scalars, int c, vtkIdList cellPts, int numCellPts)
Protected Attributes
int	AllScalars
double	LowerThreshold
double	UpperThreshold
int	AttributeMode
int	ComponentMode
int	SelectedComponent
int	OutputPointsPrecision
int	UseContinuousCellRange
int(vtkThreshold::*	ThresholdFunction )(double s)

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

Examples:: vtkThreshold (Examples)

Tests:: vtkThreshold (Tests)

Definition at line 60 of file vtkThreshold.h.

Member Typedef Documentation

typedef vtkUnstructuredGridAlgorithm vtkThreshold::Superclass

Reimplemented from vtkUnstructuredGridAlgorithm.

Definition at line 64 of file vtkThreshold.h.

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.

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 ( vtkObjectBase * o ) [static]

Reimplemented from vtkUnstructuredGridAlgorithm.

virtual vtkObjectBase* vtkThreshold::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkUnstructuredGridAlgorithm.

vtkThreshold* vtkThreshold::NewInstance ( ) const

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 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]

Set the data type of the output points (See the data types defined in vtkType.h). The default data type is float. These methods are deprecated. Please use the SetOutputPointsPrecision() and GetOutputPointsPrecision() methods instead.

Definition at line 157 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. These methods are deprecated. Please use the SetOutputPointsPrecision() and GetOutputPointsPrecision() methods instead.

Definition at line 158 of file vtkThreshold.h.

void vtkThreshold::SetPointsDataType ( int type )

Set the data type of the output points (See the data types defined in vtkType.h). The default data type is float. These methods are deprecated. Please use the SetOutputPointsPrecision() and GetOutputPointsPrecision() methods instead.

int vtkThreshold::GetPointsDataType ( )

Set the data type of the output points (See the data types defined in vtkType.h). The default data type is float. These methods are deprecated. Please use the SetOutputPointsPrecision() and GetOutputPointsPrecision() methods instead.

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]`

see vtkAlgorithm for details

Reimplemented from vtkUnstructuredGridAlgorithm.

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.

int vtkThreshold::Lower ( double s ) [inline, protected]