itk::ThresholdImageFilter< TImage > Class Template Reference
[Intensity Image Filters]

Set image values to a user-specified value if they are below, above, or between simple threshold values. More...

#include <itkThresholdImageFilter.h>

Inheritance diagram for itk::ThresholdImageFilter< TImage >:

[legend]Collaboration diagram for itk::ThresholdImageFilter< TImage >:

[legend]List of all members.

Public Types
typedef ThresholdImageFilter	Self
typedef InPlaceImageFilter< TImage, TImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TImage::PixelType	PixelType
typedef TImage	InputImageType
typedef InputImageType::ConstPointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef InputImageType::PixelType	InputImagePixelType
typedef TImage	OutputImageType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef OutputImageType::PixelType	OutputImagePixelType
enum	{ PixelTypeComparable = 0 }
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual void	SetOutsideValue (PixelType _arg)
virtual PixelType	GetOutsideValue ()
void	ThresholdAbove (const PixelType &thresh)
void	ThresholdBelow (const PixelType &thresh)
void	ThresholdOutside (const PixelType &lower, const PixelType &upper)
virtual void	SetLower (PixelType _arg)
virtual PixelType	GetLower ()
virtual void	SetUpper (PixelType _arg)
virtual PixelType	GetUpper ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	ThresholdImageFilter ()
	~ThresholdImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

---

Detailed Description

template<class TImage>
class itk::ThresholdImageFilter< TImage >

Set image values to a user-specified value if they are below, above, or between simple threshold values.

ThresholdImageFilter sets image values to a user-specified "outside" value (by default, "black") if the image values are below, above, or between simple threshold values.

The pixels must support the operators >= and <=.

Definition at line 43 of file itkThresholdImageFilter.h.

---

Member Typedef Documentation

template<class TImage> typedef SmartPointer<const Self> itk::ThresholdImageFilter< TImage >::ConstPointer

Reimplemented from itk::InPlaceImageFilter< TImage, TImage >. Definition at line 50 of file itkThresholdImageFilter.h.

template<class TImage> typedef InputImageType::PixelType itk::ThresholdImageFilter< TImage >::InputImagePixelType

Reimplemented from itk::InPlaceImageFilter< TImage, TImage >. Definition at line 94 of file itkThresholdImageFilter.h.

template<class TImage> typedef InputImageType::ConstPointer itk::ThresholdImageFilter< TImage >::InputImagePointer

Reimplemented from itk::InPlaceImageFilter< TImage, TImage >. Definition at line 92 of file itkThresholdImageFilter.h.

template<class TImage> typedef InputImageType::RegionType itk::ThresholdImageFilter< TImage >::InputImageRegionType

Reimplemented from itk::InPlaceImageFilter< TImage, TImage >. Definition at line 93 of file itkThresholdImageFilter.h.

template<class TImage> typedef TImage itk::ThresholdImageFilter< TImage >::InputImageType

Some additional typedefs. Reimplemented from itk::InPlaceImageFilter< TImage, TImage >. Definition at line 91 of file itkThresholdImageFilter.h.

template<class TImage> typedef OutputImageType::PixelType itk::ThresholdImageFilter< TImage >::OutputImagePixelType

Reimplemented from itk::InPlaceImageFilter< TImage, TImage >. Definition at line 100 of file itkThresholdImageFilter.h.

template<class TImage> typedef OutputImageType::Pointer itk::ThresholdImageFilter< TImage >::OutputImagePointer

Reimplemented from itk::InPlaceImageFilter< TImage, TImage >. Definition at line 98 of file itkThresholdImageFilter.h.

template<class TImage> typedef OutputImageType::RegionType itk::ThresholdImageFilter< TImage >::OutputImageRegionType

Superclass typedefs. Reimplemented from itk::InPlaceImageFilter< TImage, TImage >. Definition at line 99 of file itkThresholdImageFilter.h. Referenced by itk::ThresholdImageFilter< TImage >::~ThresholdImageFilter().

template<class TImage> typedef TImage itk::ThresholdImageFilter< TImage >::OutputImageType

Some additional typedefs. Reimplemented from itk::InPlaceImageFilter< TImage, TImage >. Definition at line 97 of file itkThresholdImageFilter.h.

template<class TImage> typedef TImage::PixelType itk::ThresholdImageFilter< TImage >::PixelType

Typedef to describe the type of pixel. Definition at line 59 of file itkThresholdImageFilter.h. Referenced by itk::ThresholdImageFilter< TImage >::~ThresholdImageFilter().

template<class TImage> typedef SmartPointer<Self> itk::ThresholdImageFilter< TImage >::Pointer

Reimplemented from itk::InPlaceImageFilter< TImage, TImage >. Definition at line 49 of file itkThresholdImageFilter.h.

template<class TImage> typedef ThresholdImageFilter itk::ThresholdImageFilter< TImage >::Self

Standard class typedefs. Reimplemented from itk::InPlaceImageFilter< TImage, TImage >. Definition at line 47 of file itkThresholdImageFilter.h. Referenced by itk::ThresholdImageFilter< TImage >::~ThresholdImageFilter().

template<class TImage> typedef InPlaceImageFilter<TImage,TImage> itk::ThresholdImageFilter< TImage >::Superclass

Reimplemented from itk::InPlaceImageFilter< TImage, TImage >. Definition at line 48 of file itkThresholdImageFilter.h.

---

Member Enumeration Documentation

template<class TImage> anonymous enum

The pixel type must support comparison operators. Enumeration values: PixelTypeComparable  Definition at line 62 of file itkThresholdImageFilter.h.

---

Constructor & Destructor Documentation

template<class TImage> itk::ThresholdImageFilter< TImage >::ThresholdImageFilter (   )  [protected]

template<class TImage> itk::ThresholdImageFilter< TImage >::~ThresholdImageFilter (   )  [inline, protected]

Definition at line 104 of file itkThresholdImageFilter.h. References itk::ThresholdImageFilter< TImage >::OutputImageRegionType, itk::ThresholdImageFilter< TImage >::PixelType, and itk::ThresholdImageFilter< TImage >::Self.

---

Member Function Documentation

template<class TImage> virtual PixelType itk::ThresholdImageFilter< TImage >::GetLower (   )  [virtual]

Set/Get methods to set the lower threshold

template<class TImage> virtual const char* itk::ThresholdImageFilter< TImage >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::InPlaceImageFilter< TImage, TImage >.

template<class TImage> virtual PixelType itk::ThresholdImageFilter< TImage >::GetOutsideValue (   )  [virtual]

Get the "outside" pixel value.

template<class TImage> virtual PixelType itk::ThresholdImageFilter< TImage >::GetUpper (   )  [virtual]

Set/Get methods to set the upper threshold

template<class TImage> Pointer itk::ThresholdImageFilter< TImage >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TImage> void itk::ThresholdImageFilter< TImage >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, 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 itk::InPlaceImageFilter< TImage, TImage >.

template<class TImage> virtual void itk::ThresholdImageFilter< TImage >::SetLower (  PixelType  _arg  )  [virtual]

Set/Get methods to set the lower threshold

template<class TImage> virtual void itk::ThresholdImageFilter< TImage >::SetOutsideValue (  PixelType  _arg  )  [virtual]

Set the "outside" pixel value. The default value NumericTraits<PixelType>::Zero.

template<class TImage> virtual void itk::ThresholdImageFilter< TImage >::SetUpper (  PixelType  _arg  )  [virtual]

Set/Get methods to set the upper threshold

template<class TImage> void itk::ThresholdImageFilter< TImage >::ThreadedGenerateData (  const OutputImageRegionType &  outputRegionForThread, int  threadId )  [protected, virtual]

ThresholdImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread" See also: ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData() Reimplemented from itk::ImageSource< TImage >.

template<class TImage> void itk::ThresholdImageFilter< TImage >::ThresholdAbove (  const PixelType &  thresh  )

The values greater than or equal to the value are set to OutsideValue.

template<class TImage> void itk::ThresholdImageFilter< TImage >::ThresholdBelow (  const PixelType &  thresh  )

The values less than or equal to the value are set to OutsideValue.

template<class TImage> void itk::ThresholdImageFilter< TImage >::ThresholdOutside (  const PixelType &  lower, const PixelType &  upper )

The values outside the range are set to OutsideValue.

---

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

• itkThresholdImageFilter.h

---