SimpleITK  2.0.0rc2.post21
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
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:

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 ()
SelfReturnBinMidpointOff ()
SelfReturnBinMidpointOn ()
SelfSetLabelOffset (uint8_t LabelOffset)
SelfSetNumberOfHistogramBins (uint32_t NumberOfHistogramBins)
SelfSetNumberOfThresholds (uint8_t NumberOfThresholds)
SelfSetReturnBinMidpoint (bool ReturnBinMidpoint)
SelfSetValleyEmphasis (bool ValleyEmphasis)
std::string ToString () const
SelfValleyEmphasisOff ()
SelfValleyEmphasisOn ()
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. 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

uint8_t m_LabelOffset {0u}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
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}


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::ProcessObjectGetActiveProcess ()
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
NonCopyableoperator= (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<class TImageType >
static Image CastITKToImage (TImageType *img)
static const itk::EventObjectGetITKEventObject (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)

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
itk::simple::OtsuMultipleThresholds for the procedural interface
itk::OtsuMultipleThresholdsImageFilter for the Doxygen on the original ITK class.

Definition at line 52 of file sitkOtsuMultipleThresholdsImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 146 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 64 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ Self

Definition at line 54 of file sitkOtsuMultipleThresholdsImageFilter.h.

Constructor & Destructor Documentation

◆ ~OtsuMultipleThresholdsImageFilter()

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


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

◆ GetLabelOffset()

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

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

Definition at line 85 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 132 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ GetNumberOfHistogramBins()

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

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

Definition at line 95 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ GetNumberOfThresholds()

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

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

Definition at line 75 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ GetReturnBinMidpoint()

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

Definition at line 121 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ GetThresholds()

std::vector<double> itk::simple::OtsuMultipleThresholdsImageFilter::GetThresholds ( ) const

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 128 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ GetValleyEmphasis()

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

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

Definition at line 109 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ ReturnBinMidpointOff()

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

Definition at line 117 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ ReturnBinMidpointOn()

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

Set the value of ReturnBinMidpoint to true or false respectfully.

Definition at line 116 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ SetLabelOffset()

Self& itk::simple::OtsuMultipleThresholdsImageFilter::SetLabelOffset ( uint8_t  LabelOffset)

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

Definition at line 80 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ SetNumberOfHistogramBins()

Self& itk::simple::OtsuMultipleThresholdsImageFilter::SetNumberOfHistogramBins ( uint32_t  NumberOfHistogramBins)

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

Definition at line 90 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ SetNumberOfThresholds()

Self& itk::simple::OtsuMultipleThresholdsImageFilter::SetNumberOfThresholds ( uint8_t  NumberOfThresholds)

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

Definition at line 70 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ SetReturnBinMidpoint()

Self& itk::simple::OtsuMultipleThresholdsImageFilter::SetReturnBinMidpoint ( bool  ReturnBinMidpoint)

Definition at line 113 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ SetValleyEmphasis()

Self& itk::simple::OtsuMultipleThresholdsImageFilter::SetValleyEmphasis ( bool  ValleyEmphasis)

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

Definition at line 100 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

◆ ValleyEmphasisOff()

Self& itk::simple::OtsuMultipleThresholdsImageFilter::ValleyEmphasisOff ( )

Definition at line 104 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ ValleyEmphasisOn()

Self& itk::simple::OtsuMultipleThresholdsImageFilter::ValleyEmphasisOn ( )

Set the value of ValleyEmphasis to true or false respectfully.

Definition at line 103 of file sitkOtsuMultipleThresholdsImageFilter.h.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 150 of file sitkOtsuMultipleThresholdsImageFilter.h.

Member Data Documentation

◆ m_LabelOffset

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

Definition at line 157 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::OtsuMultipleThresholdsImageFilter::m_MemberFactory

Definition at line 152 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ m_NumberOfHistogramBins

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

Definition at line 159 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ m_NumberOfThresholds

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

Definition at line 155 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ m_ReturnBinMidpoint

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

Definition at line 164 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ m_Thresholds

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

Definition at line 167 of file sitkOtsuMultipleThresholdsImageFilter.h.

◆ m_ValleyEmphasis

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

Definition at line 162 of file sitkOtsuMultipleThresholdsImageFilter.h.

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