#include <itkThresholdImageFilter.h>

Inheritance diagram for itk::ThresholdImageFilter< TImage >:

Collaboration diagram for itk::ThresholdImageFilter< TImage >:

Detailed Description

template<typename 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 available methods are:

ThresholdAbove(): The values greater than the threshold value are set to OutsideValue

ThresholdBelow(): The values less than the threshold value are set to OutsideValue

ThresholdOutside(): The values outside the threshold range (less than lower or greater than upper) are set to OutsideValue

Note that these definitions indicate that pixels equal to the threshold value are not set to OutsideValue in any of these methods

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

Wiki Examples:

Examples:: Examples/Filtering/ThresholdImageFilter.cxx, Examples/Segmentation/HoughTransform2DLinesImageFilter.cxx, SphinxExamples/src/Core/Common/WatchAFilter/Code.cxx, SphinxExamples/src/Filtering/Thresholding/ThresholdAnImage/Code.cxx, and WikiExamples/ImageProcessing/ThresholdImageFilter.cxx.

Definition at line 70 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 MultiThreader	MultiThreaderType

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


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 >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

virtual void	PopBackInput () override

virtual void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *image)

virtual void	PushFrontInput (const InputImageType *image)

virtual void	SetInput (const InputImageType *image)

virtual void	SetInput (unsigned int, const TImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TImage >
OutputImageType *	GetOutput (unsigned int idx)

virtual void	GraftNthOutput (unsigned int idx, DataObject *output)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *output)

virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

virtual ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual const float &	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

void	SetProgress (float progress)

virtual void	SetReleaseDataFlag (bool flag)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfThreads (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfThreads () const

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

const MetaDataDictionary &	GetMetaDataDictionary () 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 override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () 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 ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const override

void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId) override

	ThresholdImageFilter ()

	~ThresholdImageFilter () override

Protected Member Functions inherited from itk::InPlaceImageFilter< TImage, TImage >
virtual void	AllocateOutputs () override

virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()

virtual void	ReleaseInputs () override

	~InPlaceImageFilter () override

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

	ImageToImageFilter ()

virtual void	VerifyInputInformation () override

	~ImageToImageFilter () override

void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

Protected Member Functions inherited from itk::ImageSource< TImage >
virtual void	AfterThreadedGenerateData ()

virtual void	BeforeThreadedGenerateData ()

virtual void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

virtual	~ImageSource () override

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))

	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))

	itkLegacyMacro (virtual void RemoveInput(DataObject *input))

	itkLegacyMacro (void SetNumberOfInputs(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	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

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

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName (void) const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName (void) const

DataObject *	GetOutput (DataObjectPointerArraySizeType idx)

const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object () override

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

Static Public Attributes inherited from itk::ImageToImageFilter< TImage, TImage >
static const unsigned int	InputImageDimension

static const unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TImage >
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 const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TImage >

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

Definition at line 77 of file itkThresholdImageFilter.h.

template<typename TImage >

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

Definition at line 129 of file itkThresholdImageFilter.h.

template<typename TImage >

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

Definition at line 127 of file itkThresholdImageFilter.h.

template<typename TImage >

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

Definition at line 128 of file itkThresholdImageFilter.h.

template<typename TImage >

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

Additional typedefs for the input image.

Definition at line 122 of file itkThresholdImageFilter.h.

template<typename TImage >

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

Definition at line 135 of file itkThresholdImageFilter.h.

template<typename TImage >

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

Definition at line 133 of file itkThresholdImageFilter.h.

template<typename TImage >

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

Definition at line 134 of file itkThresholdImageFilter.h.

template<typename TImage >

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

Additional typedefs for the output image.

Definition at line 132 of file itkThresholdImageFilter.h.

template<typename TImage >

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

Typedef to describe the type of pixel.

Definition at line 83 of file itkThresholdImageFilter.h.

template<typename TImage >

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

Definition at line 76 of file itkThresholdImageFilter.h.

template<typename TImage >

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

Standard class typedefs.

Definition at line 74 of file itkThresholdImageFilter.h.

template<typename TImage >

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

Definition at line 75 of file itkThresholdImageFilter.h.

Constructor & Destructor Documentation

template<typename TImage >

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

protected

template<typename TImage >

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

inlineoverrideprotected

Definition at line 139 of file itkThresholdImageFilter.h.

Member Function Documentation

template<typename TImage >

virtual::itk::LightObject::Pointer itk::ThresholdImageFilter< TImage >::CreateAnother ( ) 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<typename TImage >

virtual PixelType itk::ThresholdImageFilter< TImage >::GetLower ( ) const

virtual

Set/Get methods to set the lower threshold.

template<typename TImage >

virtual const char* itk::ThresholdImageFilter< TImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

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

template<typename TImage >

virtual PixelType itk::ThresholdImageFilter< TImage >::GetOutsideValue ( ) const

virtual

Get the "outside" pixel value.

template<typename TImage >

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

virtual

Set/Get methods to set the upper threshold.

template<typename TImage >

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

static

Method for creation through the object factory.

template<typename TImage >

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

overrideprotectedvirtual

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<typename TImage >

virtual void itk::ThresholdImageFilter< TImage >::SetLower ( PixelType _arg )

virtual

Set/Get methods to set the lower threshold.

template<typename TImage >

virtual void itk::ThresholdImageFilter< TImage >::SetOutsideValue ( PixelType _arg )

virtual

The pixel type must support comparison operators. Set the "outside" pixel value. The default value NumericTraits<PixelType>::ZeroValue().

template<typename TImage >

virtual void itk::ThresholdImageFilter< TImage >::SetUpper ( PixelType _arg )

virtual

Set/Get methods to set the upper threshold.

template<typename TImage >

void itk::ThresholdImageFilter< TImage >::ThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		ThreadIdType	threadId
	)

overrideprotectedvirtual

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