Binarize an input image by thresholding. More...

#include <sitkBinaryThresholdImageFilter.h>

Inheritance diagram for itk::simple::BinaryThresholdImageFilter:

Collaboration diagram for itk::simple::BinaryThresholdImageFilter:

Detailed Description

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 \f$LowerThreshold \leq x_i \leq UpperThreshold\f$} \\ 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.

See also: itk::simple::BinaryThreshold for the procedural interface; itk::BinaryThresholdImageFilter for the Doxygen on the original ITK class.

Examples: FastMarchingSegmentation/FastMarchingSegmentation.cxx.

Definition at line 49 of file sitkBinaryThresholdImageFilter.h.

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList

using	Self = BinaryThresholdImageFilter

Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter

Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
	BinaryThresholdImageFilter ()

Image	Execute (const Image &image1)

Image	Execute (Image &&image1)

uint8_t	GetInsideValue () const

double	GetLowerThreshold () const

std::string	GetName () const

uint8_t	GetOutsideValue () const

double	GetUpperThreshold () const

Self &	SetInsideValue (uint8_t InsideValue)

Self &	SetLowerThreshold (double LowerThreshold)

Self &	SetOutsideValue (uint8_t OutsideValue)

Self &	SetUpperThreshold (double UpperThreshold)

std::string	ToString () const

virtual	~BinaryThresholdImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter
	ImageFilter ()

virtual	~ImageFilter ()=0

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

virtual int	AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
	Directly add a callback to observe an event. More...

virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...

virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...

virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands. More...

virtual	~ProcessObject ()

virtual void	DebugOn ()

virtual void	DebugOff ()

virtual bool	GetDebug () const

virtual void	SetDebug (bool debugFlag)

virtual void	SetNumberOfThreads (unsigned int n)

virtual unsigned int	GetNumberOfThreads () const

virtual void	SetNumberOfWorkUnits (unsigned int n)

virtual unsigned int	GetNumberOfWorkUnits () const

Private Types
using	MemberFunctionType = Image(Self::*)(const Image &image1)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image &image1)

Private Attributes
bool	m_InPlace {false}

uint8_t	m_InsideValue {1u}

double	m_LowerThreshold {0.0}

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

uint8_t	m_OutsideValue {0u}

double	m_UpperThreshold {255.0}

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()

static void	GlobalDefaultDebugOff ()

static void	GlobalDefaultDebugOn ()

static void	SetGlobalDefaultDebug (bool debugFlag)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static void	SetGlobalWarningDisplay (bool flag)

static bool	GetGlobalWarningDisplay ()

static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects. More...

static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects. More...

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects. More...

Protected Member Functions inherited from itk::simple::ImageFilter
void	CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)

Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)

virtual itk::ProcessObject *	GetActiveProcess ()

virtual void	OnActiveProcessDelete ()

virtual void	onCommandDelete (const itk::simple::Command *cmd) noexcept

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()=default

	NonCopyable (const NonCopyable &)=delete

NonCopyable &	operator= (const NonCopyable &)=delete

Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
static void	FixNonZeroIndex (TImageType *img)

Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer	CastImageToITK (const Image &img)

template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)

template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)

template<class TImageType >
static Image	CastITKToImage (TImageType *img)

static const itk::EventObject &	GetITKEventObject (EventEnum e)

template<typename T >
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)

static std::ostream &	ToStringHelper (std::ostream &os, const char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::BinaryThresholdImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

private

Setup for member function dispatching

Definition at line 119 of file sitkBinaryThresholdImageFilter.h.

◆ PixelIDTypeList

using itk::simple::BinaryThresholdImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 61 of file sitkBinaryThresholdImageFilter.h.

◆ Self

using itk::simple::BinaryThresholdImageFilter::Self = BinaryThresholdImageFilter

Definition at line 51 of file sitkBinaryThresholdImageFilter.h.

Constructor & Destructor Documentation

◆ ~BinaryThresholdImageFilter()

virtual itk::simple::BinaryThresholdImageFilter::~BinaryThresholdImageFilter ( )

virtual

Destructor

◆ BinaryThresholdImageFilter()

itk::simple::BinaryThresholdImageFilter::BinaryThresholdImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

Image itk::simple::BinaryThresholdImageFilter::Execute ( const Image & image1 )

◆ Execute() [2/2]

Image itk::simple::BinaryThresholdImageFilter::Execute ( Image && image1 )

Execute the filter on the input image

Examples: FastMarchingSegmentation/FastMarchingSegmentation.cxx.

◆ ExecuteInternal()

template<class TImageType >

Image itk::simple::BinaryThresholdImageFilter::ExecuteInternal ( const Image & image1 )

private

◆ GetInsideValue()

uint8_t itk::simple::BinaryThresholdImageFilter::GetInsideValue ( ) const

inline

Get the "inside" pixel value.

Definition at line 90 of file sitkBinaryThresholdImageFilter.h.

◆ GetLowerThreshold()

double itk::simple::BinaryThresholdImageFilter::GetLowerThreshold ( ) const

inline

Definition at line 70 of file sitkBinaryThresholdImageFilter.h.

◆ GetName()

std::string itk::simple::BinaryThresholdImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 103 of file sitkBinaryThresholdImageFilter.h.

◆ GetOutsideValue()

uint8_t itk::simple::BinaryThresholdImageFilter::GetOutsideValue ( ) const

inline

Get the "outside" pixel value.

Definition at line 100 of file sitkBinaryThresholdImageFilter.h.

◆ GetUpperThreshold()

double itk::simple::BinaryThresholdImageFilter::GetUpperThreshold ( ) const

inline

Get the threshold values.

Definition at line 80 of file sitkBinaryThresholdImageFilter.h.

◆ SetInsideValue()

Self& itk::simple::BinaryThresholdImageFilter::SetInsideValue ( uint8_t InsideValue )

inline

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

Examples: FastMarchingSegmentation/FastMarchingSegmentation.cxx.

Definition at line 85 of file sitkBinaryThresholdImageFilter.h.

◆ SetLowerThreshold()

Self& itk::simple::BinaryThresholdImageFilter::SetLowerThreshold ( double LowerThreshold )

inline

Examples: FastMarchingSegmentation/FastMarchingSegmentation.cxx.

Definition at line 66 of file sitkBinaryThresholdImageFilter.h.

◆ SetOutsideValue()

Self& itk::simple::BinaryThresholdImageFilter::SetOutsideValue ( uint8_t OutsideValue )

inline

Set the "outside" pixel value. The default value NumericTraits<OutputPixelType>::ZeroValue() .

Examples: FastMarchingSegmentation/FastMarchingSegmentation.cxx.

Definition at line 95 of file sitkBinaryThresholdImageFilter.h.

◆ SetUpperThreshold()

Self& itk::simple::BinaryThresholdImageFilter::SetUpperThreshold ( double UpperThreshold )

inline

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.