#include <itkBinaryThresholdImageFilter.h>

Inheritance diagram for itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >:

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >

Binarize an input image by thresholding.

This filter produces an output image whose pixels are either one of two values ( OutsideValue or InsideValue ), depending on whether the corresponding input image pixels lie between the two thresholds ( LowerThreshold and UpperThreshold ). Values equal to either threshold is considered to be between the thresholds.

More precisely

$Output(x_i) = \begin{cases} InsideValue & \text{if $LowerThreshold \leq x_i \leq UpperThreshold$} \\ OutsideValue & \text{otherwise} \end{cases}$

This filter is templated over the input image type and the output image type.

The filter expect both images to have the same number of dimensions.

The default values for LowerThreshold and UpperThreshold are: LowerThreshold = NumericTraits<TInput>::NonpositiveMin(); UpperThreshold = NumericTraits<TInput>::max(); Therefore, generally only one of these needs to be set, depending on whether the user wants to threshold above or below the desired threshold.

Wiki Examples:

Examples:: Examples/Filtering/BinaryThresholdImageFilter.cxx, Examples/Filtering/MathematicalMorphologyBinaryFilters.cxx, Examples/Filtering/OtsuMultipleThresholdImageFilter.cxx, Examples/Segmentation/CannySegmentationLevelSetImageFilter.cxx, Examples/Segmentation/CurvesLevelSetImageFilter.cxx, Examples/Segmentation/FastMarchingImageFilter.cxx, Examples/Segmentation/GeodesicActiveContourImageFilter.cxx, Examples/Segmentation/GeodesicActiveContourShapePriorLevelSetImageFilter.cxx, Examples/Segmentation/LaplacianSegmentationLevelSetImageFilter.cxx, Examples/Segmentation/ShapeDetectionLevelSetFilter.cxx, Examples/Segmentation/ThresholdSegmentationLevelSetImageFilter.cxx, SphinxExamples/src/Core/Mesh/ExtractIsoSurface/Code.cxx, SphinxExamples/src/Filtering/Thresholding/ThresholdAnImageUsingBinary/Code.cxx, SphinxExamples/src/Segmentation/LevelSets/SegmentWithGeodesicActiveContourLevelSet/Code.cxx, and WikiExamples/ImageProcessing/BinaryThresholdImageFilter.cxx.

Definition at line 123 of file itkBinaryThresholdImageFilter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef SimpleDataObjectDecorator < InputPixelType >	InputPixelObjectType

typedef TInputImage::PixelType	InputPixelType

typedef TOutputImage::PixelType	OutputPixelType

typedef SmartPointer< Self >	Pointer

typedef BinaryThresholdImageFilter	Self

typedef UnaryFunctorImageFilter < TInputImage, TOutputImage, Functor::BinaryThreshold < typename TInputImage::PixelType, typename TOutputImage::PixelType > >	Superclass

Public Types inherited from itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::BinaryThreshold< TInputImage::PixelType, TOutputImage::PixelType > >
typedef SmartPointer< const Self >	ConstPointer

typedef Functor::BinaryThreshold < TInputImage::PixelType, TOutputImage::PixelType >	FunctorType

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::ConstPointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TInputImage	InputImageType

typedef OutputImageType::PixelType	OutputImagePixelType

typedef OutputImageType::Pointer	OutputImagePointer

typedef OutputImageType::RegionType	OutputImageRegionType

typedef TOutputImage	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef UnaryFunctorImageFilter	Self

typedef InPlaceImageFilter < TInputImage, TOutputImage >	Superclass

Public Types inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TInputImage	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 < TInputImage, TOutputImage >	Superclass

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TInputImage	InputImageType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef SmartPointer< Self >	Pointer

typedef ImageToImageFilter	Self

typedef ImageSource< TOutputImage >	Superclass

Public Types inherited from itk::ImageSource< TOutputImage >
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 TOutputImage	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 OutputPixelType &	GetInsideValue () const

virtual InputPixelType	GetLowerThreshold () const

virtual InputPixelObjectType *	GetLowerThresholdInput ()

virtual const InputPixelObjectType *	GetLowerThresholdInput () const

virtual const char *	GetNameOfClass () const

virtual const OutputPixelType &	GetOutsideValue () const

virtual InputPixelType	GetUpperThreshold () const

virtual InputPixelObjectType *	GetUpperThresholdInput ()

virtual const InputPixelObjectType *	GetUpperThresholdInput () const

virtual void	SetInsideValue (OutputPixelType _arg)

virtual void	SetLowerThreshold (const InputPixelType threshold)

virtual void	SetLowerThresholdInput (const InputPixelObjectType *)

virtual void	SetOutsideValue (OutputPixelType _arg)

virtual void	SetUpperThreshold (const InputPixelType threshold)

virtual void	SetUpperThresholdInput (const InputPixelObjectType *)

Public Member Functions inherited from itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::BinaryThreshold< TInputImage::PixelType, TOutputImage::PixelType > >
virtual ::itk::LightObject::Pointer	CreateAnother () const

FunctorType &	GetFunctor ()

const FunctorType &	GetFunctor () const

void	SetFunctor (const FunctorType &functor)

Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
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< TInputImage, TOutputImage >
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 TInputImage *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< TOutputImage >
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::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::BinaryThreshold< TInputImage::PixelType, TOutputImage::PixelType > >
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
virtual void	BeforeThreadedGenerateData () override

	BinaryThresholdImageFilter ()

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

virtual	~BinaryThresholdImageFilter () override

Protected Member Functions inherited from itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::BinaryThreshold< TInputImage::PixelType, TOutputImage::PixelType > >
virtual void	GenerateOutputInformation () override

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

	UnaryFunctorImageFilter ()

virtual	~UnaryFunctorImageFilter () override

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

virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()

virtual void	ReleaseInputs () override

	~InPlaceImageFilter () override

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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< TOutputImage >
virtual void	AfterThreadedGenerateData ()

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

OutputPixelType	m_OutsideValue

Additional Inherited Members
Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static const unsigned int	InputImageDimension = TInputImage::ImageDimension

static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int	InputImageDimension = TInputImage::ImageDimension

static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType

typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
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