#include <itkBinaryThresholdImageFilter.h>

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.

ITK Sphinx Examples:

All ITK Sphinx Examples

Threshold An Image Using Binary Thresholding

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/Common/InPlaceFilterOfImage/Code.cxx, SphinxExamples/src/Core/Mesh/ExtractIsoSurface/Code.cxx, SphinxExamples/src/Filtering/Thresholding/ThresholdAnImageUsingBinary/Code.cxx, and SphinxExamples/src/Segmentation/LevelSets/SegmentWithGeodesicActiveContourLevelSet/Code.cxx.

Definition at line 132 of file itkBinaryThresholdImageFilter.h.

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	InputPixelObjectType = SimpleDataObjectDecorator< InputPixelType >

using	InputPixelType = typename TInputImage::PixelType

using	OutputPixelType = typename TOutputImage::PixelType

using	Pointer = SmartPointer< Self >

using	Self = BinaryThresholdImageFilter

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

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

using	FunctorType = Functor::BinaryThreshold< TInputImage::PixelType, TOutputImage::PixelType >

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::ConstPointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = UnaryFunctorImageFilter

using	Superclass = InPlaceImageFilter< TInputImage, TOutputImage >

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

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = InPlaceImageFilter

using	Superclass = ImageToImageFilter< TInputImage, TOutputImage >

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

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< TOutputImage >

Public Types inherited from itk::ImageSource< TOutputImage >
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageSource

using	Superclass = ProcessObject

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
virtual const OutputPixelType &	GetInsideValue () const

virtual InputPixelType	GetLowerThreshold () const

virtual InputPixelObjectType *	GetLowerThresholdInput ()

virtual const InputPixelObjectType *	GetLowerThresholdInput () const

const char *	GetNameOfClass () const override

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 > >
const char *	GetNameOfClass () const override

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

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetInput (const InputImageType *input)

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)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

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

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

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

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

Public Member Functions inherited from itk::ProcessObject
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 float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

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::ImageToImageFilter< TInputImage, TOutputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

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

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

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

static Pointer	New ()

Protected Member Functions
void	BeforeThreadedGenerateData () override

	BinaryThresholdImageFilter ()

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

	~BinaryThresholdImageFilter () override=default

Protected Member Functions inherited from itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::BinaryThreshold< TInputImage::PixelType, TOutputImage::PixelType > >
void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

void	GenerateOutputInformation () override

	UnaryFunctorImageFilter ()

	~UnaryFunctorImageFilter () override=default

Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()=default

void	ReleaseInputs () override

	~InPlaceImageFilter () override=default

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

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

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

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

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

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	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

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 idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyPreconditions () const

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

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~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 constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

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

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

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

Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading { true }

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >

using itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 148 of file itkBinaryThresholdImageFilter.h.

◆ InputPixelObjectType

template<typename TInputImage , typename TOutputImage >

using itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::InputPixelObjectType = SimpleDataObjectDecorator<InputPixelType>

Type of DataObjects to use for scalar inputs

Definition at line 161 of file itkBinaryThresholdImageFilter.h.

◆ InputPixelType

template<typename TInputImage , typename TOutputImage >

using itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::InputPixelType = typename TInputImage::PixelType

Pixel types.

Definition at line 157 of file itkBinaryThresholdImageFilter.h.

◆ OutputPixelType

template<typename TInputImage , typename TOutputImage >

using itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::OutputPixelType = typename TOutputImage::PixelType

Definition at line 158 of file itkBinaryThresholdImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >

using itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 147 of file itkBinaryThresholdImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >

using itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::Self = BinaryThresholdImageFilter

Standard class type aliases.

Definition at line 142 of file itkBinaryThresholdImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >

using itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::Superclass = UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::BinaryThreshold<typename TInputImage::PixelType, typename TOutputImage::PixelType> >

Definition at line 146 of file itkBinaryThresholdImageFilter.h.

Constructor & Destructor Documentation

◆ BinaryThresholdImageFilter()

template<typename TInputImage , typename TOutputImage >

itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::BinaryThresholdImageFilter ( )

protected

◆ ~BinaryThresholdImageFilter()

template<typename TInputImage , typename TOutputImage >

itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::~BinaryThresholdImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >

void itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( )

overrideprotectedvirtual

This method is used to set the state of the filter before multi-threading.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GetInsideValue()

template<typename TInputImage , typename TOutputImage >

virtual const OutputPixelType& itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetInsideValue ( ) const

virtual

Get the "inside" pixel value.

◆ GetLowerThreshold()

template<typename TInputImage , typename TOutputImage >

virtual InputPixelType itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetLowerThreshold ( ) const

virtual

◆ GetLowerThresholdInput() [1/2]

template<typename TInputImage , typename TOutputImage >

virtual InputPixelObjectType* itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetLowerThresholdInput ( )

virtual

◆ GetLowerThresholdInput() [2/2]

template<typename TInputImage , typename TOutputImage >

virtual const InputPixelObjectType* itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetLowerThresholdInput ( ) const

virtual

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >

const char* itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::GPUBinaryThresholdImageFilter< TInputImage, TOutputImage >, itk::GPUUnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::GPUBinaryThreshold< TInputImage::PixelType, TOutputImage::PixelType >, BinaryThresholdImageFilter< TInputImage, TOutputImage > >, itk::GPUImageToImageFilter< TInputImage, TOutputImage, BinaryThresholdImageFilter< TInputImage, TOutputImage > >, and itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, BinaryThresholdImageFilter< TInputImage, TOutputImage > >.

◆ GetOutsideValue()

template<typename TInputImage , typename TOutputImage >

virtual const OutputPixelType& itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetOutsideValue ( ) const

virtual

Get the "outside" pixel value.

◆ GetUpperThreshold()

template<typename TInputImage , typename TOutputImage >

virtual InputPixelType itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetUpperThreshold ( ) const

virtual

Get the threshold values.

◆ GetUpperThresholdInput() [1/2]

template<typename TInputImage , typename TOutputImage >

virtual InputPixelObjectType* itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetUpperThresholdInput ( )

virtual

◆ GetUpperThresholdInput() [2/2]

template<typename TInputImage , typename TOutputImage >

virtual const InputPixelObjectType* itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::GetUpperThresholdInput ( ) const

virtual

◆ New()

template<typename TInputImage , typename TOutputImage >

static Pointer itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >

void itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::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< TInputImage, TOutputImage >.

Reimplemented in itk::GPUImageToImageFilter< TInputImage, TOutputImage, BinaryThresholdImageFilter< TInputImage, TOutputImage > >, and itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, BinaryThresholdImageFilter< TInputImage, TOutputImage > >.

◆ SetInsideValue()

template<typename TInputImage , typename TOutputImage >

virtual void itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::SetInsideValue ( OutputPixelType _arg )

virtual

Set the "inside" pixel value. The default value NumericTraits<OutputPixelType>::max()

◆ SetLowerThreshold()

template<typename TInputImage , typename TOutputImage >

virtual void itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::SetLowerThreshold ( const InputPixelType threshold )

virtual

◆ SetLowerThresholdInput()

template<typename TInputImage , typename TOutputImage >

virtual void itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::SetLowerThresholdInput ( const InputPixelObjectType * )

virtual

◆ SetOutsideValue()

template<typename TInputImage , typename TOutputImage >

virtual void itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::SetOutsideValue ( OutputPixelType _arg )

virtual

Set the "outside" pixel value. The default value OutputPixelType{}.

◆ SetUpperThreshold()

template<typename TInputImage , typename TOutputImage >

virtual void itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::SetUpperThreshold ( const InputPixelType threshold )

virtual

Set the thresholds. The default lower threshold is NumericTraits<InputPixelType>::NonpositiveMin(). The default upper threshold is NumericTraits<InputPixelType>::max. An exception is thrown if the lower threshold is greater than the upper threshold.

◆ SetUpperThresholdInput()

template<typename TInputImage , typename TOutputImage >

virtual void itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::SetUpperThresholdInput ( const InputPixelObjectType * )

virtual

Member Data Documentation

◆ m_InsideValue

template<typename TInputImage , typename TOutputImage >

OutputPixelType itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::m_InsideValue {}

private

Definition at line 233 of file itkBinaryThresholdImageFilter.h.

◆ m_OutsideValue

template<typename TInputImage , typename TOutputImage >

OutputPixelType itk::BinaryThresholdImageFilter< TInputImage, TOutputImage >::m_OutsideValue {}

private

Definition at line 234 of file itkBinaryThresholdImageFilter.h.

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

itkBinaryThresholdImageFilter.h

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ InputPixelObjectType

◆ InputPixelType

◆ OutputPixelType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ BinaryThresholdImageFilter()

◆ ~BinaryThresholdImageFilter()

Member Function Documentation

◆ BeforeThreadedGenerateData()

◆ GetInsideValue()

◆ GetLowerThreshold()

◆ GetLowerThresholdInput() [1/2]

◆ GetLowerThresholdInput() [2/2]

◆ GetNameOfClass()

◆ GetOutsideValue()

◆ GetUpperThreshold()

◆ GetUpperThresholdInput() [1/2]

◆ GetUpperThresholdInput() [2/2]

◆ New()

◆ PrintSelf()

◆ SetInsideValue()

◆ SetLowerThreshold()

◆ SetLowerThresholdInput()

◆ SetOutsideValue()

◆ SetUpperThreshold()

◆ SetUpperThresholdInput()

Member Data Documentation

◆ m_InsideValue

◆ m_OutsideValue

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