itk::OtsuMultipleThresholdsCalculator< TInputHistogram > Class Template Reference

#include <itkOtsuMultipleThresholdsCalculator.h>

Inheritance diagram for itk::OtsuMultipleThresholdsCalculator< TInputHistogram >:

[legend]Collaboration diagram for itk::OtsuMultipleThresholdsCalculator< TInputHistogram >:

[legend]List of all members.

---

Detailed Description

template<class TInputHistogram>
class itk::OtsuMultipleThresholdsCalculator< TInputHistogram >

Computes Otsu's thresholds for a histogram.

You plug in the target histogram using SetInputHistogram method and specify the number of thresholds you want to be computed. Then call the GenerateData method to run the alogithm.

The thresholds are computed so that the between-class variance is maximized.

Definition at line 40 of file itkOtsuMultipleThresholdsCalculator.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TInputHistogram::FrequencyType	FrequencyType
typedef std::vector< FrequencyType >	FrequencyVectorType
typedef TInputHistogram	InputHistogramType
typedef TInputHistogram::InstanceIdentifier	InstanceIdentifierType
typedef std::vector< InstanceIdentifierType >	InstanceIdentifierVectorType
typedef NumericTraits< MeasurementType >::RealType	MeanType
typedef std::vector< MeanType >	MeanVectorType
typedef TInputHistogram::MeasurementType	MeasurementType
typedef std::vector< MeasurementType >	OutputType
typedef SmartPointer< Self >	Pointer
typedef OtsuMultipleThresholdsCalculator	Self
typedef HistogramAlgorithmBase< TInputHistogram >	Superclass
typedef NumericTraits< MeasurementType >::RealType	VarianceType
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
const TInputHistogram *	GetInputHistogram () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
Standard Macros *virtual const char *	GetNameOfClass () const
virtual unsigned long	GetNumberOfThresholds ()
const OutputType &	GetOutput ()
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
Stores the histogram pointer *void	SetInputHistogram (const TInputHistogram *histogram)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
Set Get the number of thresholds *virtual void	SetNumberOfThresholds (unsigned long _arg)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
void	Update ()
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
void	GenerateData ()
bool	IncrementThresholds (InstanceIdentifierVectorType &thresholdIds, MeanType totalMean, MeanVectorType &classMean, FrequencyVectorType &classFrequency)
	OtsuMultipleThresholdsCalculator ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~OtsuMultipleThresholdsCalculator ()
Protected Attributes
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Methods invoked by virtual 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.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

Member Typedef Documentation

template<class TInputHistogram> typedef SmartPointer<const Self> itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::ConstPointer

Reimplemented from itk::HistogramAlgorithmBase< TInputHistogram >. Definition at line 48 of file itkOtsuMultipleThresholdsCalculator.h.

template<class TInputHistogram> typedef TInputHistogram::FrequencyType itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::FrequencyType

Definition at line 51 of file itkOtsuMultipleThresholdsCalculator.h.

template<class TInputHistogram> typedef std::vector<FrequencyType> itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::FrequencyVectorType

Definition at line 57 of file itkOtsuMultipleThresholdsCalculator.h.

template<class TInputHistogram> typedef TInputHistogram itk::HistogramAlgorithmBase< TInputHistogram >::InputHistogramType [inherited]

Histogram typedefs alias Definition at line 47 of file itkHistogramAlgorithmBase.h.

template<class TInputHistogram> typedef TInputHistogram::InstanceIdentifier itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::InstanceIdentifierType

Definition at line 59 of file itkOtsuMultipleThresholdsCalculator.h.

template<class TInputHistogram> typedef std::vector<InstanceIdentifierType> itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::InstanceIdentifierVectorType

Definition at line 60 of file itkOtsuMultipleThresholdsCalculator.h.

template<class TInputHistogram> typedef NumericTraits<MeasurementType>::RealType itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::MeanType

Definition at line 53 of file itkOtsuMultipleThresholdsCalculator.h.

template<class TInputHistogram> typedef std::vector<MeanType> itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::MeanVectorType

Definition at line 56 of file itkOtsuMultipleThresholdsCalculator.h.

template<class TInputHistogram> typedef TInputHistogram::MeasurementType itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::MeasurementType

Definition at line 50 of file itkOtsuMultipleThresholdsCalculator.h.

template<class TInputHistogram> typedef std::vector<MeasurementType> itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::OutputType

Typedef for the thresholds output Definition at line 64 of file itkOtsuMultipleThresholdsCalculator.h.

template<class TInputHistogram> typedef SmartPointer<Self> itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::Pointer

Reimplemented from itk::HistogramAlgorithmBase< TInputHistogram >. Definition at line 47 of file itkOtsuMultipleThresholdsCalculator.h.

template<class TInputHistogram> typedef OtsuMultipleThresholdsCalculator itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::Self

Standard class typedefs. Reimplemented from itk::HistogramAlgorithmBase< TInputHistogram >. Definition at line 45 of file itkOtsuMultipleThresholdsCalculator.h.

template<class TInputHistogram> typedef HistogramAlgorithmBase<TInputHistogram> itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::Superclass

Reimplemented from itk::HistogramAlgorithmBase< TInputHistogram >. Definition at line 46 of file itkOtsuMultipleThresholdsCalculator.h.

template<class TInputHistogram> typedef NumericTraits<MeasurementType>::RealType itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::VarianceType

Definition at line 54 of file itkOtsuMultipleThresholdsCalculator.h.

---

Constructor & Destructor Documentation

template<class TInputHistogram> itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::OtsuMultipleThresholdsCalculator (   )  [protected]

template<class TInputHistogram> virtual itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::~OtsuMultipleThresholdsCalculator (   )  [inline, protected, virtual]

Definition at line 80 of file itkOtsuMultipleThresholdsCalculator.h.

---

Member Function Documentation

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]

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::LightObject.

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

template<class TInputHistogram> void itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::GenerateData (   )  [protected, virtual]

Calculates the thresholds and save them Implements itk::HistogramAlgorithmBase< TInputHistogram >.

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

template<class TInputHistogram> const TInputHistogram* itk::HistogramAlgorithmBase< TInputHistogram >::GetInputHistogram (   )  const [inline, inherited]

Returns the histogram const pointer Definition at line 64 of file itkHistogramAlgorithmBase.h.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

template<class TInputHistogram> Standard Macros* virtual const char* itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::GetNameOfClass (   )  const [virtual]

Standard Macros Reimplemented from itk::HistogramAlgorithmBase< TInputHistogram >.

template<class TInputHistogram> virtual unsigned long itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::GetNumberOfThresholds (   )  [virtual]

template<class TInputHistogram> const OutputType& itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::GetOutput (   )

Returns the thresholds vector

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

template<class TInputHistogram> bool itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::IncrementThresholds (  InstanceIdentifierVectorType &  thresholdIds, MeanType  totalMean, MeanVectorType &  classMean, FrequencyVectorType &  classFrequency )  [protected]

Increment the thresholds of one position

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TInputHistogram> static Pointer itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

template<class TInputHistogram> void itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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::HistogramAlgorithmBase< TInputHistogram >.

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

template<class TInputHistogram> Stores the histogram pointer* void itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram (  const TInputHistogram *  histogram  )  [inline, inherited]

Definition at line 53 of file itkHistogramAlgorithmBase.h. References itk::Object::Modified().

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

template<class TInputHistogram> Set Get the number of thresholds* virtual void itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::SetNumberOfThresholds (  unsigned long  _arg  )  [virtual]

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

template<class TInputHistogram> void itk::HistogramAlgorithmBase< TInputHistogram >::Update (   )  [inline, inherited]

dummy function that calls the GenerateData() function to generate output. It exists for future compatibility with ProcessObject without streaming Definition at line 70 of file itkHistogramAlgorithmBase.h. References itk::HistogramAlgorithmBase< TInputHistogram >::GenerateData().

---

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkOtsuMultipleThresholdsCalculator.h

---