---

vtkImageThreshold Class Reference

Flexible threshold. More...

#include <vtkImageThreshold.h>

Inheritance diagram for vtkImageThreshold:

[legend]Collaboration diagram for vtkImageThreshold:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	ThresholdByUpper (float thresh)
void	ThresholdByLower (float thresh)
void	ThresholdBetween (float lower, float upper)
virtual void	SetReplaceIn (int)
virtual int	GetReplaceIn ()
virtual void	ReplaceInOn ()
virtual void	ReplaceInOff ()
void	SetInValue (float val)
virtual float	GetInValue ()
virtual void	SetReplaceOut (int)
virtual int	GetReplaceOut ()
virtual void	ReplaceOutOn ()
virtual void	ReplaceOutOff ()
void	SetOutValue (float val)
virtual float	GetOutValue ()
virtual float	GetUpperThreshold ()
virtual float	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	SetOutputScalarTypeToUnsignedChar ()
Static Public Methods
vtkImageThreshold *	New ()
int	IsTypeOf (const char *type)
vtkImageThreshold *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkImageThreshold ()
	~vtkImageThreshold ()
	vtkImageThreshold (const vtkImageThreshold &)
void	operator= (const vtkImageThreshold &)
void	ExecuteInformation (vtkImageData *inData, vtkImageData *outData)
void	ExecuteInformation ()
void	ThreadedExecute (vtkImageData *inData, vtkImageData *outData, int extent[6], int id)
Protected Attributes
float	UpperThreshold
float	LowerThreshold
int	ReplaceIn
float	InValue
int	ReplaceOut
float	OutValue
int	OutputScalarType

---

Detailed Description

Flexible threshold.

Date:

2000/12/10 20:09:11

Revision:

1.27

Thanks:

Thanks to C. Charles Law who developed this class.

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.

Examples:

vtkImageThreshold (examples)

Definition at line 61 of file vtkImageThreshold.h.

---

Constructor & Destructor Documentation

vtkImageThreshold::vtkImageThreshold (    )  [protected]

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

Definition at line 125 of file vtkImageThreshold.h.

vtkImageThreshold::vtkImageThreshold (  const vtkImageThreshold &    )  [inline, protected]

Definition at line 126 of file vtkImageThreshold.h.

---

Member Function Documentation

vtkImageThreshold* vtkImageThreshold::New (    )  [static]

Instantiate object with no start, end, or progress methods. Reimplemented from vtkImageToImageFilter.

virtual const char* vtkImageThreshold::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 vtkImageToImageFilter.

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

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

vtkImageThreshold* vtkImageThreshold::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 vtkImageToImageFilter.

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 vtkImageToImageFilter.

void vtkImageThreshold::ThresholdByUpper (  float    thresh )

The values greater than or equal to the value match.

void vtkImageThreshold::ThresholdByLower (  float    thresh )

The values less than or equal to the value match.

void vtkImageThreshold::ThresholdBetween (  float    lower, float    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]

virtual void vtkImageThreshold::ReplaceInOn (    )  [virtual]

virtual void vtkImageThreshold::ReplaceInOff (    )  [virtual]

void vtkImageThreshold::SetInValue (  float    val )

Replace the in range pixels with this value.

virtual float vtkImageThreshold::GetInValue (    )  [virtual]

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

Determines whether to replace the pixel out of range with OutValue

virtual int vtkImageThreshold::GetReplaceOut (    )  [virtual]

virtual void vtkImageThreshold::ReplaceOutOn (    )  [virtual]

virtual void vtkImageThreshold::ReplaceOutOff (    )  [virtual]

void vtkImageThreshold::SetOutValue (  float    val )

Replace the in range pixels with this value.

virtual float vtkImageThreshold::GetOutValue (    )  [virtual]

virtual float vtkImageThreshold::GetUpperThreshold (    )  [virtual]

Get the Upper and Lower thresholds.

virtual float vtkImageThreshold::GetLowerThreshold (    )  [virtual]

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

Set the desired output scalar type to cast to

virtual int vtkImageThreshold::GetOutputScalarType (    )  [virtual]

void vtkImageThreshold::SetOutputScalarTypeToDouble (    )  [inline]

Definition at line 102 of file vtkImageThreshold.h.

void vtkImageThreshold::SetOutputScalarTypeToFloat (    )  [inline]

Definition at line 104 of file vtkImageThreshold.h.

void vtkImageThreshold::SetOutputScalarTypeToLong (    )  [inline]

Definition at line 106 of file vtkImageThreshold.h.

void vtkImageThreshold::SetOutputScalarTypeToUnsignedLong (    )  [inline]

Definition at line 108 of file vtkImageThreshold.h.

void vtkImageThreshold::SetOutputScalarTypeToInt (    )  [inline]

Definition at line 110 of file vtkImageThreshold.h.

void vtkImageThreshold::SetOutputScalarTypeToUnsignedInt (    )  [inline]

Definition at line 112 of file vtkImageThreshold.h.

void vtkImageThreshold::SetOutputScalarTypeToShort (    )  [inline]

Definition at line 114 of file vtkImageThreshold.h.

void vtkImageThreshold::SetOutputScalarTypeToUnsignedShort (    )  [inline]

Definition at line 116 of file vtkImageThreshold.h.

void vtkImageThreshold::SetOutputScalarTypeToChar (    )  [inline]

Definition at line 118 of file vtkImageThreshold.h.

void vtkImageThreshold::SetOutputScalarTypeToUnsignedChar (    )  [inline]

Definition at line 120 of file vtkImageThreshold.h.

void vtkImageThreshold::operator= (  const vtkImageThreshold &    )  [inline, protected]

Definition at line 127 of file vtkImageThreshold.h.

void vtkImageThreshold::ExecuteInformation (  vtkImageData *    inData, vtkImageData *    outData )  [protected, virtual]

Reimplemented from vtkImageToImageFilter.

void vtkImageThreshold::ExecuteInformation (    )  [inline, protected, virtual]

Reimplemented from vtkImageToImageFilter. Definition at line 139 of file vtkImageThreshold.h.

void vtkImageThreshold::ThreadedExecute (  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 vtkImageToImageFilter.

---

Member Data Documentation

float vtkImageThreshold::UpperThreshold [protected]

Definition at line 129 of file vtkImageThreshold.h.

float vtkImageThreshold::LowerThreshold [protected]

Definition at line 130 of file vtkImageThreshold.h.

int vtkImageThreshold::ReplaceIn [protected]

Definition at line 131 of file vtkImageThreshold.h.

float vtkImageThreshold::InValue [protected]

Definition at line 132 of file vtkImageThreshold.h.

int vtkImageThreshold::ReplaceOut [protected]

Definition at line 133 of file vtkImageThreshold.h.

float vtkImageThreshold::OutValue [protected]

Definition at line 134 of file vtkImageThreshold.h.

int vtkImageThreshold::OutputScalarType [protected]

Definition at line 136 of file vtkImageThreshold.h.

---

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

• imaging/vtkImageThreshold.h

---