SimpleITK  1.0.1
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

typedef BasicPixelIDTypeList PixelIDTypeList
typedef OtsuMultipleThresholdsImageFilter Self
- Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter Self
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self

Public Member Functions

Image Execute (const Image &image1)
Image Execute (const Image &image1, uint8_t numberOfThresholds, uint8_t labelOffset, uint32_t numberOfHistogramBins, bool valleyEmphasis)
uint8_t GetLabelOffset () const
std::string GetName () const
uint32_t GetNumberOfHistogramBins () const
uint8_t GetNumberOfThresholds () const
std::vector< double > GetThresholds () const
bool GetValleyEmphasis () const
 OtsuMultipleThresholdsImageFilter ()
SelfSetLabelOffset (uint8_t LabelOffset)
SelfSetNumberOfHistogramBins (uint32_t NumberOfHistogramBins)
SelfSetNumberOfThresholds (uint8_t NumberOfThresholds)
SelfSetValleyEmphasis (bool ValleyEmphasis)
std::string ToString () const
SelfValleyEmphasisOff ()
SelfValleyEmphasisOn ()
 ~OtsuMultipleThresholdsImageFilter ()
- Public Member Functions inherited from itk::simple::ImageFilter< 1 >
 ImageFilter ()
virtual ~ImageFilter ()=0
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
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

Private Types

typedef Image(Self::* MemberFunctionType) (const Image &image1)

Private Member Functions

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

Private Attributes

uint8_t m_LabelOffset
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
uint32_t m_NumberOfHistogramBins
uint8_t m_NumberOfThresholds
std::vector< double > m_Thresholds
bool m_ValleyEmphasis


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 void SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int GetGlobalDefaultNumberOfThreads ()
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...
- 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) throw ()
virtual void PreUpdate (itk::ProcessObject *p)
virtual void RemoveITKObserver (EventCommand &e)
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()
- Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
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 TImageType >
static Image CastITKToImage (TImageType *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)
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 50 of file sitkOtsuMultipleThresholdsImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::OtsuMultipleThresholdsImageFilter::MemberFunctionType) (const Image &image1)

Setup for member function dispatching

Definition at line 136 of file sitkOtsuMultipleThresholdsImageFilter.h.

Define the pixels types supported by this filter

Definition at line 62 of file sitkOtsuMultipleThresholdsImageFilter.h.

Definition at line 52 of file sitkOtsuMultipleThresholdsImageFilter.h.

Constructor & Destructor Documentation

itk::simple::OtsuMultipleThresholdsImageFilter::OtsuMultipleThresholdsImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

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


Member Function Documentation

Image itk::simple::OtsuMultipleThresholdsImageFilter::Execute ( const Image image1)

Execute the filter on the input image

Image itk::simple::OtsuMultipleThresholdsImageFilter::Execute ( const Image image1,
uint8_t  numberOfThresholds,
uint8_t  labelOffset,
uint32_t  numberOfHistogramBins,
bool  valleyEmphasis 

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::OtsuMultipleThresholdsImageFilter::ExecuteInternal ( const Image image1)
uint8_t itk::simple::OtsuMultipleThresholdsImageFilter::GetLabelOffset ( ) const

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

Definition at line 84 of file sitkOtsuMultipleThresholdsImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 118 of file sitkOtsuMultipleThresholdsImageFilter.h.

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

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

Definition at line 94 of file sitkOtsuMultipleThresholdsImageFilter.h.

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

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

Definition at line 74 of file sitkOtsuMultipleThresholdsImageFilter.h.

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

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

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

Definition at line 108 of file sitkOtsuMultipleThresholdsImageFilter.h.

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

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

Definition at line 79 of file sitkOtsuMultipleThresholdsImageFilter.h.

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

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

Definition at line 89 of file sitkOtsuMultipleThresholdsImageFilter.h.

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

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

Definition at line 69 of file sitkOtsuMultipleThresholdsImageFilter.h.

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

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

Definition at line 99 of file sitkOtsuMultipleThresholdsImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

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

Definition at line 103 of file sitkOtsuMultipleThresholdsImageFilter.h.

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

Set the value of ValleyEmphasis to true or false respectfully.

Definition at line 102 of file sitkOtsuMultipleThresholdsImageFilter.h.

Friends And Related Function Documentation

Definition at line 141 of file sitkOtsuMultipleThresholdsImageFilter.h.

Member Data Documentation

uint8_t itk::simple::OtsuMultipleThresholdsImageFilter::m_LabelOffset

Definition at line 147 of file sitkOtsuMultipleThresholdsImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::OtsuMultipleThresholdsImageFilter::m_MemberFactory

Definition at line 143 of file sitkOtsuMultipleThresholdsImageFilter.h.

uint32_t itk::simple::OtsuMultipleThresholdsImageFilter::m_NumberOfHistogramBins

Definition at line 148 of file sitkOtsuMultipleThresholdsImageFilter.h.

uint8_t itk::simple::OtsuMultipleThresholdsImageFilter::m_NumberOfThresholds

Definition at line 146 of file sitkOtsuMultipleThresholdsImageFilter.h.

std::vector<double> itk::simple::OtsuMultipleThresholdsImageFilter::m_Thresholds

Definition at line 152 of file sitkOtsuMultipleThresholdsImageFilter.h.

bool itk::simple::OtsuMultipleThresholdsImageFilter::m_ValleyEmphasis

Definition at line 150 of file sitkOtsuMultipleThresholdsImageFilter.h.

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