#include <itkThresholdImageFilter.h>

Inheritance diagram for itk::ThresholdImageFilter< TImage >:

Collaboration diagram for itk::ThresholdImageFilter< TImage >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::ConstPointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TImage	InputImageType
typedef TImage::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef ThresholdImageFilter	Self
typedef InPlaceImageFilter < TImage, TImage >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
virtual PixelType	GetOutsideValue () const
virtual void	SetOutsideValue (PixelType _arg)
void	ThresholdAbove (const PixelType &thresh)
void	ThresholdBelow (const PixelType &thresh)
void	ThresholdOutside (const PixelType &lower, const PixelType &upper)
	typedef (Concept::Comparable< PixelType >) PixelTypeComparableCheck
	typedef (Concept::OStreamWritable< PixelType >) PixelTypeOStreamWritableCheck

virtual void	SetLower (PixelType _arg)
virtual PixelType	GetLower () const

virtual void	SetUpper (PixelType _arg)
virtual PixelType	GetUpper () const
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
Private Member Functions
void	operator= (const Self &)
	ThresholdImageFilter (const Self &)
Private Attributes
PixelType	m_Lower
PixelType	m_OutsideValue
PixelType	m_Upper
typedef TImage	OutputImageType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef OutputImageType::PixelType	OutputImagePixelType
	ThresholdImageFilter ()
	~ThresholdImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const

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

Wiki Examples:

All Examples

Threshold an image

Definition at line 55 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 62 of file itkThresholdImageFilter.h.

template<class TImage >

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

Reimplemented from itk::InPlaceImageFilter< TImage, TImage >.

Definition at line 115 of file itkThresholdImageFilter.h.

template<class TImage >

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

Reimplemented from itk::InPlaceImageFilter< TImage, TImage >.

Definition at line 113 of file itkThresholdImageFilter.h.

template<class TImage >

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

Reimplemented from itk::InPlaceImageFilter< TImage, TImage >.

Definition at line 114 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 108 of file itkThresholdImageFilter.h.

template<class TImage >

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

Some additional typedefs.

Reimplemented from itk::InPlaceImageFilter< TImage, TImage >.

Definition at line 121 of file itkThresholdImageFilter.h.

template<class TImage >

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

Some additional typedefs.

Reimplemented from itk::InPlaceImageFilter< TImage, TImage >.

Definition at line 119 of file itkThresholdImageFilter.h.

template<class TImage >

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

Some additional typedefs.

Reimplemented from itk::InPlaceImageFilter< TImage, TImage >.

Definition at line 120 of file itkThresholdImageFilter.h.

template<class TImage >

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

Some additional typedefs.

Reimplemented from itk::InPlaceImageFilter< TImage, TImage >.

Definition at line 118 of file itkThresholdImageFilter.h.

template<class TImage >

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

Typedef to describe the type of pixel.

Definition at line 68 of file itkThresholdImageFilter.h.

template<class TImage >

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

Reimplemented from itk::InPlaceImageFilter< TImage, TImage >.

Definition at line 61 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 59 of file itkThresholdImageFilter.h.

template<class TImage >

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

Reimplemented from itk::InPlaceImageFilter< TImage, TImage >.

Definition at line 60 of file itkThresholdImageFilter.h.

Constructor & Destructor Documentation

template<class TImage >

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

Some additional typedefs.

template<class TImage >

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

Some additional typedefs.

Definition at line 124 of file itkThresholdImageFilter.h.

template<class TImage >

itk::ThresholdImageFilter< TImage >::ThresholdImageFilter ( const Self & ) [private]

Member Function Documentation

template<class TImage >

virtual::itk::LightObject::Pointer itk::ThresholdImageFilter< TImage >::CreateAnother ( void ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<class TImage >

virtual PixelType itk::ThresholdImageFilter< TImage >::GetLower ( ) const [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 ( ) const [virtual]

Get the "outside" pixel value.

template<class TImage >

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

Set/Get methods to set the upper threshold

template<class TImage >

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

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TImage >

void itk::ThresholdImageFilter< TImage >::operator= ( const Self & ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::InPlaceImageFilter< TImage, TImage >.

template<class TImage >

void itk::ThresholdImageFilter< TImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const `[protected, virtual]`

Some additional typedefs.

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]

End concept checking 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,
		ThreadIdType	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.

template<class TImage >

itk::ThresholdImageFilter< TImage >::typedef ( Concept::Comparable< PixelType > )

The pixel type must support comparison operators. Begin concept checking This class requires PixelTypeComparableCheck in the form of ( Concept::Comparable< PixelType > )

template<class TImage >

itk::ThresholdImageFilter< TImage >::typedef ( Concept::OStreamWritable< PixelType > )

This class requires PixelTypeOStreamWritableCheck in the form of ( Concept::OStreamWritable< PixelType > )