vtkImageThreshold Class Reference

#include <vtkImageThreshold.h>

Inheritance diagram for vtkImageThreshold:

[legend]Collaboration diagram for vtkImageThreshold:

[legend]List of all members.

---

Detailed Description

Flexible threshold.

vtkImageThreshold Can do binary or continuous thresholding for lower, upper or a range of data. The output data type may be different than the output, but defaults to the same type.

Tests:

vtkImageThreshold (Tests)

Definition at line 32 of file vtkImageThreshold.h.

Public Types
typedef vtkThreadedImageAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	ThresholdByUpper (double thresh)
void	ThresholdByLower (double thresh)
void	ThresholdBetween (double lower, double upper)
virtual void	SetReplaceIn (int)
virtual int	GetReplaceIn ()
virtual void	ReplaceInOn ()
virtual void	ReplaceInOff ()
void	SetInValue (double val)
virtual double	GetInValue ()
virtual void	SetReplaceOut (int)
virtual int	GetReplaceOut ()
virtual void	ReplaceOutOn ()
virtual void	ReplaceOutOff ()
void	SetOutValue (double val)
virtual double	GetOutValue ()
virtual double	GetUpperThreshold ()
virtual double	GetLowerThreshold ()
virtual void	SetOutputScalarType (int)
virtual int	GetOutputScalarType ()
void	SetOutputScalarTypeToDouble ()
void	SetOutputScalarTypeToFloat ()
void	SetOutputScalarTypeToLong ()
void	SetOutputScalarTypeToUnsignedLong ()
void	SetOutputScalarTypeToInt ()
void	SetOutputScalarTypeToUnsignedInt ()
void	SetOutputScalarTypeToShort ()
void	SetOutputScalarTypeToUnsignedShort ()
void	SetOutputScalarTypeToChar ()
void	SetOutputScalarTypeToSignedChar ()
void	SetOutputScalarTypeToUnsignedChar ()
Static Public Member Functions
static vtkImageThreshold *	New ()
static int	IsTypeOf (const char *type)
static vtkImageThreshold *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkImageThreshold ()
	~vtkImageThreshold ()
virtual int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void	ThreadedRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int extent[6], int id)
Protected Attributes
double	UpperThreshold
double	LowerThreshold
int	ReplaceIn
double	InValue
int	ReplaceOut
double	OutValue
int	OutputScalarType

---

Member Typedef Documentation

typedef vtkThreadedImageAlgorithm vtkImageThreshold::Superclass

Reimplemented from vtkThreadedImageAlgorithm. Definition at line 36 of file vtkImageThreshold.h.

---

Constructor & Destructor Documentation

vtkImageThreshold::vtkImageThreshold (   )  [protected]

vtkImageThreshold::~vtkImageThreshold (   )  [inline, protected]

Definition at line 110 of file vtkImageThreshold.h.

---

Member Function Documentation

static vtkImageThreshold* vtkImageThreshold::New (   )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on. Reimplemented from vtkAlgorithm.

virtual const char* vtkImageThreshold::GetClassName (   )  [virtual]

Reimplemented from vtkThreadedImageAlgorithm.

static int vtkImageThreshold::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 vtkThreadedImageAlgorithm.

virtual int vtkImageThreshold::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 vtkThreadedImageAlgorithm.

static vtkImageThreshold* vtkImageThreshold::SafeDownCast (  vtkObject *  o  )  [static]

Reimplemented from vtkThreadedImageAlgorithm.

void vtkImageThreshold::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 vtkThreadedImageAlgorithm.

void vtkImageThreshold::ThresholdByUpper (  double  thresh  )

The values greater than or equal to the value match.

void vtkImageThreshold::ThresholdByLower (  double  thresh  )

The values less than or equal to the value match.

void vtkImageThreshold::ThresholdBetween (  double  lower, double  upper )

The values in a range (inclusive) match

virtual void vtkImageThreshold::SetReplaceIn (  int   )  [virtual]

Determines whether to replace the pixel in range with InValue

virtual int vtkImageThreshold::GetReplaceIn (   )  [virtual]

The values in a range (inclusive) match

virtual void vtkImageThreshold::ReplaceInOn (   )  [virtual]

The values in a range (inclusive) match

virtual void vtkImageThreshold::ReplaceInOff (   )  [virtual]

The values in a range (inclusive) match

void vtkImageThreshold::SetInValue (  double  val  )

Replace the in range pixels with this value.

virtual double vtkImageThreshold::GetInValue (   )  [virtual]

Replace the in range pixels with this value.

virtual void vtkImageThreshold::SetReplaceOut (  int   )  [virtual]

Determines whether to replace the pixel out of range with OutValue

virtual int vtkImageThreshold::GetReplaceOut (   )  [virtual]

Determines whether to replace the pixel out of range with OutValue

virtual void vtkImageThreshold::ReplaceOutOn (   )  [virtual]

Determines whether to replace the pixel out of range with OutValue

virtual void vtkImageThreshold::ReplaceOutOff (   )  [virtual]

Determines whether to replace the pixel out of range with OutValue

void vtkImageThreshold::SetOutValue (  double  val  )

Replace the in range pixels with this value.

virtual double vtkImageThreshold::GetOutValue (   )  [virtual]

Replace the in range pixels with this value.

virtual double vtkImageThreshold::GetUpperThreshold (   )  [virtual]

Get the Upper and Lower thresholds.

virtual double vtkImageThreshold::GetLowerThreshold (   )  [virtual]

Get the Upper and Lower thresholds.

virtual void vtkImageThreshold::SetOutputScalarType (  int   )  [virtual]

Set the desired output scalar type to cast to

virtual int vtkImageThreshold::GetOutputScalarType (   )  [virtual]

Set the desired output scalar type to cast to

void vtkImageThreshold::SetOutputScalarTypeToDouble (   )  [inline]

Set the desired output scalar type to cast to Definition at line 84 of file vtkImageThreshold.h. References VTK_DOUBLE.

void vtkImageThreshold::SetOutputScalarTypeToFloat (   )  [inline]

Set the desired output scalar type to cast to Definition at line 86 of file vtkImageThreshold.h. References VTK_FLOAT.

void vtkImageThreshold::SetOutputScalarTypeToLong (   )  [inline]

Set the desired output scalar type to cast to Definition at line 88 of file vtkImageThreshold.h. References VTK_LONG.

void vtkImageThreshold::SetOutputScalarTypeToUnsignedLong (   )  [inline]

Set the desired output scalar type to cast to Definition at line 90 of file vtkImageThreshold.h. References VTK_UNSIGNED_LONG.

void vtkImageThreshold::SetOutputScalarTypeToInt (   )  [inline]

Set the desired output scalar type to cast to Definition at line 92 of file vtkImageThreshold.h. References VTK_INT.

void vtkImageThreshold::SetOutputScalarTypeToUnsignedInt (   )  [inline]

Set the desired output scalar type to cast to Definition at line 94 of file vtkImageThreshold.h. References VTK_UNSIGNED_INT.

void vtkImageThreshold::SetOutputScalarTypeToShort (   )  [inline]

Set the desired output scalar type to cast to Definition at line 96 of file vtkImageThreshold.h. References VTK_SHORT.

void vtkImageThreshold::SetOutputScalarTypeToUnsignedShort (   )  [inline]

Set the desired output scalar type to cast to Definition at line 98 of file vtkImageThreshold.h. References VTK_UNSIGNED_SHORT.

void vtkImageThreshold::SetOutputScalarTypeToChar (   )  [inline]

Set the desired output scalar type to cast to Definition at line 100 of file vtkImageThreshold.h. References VTK_CHAR.

void vtkImageThreshold::SetOutputScalarTypeToSignedChar (   )  [inline]

Set the desired output scalar type to cast to Definition at line 102 of file vtkImageThreshold.h. References VTK_SIGNED_CHAR.

void vtkImageThreshold::SetOutputScalarTypeToUnsignedChar (   )  [inline]

Set the desired output scalar type to cast to Definition at line 104 of file vtkImageThreshold.h. References VTK_UNSIGNED_CHAR.

virtual int vtkImageThreshold::RequestInformation (  vtkInformation *  , vtkInformationVector **  , vtkInformationVector *  )  [protected, virtual]

Reimplemented from vtkImageAlgorithm.

void vtkImageThreshold::ThreadedRequestData (  vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector, vtkImageData ***  inData, vtkImageData **  outData, int  extent[6], int  id )  [protected, virtual]

If the subclass does not define an Execute method, then the task will be broken up, multiple threads will be spawned, and each thread will call this method. It is public so that the thread functions can call this method. Reimplemented from vtkThreadedImageAlgorithm.

---

Member Data Documentation

double vtkImageThreshold::UpperThreshold [protected]

Definition at line 110 of file vtkImageThreshold.h.

double vtkImageThreshold::LowerThreshold [protected]

Definition at line 113 of file vtkImageThreshold.h.

int vtkImageThreshold::ReplaceIn [protected]

Definition at line 114 of file vtkImageThreshold.h.

double vtkImageThreshold::InValue [protected]

Definition at line 115 of file vtkImageThreshold.h.

int vtkImageThreshold::ReplaceOut [protected]

Definition at line 116 of file vtkImageThreshold.h.

double vtkImageThreshold::OutValue [protected]

Definition at line 117 of file vtkImageThreshold.h.

int vtkImageThreshold::OutputScalarType [protected]

Definition at line 119 of file vtkImageThreshold.h.

---

The documentation for this class was generated from the following file:

• dox/Imaging/vtkImageThreshold.h

---