itk::simple::OtsuMultipleThresholdsImageFilter Class Reference

Threshold an image using multiple Otsu Thresholds. More...

#include <sitkOtsuMultipleThresholdsImageFilter.h>

Inheritance diagram for itk::simple::OtsuMultipleThresholdsImageFilter:

Collaboration diagram for itk::simple::OtsuMultipleThresholdsImageFilter:

Detailed Description

Threshold an image using multiple Otsu Thresholds.

This filter creates a labeled image that separates the input image into various classes. The filter computes the thresholds using the OtsuMultipleThresholdsCalculator and applies those thresholds to the input image using the ThresholdLabelerImageFilter . The NumberOfHistogramBins and NumberOfThresholds can be set for the Calculator. The LabelOffset can be set for the ThresholdLabelerImageFilter .

This filter also includes an option to use the valley emphasis algorithm from H.F. Ng, "Automatic thresholding for defect detection", Pattern Recognition Letters, (27): 1644-1649, 2006. The valley emphasis algorithm is particularly effective when the object to be thresholded is small. See the following tests for examples: itkOtsuMultipleThresholdsImageFilterTest3 and itkOtsuMultipleThresholdsImageFilterTest4 To use this algorithm, simple call the setter: SetValleyEmphasis(true) It is turned off by default.

See also

ScalarImageToHistogramGenerator

OtsuMultipleThresholdsCalculator

ThresholdLabelerImageFilter

itk::simple::OtsuMultipleThresholds for the procedural interface

itk::OtsuMultipleThresholdsImageFilter for the Doxygen on the original ITK class.

Definition at line 60 of file sitkOtsuMultipleThresholdsImageFilter.h.

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList
using	Self = OtsuMultipleThresholdsImageFilter
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 &image1)
uint8_t	GetLabelOffset () const
std::string	GetName () const
uint32_t	GetNumberOfHistogramBins () const
uint8_t	GetNumberOfThresholds () const
bool	GetReturnBinMidpoint () const
std::vector< double >	GetThresholds () const
bool	GetValleyEmphasis () const
	OtsuMultipleThresholdsImageFilter ()
void	ReturnBinMidpointOff ()
void	ReturnBinMidpointOn ()
void	SetLabelOffset (uint8_t LabelOffset)
void	SetNumberOfHistogramBins (uint32_t NumberOfHistogramBins)
void	SetNumberOfThresholds (uint8_t NumberOfThresholds)
void	SetReturnBinMidpoint (bool ReturnBinMidpoint)
void	SetValleyEmphasis (bool ValleyEmphasis)
std::string	ToString () const
void	ValleyEmphasisOff ()
void	ValleyEmphasisOn ()
virtual	~OtsuMultipleThresholdsImageFilter ()
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.
virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event.
virtual float	GetProgress () const
	An Active Measurement of the progress of execution.
virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event.
	ProcessObject ()
virtual void	RemoveAllCommands ()
	Remove all registered commands.
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)

Static Private Member Functions
static const detail::MemberFunctionFactory< MemberFunctionType > &	GetMemberFunctionFactory ()

Private Attributes
uint8_t	m_LabelOffset { 0u }
uint32_t	m_NumberOfHistogramBins { 128u }
uint8_t	m_NumberOfThresholds { 1u }
bool	m_ReturnBinMidpoint { false }
std::vector< double >	m_Thresholds { std::vector<double>() }
bool	m_ValleyEmphasis { false }

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.
static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces.
static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces.
static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces.
static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects.
static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects.
static void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects.
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::OtsuMultipleThresholdsImageFilter::MemberFunctionType = Image (Self::*)(const Image &image1)

private

Setup for member function dispatching

Definition at line 175 of file sitkOtsuMultipleThresholdsImageFilter.h.

PixelIDTypeList

using itk::simple::OtsuMultipleThresholdsImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 72 of file sitkOtsuMultipleThresholdsImageFilter.h.

Self

using itk::simple::OtsuMultipleThresholdsImageFilter::Self = OtsuMultipleThresholdsImageFilter

Definition at line 62 of file sitkOtsuMultipleThresholdsImageFilter.h.

Constructor & Destructor Documentation

~OtsuMultipleThresholdsImageFilter()

virtual itk::simple::OtsuMultipleThresholdsImageFilter::~OtsuMultipleThresholdsImageFilter ( )

virtual

Destructor

OtsuMultipleThresholdsImageFilter()

itk::simple::OtsuMultipleThresholdsImageFilter::OtsuMultipleThresholdsImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Execute()

Image itk::simple::OtsuMultipleThresholdsImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

ExecuteInternal()

template<class TImageType>

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

private

Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.

GetLabelOffset()

uint8_t itk::simple::OtsuMultipleThresholdsImageFilter::GetLabelOffset ( ) const

inline

Set/Get the offset which labels have to start from. Default is 0.

Definition at line 100 of file sitkOtsuMultipleThresholdsImageFilter.h.

References m_LabelOffset.

GetMemberFunctionFactory()

static const detail::MemberFunctionFactory< MemberFunctionType > & itk::simple::OtsuMultipleThresholdsImageFilter::GetMemberFunctionFactory ( )

staticprivate

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 163 of file sitkOtsuMultipleThresholdsImageFilter.h.

GetNumberOfHistogramBins()

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

inline

Set/Get the number of histogram bins. Default is 128.

Definition at line 113 of file sitkOtsuMultipleThresholdsImageFilter.h.

References m_NumberOfHistogramBins.

GetNumberOfThresholds()

uint8_t itk::simple::OtsuMultipleThresholdsImageFilter::GetNumberOfThresholds ( ) const

inline

Set/Get the number of thresholds. Default is 1.

Definition at line 87 of file sitkOtsuMultipleThresholdsImageFilter.h.

References m_NumberOfThresholds.

GetReturnBinMidpoint()

bool itk::simple::OtsuMultipleThresholdsImageFilter::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 151 of file sitkOtsuMultipleThresholdsImageFilter.h.

References m_ReturnBinMidpoint.

GetThresholds()

std::vector< double > itk::simple::OtsuMultipleThresholdsImageFilter::GetThresholds ( ) 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 160 of file sitkOtsuMultipleThresholdsImageFilter.h.

References m_Thresholds.

GetValleyEmphasis()

bool itk::simple::OtsuMultipleThresholdsImageFilter::GetValleyEmphasis ( ) const

inline

Set/Get the use of valley emphasis. Default is false.

Definition at line 132 of file sitkOtsuMultipleThresholdsImageFilter.h.

References m_ValleyEmphasis.

ReturnBinMidpointOff()

void itk::simple::OtsuMultipleThresholdsImageFilter::ReturnBinMidpointOff ( )

inline

Definition at line 146 of file sitkOtsuMultipleThresholdsImageFilter.h.

References SetReturnBinMidpoint().

ReturnBinMidpointOn()

void itk::simple::OtsuMultipleThresholdsImageFilter::ReturnBinMidpointOn ( )

inline

Set the value of ReturnBinMidpoint to true or false respectfully.

Definition at line 144 of file sitkOtsuMultipleThresholdsImageFilter.h.

References SetReturnBinMidpoint().

SetLabelOffset()

void itk::simple::OtsuMultipleThresholdsImageFilter::SetLabelOffset ( uint8_t LabelOffset )

inline

Set/Get the offset which labels have to start from. Default is 0.

Definition at line 94 of file sitkOtsuMultipleThresholdsImageFilter.h.

References m_LabelOffset.

SetNumberOfHistogramBins()

void itk::simple::OtsuMultipleThresholdsImageFilter::SetNumberOfHistogramBins ( uint32_t NumberOfHistogramBins )

inline

Set/Get the number of histogram bins. Default is 128.

Definition at line 107 of file sitkOtsuMultipleThresholdsImageFilter.h.

References m_NumberOfHistogramBins.

SetNumberOfThresholds()

void itk::simple::OtsuMultipleThresholdsImageFilter::SetNumberOfThresholds ( uint8_t NumberOfThresholds )

inline

Set/Get the number of thresholds. Default is 1.

Definition at line 81 of file sitkOtsuMultipleThresholdsImageFilter.h.

References m_NumberOfThresholds.

SetReturnBinMidpoint()

void itk::simple::OtsuMultipleThresholdsImageFilter::SetReturnBinMidpoint ( bool ReturnBinMidpoint )

inline

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

Definition at line 139 of file sitkOtsuMultipleThresholdsImageFilter.h.

References m_ReturnBinMidpoint.

Referenced by ReturnBinMidpointOff(), and ReturnBinMidpointOn().

SetValleyEmphasis()

void itk::simple::OtsuMultipleThresholdsImageFilter::SetValleyEmphasis ( bool ValleyEmphasis )

inline

Set/Get the use of valley emphasis. Default is false.

Definition at line 120 of file sitkOtsuMultipleThresholdsImageFilter.h.

References m_ValleyEmphasis.

Referenced by ValleyEmphasisOff(), and ValleyEmphasisOn().

ToString()

std::string itk::simple::OtsuMultipleThresholdsImageFilter::ToString ( ) const

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

ValleyEmphasisOff()

void itk::simple::OtsuMultipleThresholdsImageFilter::ValleyEmphasisOff ( )

inline

Definition at line 127 of file sitkOtsuMultipleThresholdsImageFilter.h.

References SetValleyEmphasis().

ValleyEmphasisOn()

void itk::simple::OtsuMultipleThresholdsImageFilter::ValleyEmphasisOn ( )

inline

Set the value of ValleyEmphasis to true or false respectfully.

Definition at line 125 of file sitkOtsuMultipleThresholdsImageFilter.h.

References SetValleyEmphasis().

Friends And Related Symbol Documentation

detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 176 of file sitkOtsuMultipleThresholdsImageFilter.h.

References ExecuteInternal().

Member Data Documentation

m_LabelOffset

uint8_t itk::simple::OtsuMultipleThresholdsImageFilter::m_LabelOffset { 0u }

private

Definition at line 183 of file sitkOtsuMultipleThresholdsImageFilter.h.

Referenced by GetLabelOffset(), and SetLabelOffset().

m_NumberOfHistogramBins

uint32_t itk::simple::OtsuMultipleThresholdsImageFilter::m_NumberOfHistogramBins { 128u }

private

Definition at line 185 of file sitkOtsuMultipleThresholdsImageFilter.h.

Referenced by GetNumberOfHistogramBins(), and SetNumberOfHistogramBins().

m_NumberOfThresholds

uint8_t itk::simple::OtsuMultipleThresholdsImageFilter::m_NumberOfThresholds { 1u }

private

Definition at line 181 of file sitkOtsuMultipleThresholdsImageFilter.h.

Referenced by GetNumberOfThresholds(), and SetNumberOfThresholds().

m_ReturnBinMidpoint

bool itk::simple::OtsuMultipleThresholdsImageFilter::m_ReturnBinMidpoint { false }

private

Definition at line 189 of file sitkOtsuMultipleThresholdsImageFilter.h.

Referenced by GetReturnBinMidpoint(), and SetReturnBinMidpoint().

m_Thresholds

std::vector<double> itk::simple::OtsuMultipleThresholdsImageFilter::m_Thresholds { std::vector<double>() }

private

Definition at line 193 of file sitkOtsuMultipleThresholdsImageFilter.h.

Referenced by GetThresholds().

m_ValleyEmphasis

bool itk::simple::OtsuMultipleThresholdsImageFilter::m_ValleyEmphasis { false }

private

Definition at line 187 of file sitkOtsuMultipleThresholdsImageFilter.h.

Referenced by GetValleyEmphasis(), and SetValleyEmphasis().

---

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

• sitkOtsuMultipleThresholdsImageFilter.h