itk::ThresholdImageFilter< TImage > Class Template Reference

#include <itkThresholdImageFilter.h>

Inheritance diagram for itk::ThresholdImageFilter< TImage >:

Collaboration diagram for itk::ThresholdImageFilter< TImage >:

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.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::ConstPointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TImage	InputImageType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TImage	OutputImageType
typedef TImage::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef ThresholdImageFilter	Self
typedef InPlaceImageFilter < TImage, TImage >	Superclass
Public Types inherited from itk::InPlaceImageFilter< TImage, TImage >
typedef SmartPointer< const Self >	ConstPointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TImage	InputImageType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImagePointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef Superclass::OutputImageType	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef InPlaceImageFilter	Self
typedef ImageToImageFilter < TImage, TImage >	Superclass
Public Types inherited from itk::ImageToImageFilter< TImage, TImage >
typedef SmartPointer< const Self >	ConstPointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TImage	InputImageType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef SmartPointer< Self >	Pointer
typedef ImageToImageFilter	Self
typedef ImageSource< TImage >	Superclass
Public Types inherited from itk::ImageSource< TImage >
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef ImageSource	Self
typedef ProcessObject	Superclass
Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef std::vector < DataObjectIdentifierType >	NameArray
typedef SmartPointer< Self >	Pointer
typedef ProcessObject	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

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
Public Member Functions inherited from itk::InPlaceImageFilter< TImage, TImage >
virtual bool	CanRunInPlace () const
virtual void	SetInPlace (bool _arg)
virtual bool	GetInPlace () const
virtual void	InPlaceOn ()
virtual void	InPlaceOff ()
Public Member Functions inherited from itk::ImageToImageFilter< TImage, TImage >
virtual double	GetCoordinateTolerance ()
const InputImageType *	GetInput (void) const
const InputImageType *	GetInput (unsigned int idx) const
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	SetCoordinateTolerance (double _arg)
virtual void	SetInput (const InputImageType *image)
virtual void	SetInput (unsigned int, const TImage *image)
virtual void	SetDirectionTolerance (double _arg)
virtual double	GetDirectionTolerance ()
Public Member Functions inherited from itk::ImageSource< TImage >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType *	GetOutput (void)
const OutputImageType *	GetOutput (void) const
virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
	ThresholdImageFilter ()
	~ThresholdImageFilter ()
Protected Member Functions inherited from itk::InPlaceImageFilter< TImage, TImage >
virtual void	AllocateOutputs ()
virtual bool	GetRunningInPlace () const
	InPlaceImageFilter ()
virtual void	ReleaseInputs ()
	~InPlaceImageFilter ()
Protected Member Functions inherited from itk::ImageToImageFilter< TImage, TImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
virtual void	GenerateInputRequestedRegion ()
virtual void	VerifyInputInformation ()
void	PushBackInput (const DataObject *input)
void	PushFrontInput (const DataObject *input)
	ImageToImageFilter ()
	~ImageToImageFilter ()
Protected Member Functions inherited from itk::ImageSource< TImage >
virtual void	AfterThreadedGenerateData ()
virtual void	BeforeThreadedGenerateData ()
virtual void	GenerateData ()
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual	~ImageSource ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedInputName (const DataObjectIdentifierType &) const
bool	IsIndexedOutputName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const
DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryInputName () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryOutputName () const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Member Functions
void	operator= (const Self &)
	ThresholdImageFilter (const Self &)

Private Attributes
PixelType	m_Lower
PixelType	m_OutsideValue
PixelType	m_Upper

Additional Inherited Members
Static Public Attributes inherited from itk::InPlaceImageFilter< TImage, TImage >
static const unsigned int	InputImageDimension
static const unsigned int	OutputImageDimension
Protected Types inherited from itk::ImageToImageFilter< TImage, TImage >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType
Static Protected Member Functions inherited from itk::ImageSource< TImage >
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime
bool	m_Updating

Member Typedef Documentation

template<class TImage >

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

Definition at line 62 of file itkThresholdImageFilter.h.

template<class TImage >

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

Definition at line 115 of file itkThresholdImageFilter.h.

template<class TImage >

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

Definition at line 113 of file itkThresholdImageFilter.h.

template<class TImage >

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

Definition at line 114 of file itkThresholdImageFilter.h.

template<class TImage >

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

Some additional typedefs.

Definition at line 108 of file itkThresholdImageFilter.h.

template<class TImage >

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

Definition at line 121 of file itkThresholdImageFilter.h.

template<class TImage >

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

Definition at line 119 of file itkThresholdImageFilter.h.

template<class TImage >

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

Definition at line 120 of file itkThresholdImageFilter.h.

template<class TImage >

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

Some additional typedefs.

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

Definition at line 61 of file itkThresholdImageFilter.h.

template<class TImage >

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

Standard class typedefs.

Definition at line 59 of file itkThresholdImageFilter.h.

template<class TImage >

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

Definition at line 60 of file itkThresholdImageFilter.h.

Constructor & Destructor Documentation

template<class TImage >

itk::ThresholdImageFilter< TImage >::ThresholdImageFilter ( )

protected

template<class TImage >

itk::ThresholdImageFilter< TImage >::~ThresholdImageFilter ( )

inlineprotected

Definition at line 125 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.

template<class TImage >

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

private

template<class TImage >

void itk::ThresholdImageFilter< TImage >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protectedvirtual

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

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  )

protectedvirtual

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 > )

Member Data Documentation

template<class TImage >

PixelType itk::ThresholdImageFilter< TImage >::m_Lower

private

Definition at line 146 of file itkThresholdImageFilter.h.

template<class TImage >

PixelType itk::ThresholdImageFilter< TImage >::m_OutsideValue

private

Definition at line 145 of file itkThresholdImageFilter.h.

template<class TImage >

PixelType itk::ThresholdImageFilter< TImage >::m_Upper

private

Definition at line 147 of file itkThresholdImageFilter.h.

---

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

• itkThresholdImageFilter.h