Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkThreshold Class Reference

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

#include <vtkThreshold.h>

Inheritance diagram for vtkThreshold:

Inheritance graph
[legend]
Collaboration diagram for vtkThreshold:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void ThresholdByLower (float lower)
void ThresholdByUpper (float upper)
void ThresholdBetween (float lower, float upper)
virtual float GetUpperThreshold ()
virtual float GetLowerThreshold ()
virtual void SetAttributeMode (int)
virtual int GetAttributeMode ()
void SetAttributeModeToDefault ()
void SetAttributeModeToUsePointData ()
void SetAttributeModeToUseCellData ()
const char * GetAttributeModeAsString ()
virtual void SetAllScalars (int)
virtual int GetAllScalars ()
virtual void AllScalarsOn ()
virtual void AllScalarsOff ()
virtual void SetArrayName (const char *)
virtual char * GetArrayName ()

Static Public Methods

vtkThreshold * New ()
int IsTypeOf (const char *type)
vtkThreshold * SafeDownCast (vtkObject *o)

Protected Methods

 vtkThreshold ()
 ~vtkThreshold ()
void Execute ()
int Lower (float s)
int Upper (float s)
int Between (float s)

Protected Attributes

int AllScalars
float LowerThreshold
float UpperThreshold
int AttributeMode
int(vtkThreshold::* ThresholdFunction )(float s)
char * ArrayName

Detailed Description

extracts cells where scalar value in cell satisfies threshold criterion.

Date:
2001/10/11 13:37:19
Revision:
1.40

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.

See also:
vtkThresholdPoints vtkThresholdTextureCoords
Examples:
vtkThreshold (Examples)
Tests:
vtkThreshold (Tests)

Definition at line 76 of file vtkThreshold.h.


Constructor & Destructor Documentation

vtkThreshold::vtkThreshold   [protected]
 

vtkThreshold::~vtkThreshold   [protected]
 


Member Function Documentation

vtkThreshold* vtkThreshold::New   [static]
 

Instantiate object with no start, end, or progress methods.

Reimplemented from vtkUnstructuredGridSource.

virtual const char* vtkThreshold::GetClassName   [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetToUnstructuredGridFilter.

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 vtkTypeMacro 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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetToUnstructuredGridFilter.

vtkThreshold* vtkThreshold::SafeDownCast vtkObject   o [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro 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 vtkSource.

void vtkThreshold::ThresholdByLower float    lower
 

Criterion is cells whose scalars are less or equal to lower threshold.

void vtkThreshold::ThresholdByUpper float    upper
 

Criterion is cells whose scalars are greater or equal to upper threshold.

void vtkThreshold::ThresholdBetween float    lower,
float    upper
 

Criterion is cells whose scalars are between lower and upper thresholds.

virtual float vtkThreshold::GetUpperThreshold   [virtual]
 

Get the Upper and Lower thresholds.

virtual float 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 110 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 112 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 114 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::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::SetArrayName const char *    [virtual]
 

If you want to threshold by an arbitrary array, then set its name here. By default this in NULL which implies use scalars.

virtual char* vtkThreshold::GetArrayName   [virtual]
 

If you want to threshold by an arbitrary array, then set its name here. By default this in NULL which implies use scalars.

void vtkThreshold::Execute   [protected, virtual]
 

This method is the old style execute method

Reimplemented from vtkSource.

int vtkThreshold::Lower float    s [inline, protected]
 

Definition at line 152 of file vtkThreshold.h.

int vtkThreshold::Upper float    s [inline, protected]
 

Definition at line 153 of file vtkThreshold.h.

int vtkThreshold::Between float    s [inline, protected]
 

Definition at line 154 of file vtkThreshold.h.


Member Data Documentation

int vtkThreshold::AllScalars [protected]
 

Definition at line 143 of file vtkThreshold.h.

float vtkThreshold::LowerThreshold [protected]
 

Definition at line 144 of file vtkThreshold.h.

float vtkThreshold::UpperThreshold [protected]
 

Definition at line 145 of file vtkThreshold.h.

int vtkThreshold::AttributeMode [protected]
 

Definition at line 146 of file vtkThreshold.h.

int(vtkThreshold::* vtkThreshold::ThresholdFunction)(float s) [protected]
 

char* vtkThreshold::ArrayName [protected]
 

Definition at line 157 of file vtkThreshold.h.


The documentation for this class was generated from the following file:
Generated on Thu Mar 28 14:43:55 2002 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001