ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::OtsuThresholdImageCalculator< TInputImage > Class Template Reference

#include <itkOtsuThresholdImageCalculator.h>

+ Inheritance diagram for itk::OtsuThresholdImageCalculator< TInputImage >:
+ Collaboration diagram for itk::OtsuThresholdImageCalculator< TInputImage >:

Detailed Description

template<typename TInputImage>
class itk::OtsuThresholdImageCalculator< TInputImage >

Computes the Otsu's threshold for an image.

This calculator computes the Otsu's threshold which separates an image into foreground and background components. The method relies on a histogram of image intensities. The basic idea is to maximize the between-class variance.

This class is templated over the input image type.

Warning
This method assumes that the input image consists of scalar pixel types.
Deprecated:

Definition at line 52 of file itkOtsuThresholdImageCalculator.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef TInputImage::ConstPointer ImageConstPointer
 
typedef TInputImage::Pointer ImagePointer
 
typedef TInputImage ImageType
 
typedef TInputImage::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef TInputImage::RegionType RegionType
 
typedef
OtsuThresholdImageCalculator 
Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

void Compute ()
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
virtual PixelType GetThreshold () const
 
virtual void SetImage (const ImageType *_arg)
 
void SetRegion (const RegionType &region)
 
virtual void SetNumberOfHistogramBins (SizeValueType _arg)
 
virtual SizeValueType GetNumberOfHistogramBins () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 OtsuThresholdImageCalculator ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~OtsuThresholdImageCalculator ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

void operator= (const Self &) ITK_DELETE_FUNCTION
 
 OtsuThresholdImageCalculator (const Self &) ITK_DELETE_FUNCTION
 

Private Attributes

ImageConstPointer m_Image
 
SizeValueType m_NumberOfHistogramBins
 
RegionType m_Region
 
bool m_RegionSetByUser
 
PixelType m_Threshold
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TInputImage >
typedef SmartPointer< const Self > itk::OtsuThresholdImageCalculator< TInputImage >::ConstPointer

Definition at line 59 of file itkOtsuThresholdImageCalculator.h.

template<typename TInputImage >
typedef TInputImage::ConstPointer itk::OtsuThresholdImageCalculator< TInputImage >::ImageConstPointer

Const Pointer type for the image.

Definition at line 74 of file itkOtsuThresholdImageCalculator.h.

template<typename TInputImage >
typedef TInputImage::Pointer itk::OtsuThresholdImageCalculator< TInputImage >::ImagePointer

Pointer type for the image.

Definition at line 71 of file itkOtsuThresholdImageCalculator.h.

template<typename TInputImage >
typedef TInputImage itk::OtsuThresholdImageCalculator< TInputImage >::ImageType

Type definition for the input image.

Definition at line 65 of file itkOtsuThresholdImageCalculator.h.

template<typename TInputImage >
typedef TInputImage::PixelType itk::OtsuThresholdImageCalculator< TInputImage >::PixelType

Type definition for the input image pixel type.

Definition at line 77 of file itkOtsuThresholdImageCalculator.h.

template<typename TInputImage >
typedef SmartPointer< Self > itk::OtsuThresholdImageCalculator< TInputImage >::Pointer

Definition at line 58 of file itkOtsuThresholdImageCalculator.h.

template<typename TInputImage >
typedef TInputImage::RegionType itk::OtsuThresholdImageCalculator< TInputImage >::RegionType

Type definition for the input image region type.

Definition at line 80 of file itkOtsuThresholdImageCalculator.h.

template<typename TInputImage >
typedef OtsuThresholdImageCalculator itk::OtsuThresholdImageCalculator< TInputImage >::Self

Standard class typedefs.

Definition at line 56 of file itkOtsuThresholdImageCalculator.h.

template<typename TInputImage >
typedef Object itk::OtsuThresholdImageCalculator< TInputImage >::Superclass

Definition at line 57 of file itkOtsuThresholdImageCalculator.h.

Constructor & Destructor Documentation

template<typename TInputImage >
itk::OtsuThresholdImageCalculator< TInputImage >::OtsuThresholdImageCalculator ( )
protected
template<typename TInputImage >
virtual itk::OtsuThresholdImageCalculator< TInputImage >::~OtsuThresholdImageCalculator ( )
inlineprotectedvirtual

Definition at line 102 of file itkOtsuThresholdImageCalculator.h.

template<typename TInputImage >
itk::OtsuThresholdImageCalculator< TInputImage >::OtsuThresholdImageCalculator ( const Self )
private

Member Function Documentation

template<typename TInputImage >
void itk::OtsuThresholdImageCalculator< TInputImage >::Compute ( )

Compute the Otsu's threshold for the input image.

template<typename TInputImage >
virtual::itk::LightObject::Pointer itk::OtsuThresholdImageCalculator< TInputImage >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<typename TInputImage >
virtual const char* itk::OtsuThresholdImageCalculator< TInputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

template<typename TInputImage >
virtual SizeValueType itk::OtsuThresholdImageCalculator< TInputImage >::GetNumberOfHistogramBins ( ) const
virtual

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

template<typename TInputImage >
virtual PixelType itk::OtsuThresholdImageCalculator< TInputImage >::GetThreshold ( ) const
virtual

Return the Otsu's threshold value.

template<typename TInputImage >
static Pointer itk::OtsuThresholdImageCalculator< TInputImage >::New ( )
static

Method for creation through the object factory.

template<typename TInputImage >
void itk::OtsuThresholdImageCalculator< TInputImage >::operator= ( const Self )
private
template<typename TInputImage >
virtual void itk::OtsuThresholdImageCalculator< TInputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Object.

template<typename TInputImage >
virtual void itk::OtsuThresholdImageCalculator< TInputImage >::SetImage ( const ImageType _arg)
virtual

Set the input image.

template<typename TInputImage >
virtual void itk::OtsuThresholdImageCalculator< TInputImage >::SetNumberOfHistogramBins ( SizeValueType  _arg)
virtual

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

template<typename TInputImage >
void itk::OtsuThresholdImageCalculator< TInputImage >::SetRegion ( const RegionType region)

Set the region over which the values will be computed

Member Data Documentation

template<typename TInputImage >
ImageConstPointer itk::OtsuThresholdImageCalculator< TInputImage >::m_Image
private

Definition at line 111 of file itkOtsuThresholdImageCalculator.h.

template<typename TInputImage >
SizeValueType itk::OtsuThresholdImageCalculator< TInputImage >::m_NumberOfHistogramBins
private

Definition at line 110 of file itkOtsuThresholdImageCalculator.h.

template<typename TInputImage >
RegionType itk::OtsuThresholdImageCalculator< TInputImage >::m_Region
private

Definition at line 112 of file itkOtsuThresholdImageCalculator.h.

template<typename TInputImage >
bool itk::OtsuThresholdImageCalculator< TInputImage >::m_RegionSetByUser
private

Definition at line 113 of file itkOtsuThresholdImageCalculator.h.

template<typename TInputImage >
PixelType itk::OtsuThresholdImageCalculator< TInputImage >::m_Threshold
private

Definition at line 109 of file itkOtsuThresholdImageCalculator.h.


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