Threshold an image using the Otsu Threshold. More...

#include <sitkOtsuThresholdImageFilter.h>

Inheritance diagram for itk::simple::OtsuThresholdImageFilter:

Collaboration diagram for itk::simple::OtsuThresholdImageFilter:

Detailed Description

Threshold an image using the Otsu Threshold.

This filter creates a binary thresholded image that separates an image into foreground and background components. The filter computes the threshold using the OtsuThresholdCalculator and applies that threshold to the input image using the BinaryThresholdImageFilter .

Author: Richard Beare; Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

This implementation was taken from the Insight Journal paper: https://doi.org/10.54294/efycla

See also: HistogramThresholdImageFilter; itk::simple::OtsuThreshold for the procedural interface; itk::OtsuThresholdImageFilter for the Doxygen on the original ITK class.

Definition at line 51 of file sitkOtsuThresholdImageFilter.h.

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList

using	Self = OtsuThresholdImageFilter

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

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

Public Member Functions
Image	Execute (const Image &image)

Image	Execute (const Image &image, const Image &maskImage)

uint8_t	GetInsideValue () const

bool	GetMaskOutput () const

uint8_t	GetMaskValue () const

std::string	GetName () const

uint32_t	GetNumberOfHistogramBins () const

uint8_t	GetOutsideValue () const

bool	GetReturnBinMidpoint () const

double	GetThreshold () const
	Get the computed threshold. More...

Self &	MaskOutputOff ()

Self &	MaskOutputOn ()

	OtsuThresholdImageFilter ()

Self &	ReturnBinMidpointOff ()

Self &	ReturnBinMidpointOn ()

Self &	SetInsideValue (uint8_t InsideValue)

Self &	SetMaskOutput (bool MaskOutput)

Self &	SetMaskValue (uint8_t MaskValue)

Self &	SetNumberOfHistogramBins (uint32_t NumberOfHistogramBins)

Self &	SetOutsideValue (uint8_t OutsideValue)

Self &	SetReturnBinMidpoint (bool ReturnBinMidpoint)

std::string	ToString () const

virtual	~OtsuThresholdImageFilter ()

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 image, const Image *maskImage)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image image, const Image maskImage)

Private Attributes
uint8_t	m_InsideValue {1u}

bool	m_MaskOutput {true}

uint8_t	m_MaskValue {255u}

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

uint32_t	m_NumberOfHistogramBins {128u}

uint8_t	m_OutsideValue {0u}

bool	m_ReturnBinMidpoint {false}

double	m_Threshold {0.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::OtsuThresholdImageFilter::MemberFunctionType = Image (Self::*)( const Image * image, const Image * maskImage )

private

Setup for member function dispatching

Definition at line 160 of file sitkOtsuThresholdImageFilter.h.

◆ PixelIDTypeList

using itk::simple::OtsuThresholdImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 63 of file sitkOtsuThresholdImageFilter.h.

◆ Self

using itk::simple::OtsuThresholdImageFilter::Self = OtsuThresholdImageFilter

Definition at line 53 of file sitkOtsuThresholdImageFilter.h.

Constructor & Destructor Documentation

◆ ~OtsuThresholdImageFilter()

virtual itk::simple::OtsuThresholdImageFilter::~OtsuThresholdImageFilter ( )

virtual

Destructor

◆ OtsuThresholdImageFilter()

itk::simple::OtsuThresholdImageFilter::OtsuThresholdImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

Image itk::simple::OtsuThresholdImageFilter::Execute ( const Image & image )

◆ Execute() [2/2]

Image itk::simple::OtsuThresholdImageFilter::Execute	(	const Image &	image,
		const Image &	maskImage
	)

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >

Image itk::simple::OtsuThresholdImageFilter::ExecuteInternal	(	const Image *	image,
		const Image *	maskImage
	)

private

◆ GetInsideValue()

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

inline

Get the "inside" pixel value.

Definition at line 76 of file sitkOtsuThresholdImageFilter.h.

◆ GetMaskOutput()

bool itk::simple::OtsuThresholdImageFilter::GetMaskOutput ( ) const

inline

Definition at line 111 of file sitkOtsuThresholdImageFilter.h.

◆ GetMaskValue()

uint8_t itk::simple::OtsuThresholdImageFilter::GetMaskValue ( ) const

inline

Definition at line 120 of file sitkOtsuThresholdImageFilter.h.

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 145 of file sitkOtsuThresholdImageFilter.h.

◆ GetNumberOfHistogramBins()

uint32_t itk::simple::OtsuThresholdImageFilter::GetNumberOfHistogramBins ( ) const

inline

Definition at line 98 of file sitkOtsuThresholdImageFilter.h.

◆ GetOutsideValue()

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

inline

Get the "outside" pixel value.

Definition at line 88 of file sitkOtsuThresholdImageFilter.h.

◆ GetReturnBinMidpoint()

bool itk::simple::OtsuThresholdImageFilter::GetReturnBinMidpoint ( ) const

inline

Should the threshold value be mid-point of the bin or the maximum? Default is to return bin maximum.

Definition at line 134 of file sitkOtsuThresholdImageFilter.h.

◆ GetThreshold()

double itk::simple::OtsuThresholdImageFilter::GetThreshold ( ) const

inline

Get the computed threshold.

This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

Definition at line 141 of file sitkOtsuThresholdImageFilter.h.

◆ MaskOutputOff()

Self& itk::simple::OtsuThresholdImageFilter::MaskOutputOff ( )

inline

Definition at line 107 of file sitkOtsuThresholdImageFilter.h.

◆ MaskOutputOn()

Self& itk::simple::OtsuThresholdImageFilter::MaskOutputOn ( )

inline

Set the value of MaskOutput to true or false respectfully.

Definition at line 106 of file sitkOtsuThresholdImageFilter.h.

◆ ReturnBinMidpointOff()

Self& itk::simple::OtsuThresholdImageFilter::ReturnBinMidpointOff ( )

inline

Definition at line 129 of file sitkOtsuThresholdImageFilter.h.

◆ ReturnBinMidpointOn()

Self& itk::simple::OtsuThresholdImageFilter::ReturnBinMidpointOn ( )

inline

Set the value of ReturnBinMidpoint to true or false respectfully.

Definition at line 128 of file sitkOtsuThresholdImageFilter.h.

◆ SetInsideValue()

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

inline

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

Definition at line 70 of file sitkOtsuThresholdImageFilter.h.

◆ SetMaskOutput()

Self& itk::simple::OtsuThresholdImageFilter::SetMaskOutput ( bool MaskOutput )

inline

Do you want the output to be masked by the mask used in histogram construction. Only relevant if masking is in use.

Definition at line 103 of file sitkOtsuThresholdImageFilter.h.

◆ SetMaskValue()

Self& itk::simple::OtsuThresholdImageFilter::SetMaskValue ( uint8_t MaskValue )

inline

The value in the mask image, if used, indicating voxels that should be included. Default is the max of pixel type, as in the MaskedImageToHistogramFilter

Definition at line 116 of file sitkOtsuThresholdImageFilter.h.