itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage > Class Template Reference

Computes the Otsu's threshold for an image. More...

#include <itkRemovePeaksOtsuThresholdImageCalculator.h>

Inheritance diagram for itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >:

Collaboration diagram for itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage::ConstPointer	ImageConstPointer
	Const Pointer type for the image. More...
typedef TInputImage::Pointer	ImagePointer
	Pointer type for the image. More...
typedef TInputImage	ImageType
	Type definition for the input image. More...
typedef TInputImage::PixelType	PixelType
	Type definition for the input image pixel type. More...
typedef SmartPointer< Self >	Pointer
typedef TInputImage::RegionType	RegionType
	Type definition for the input image region type. More...
typedef RemovePeaksOtsuThresholdImageCalculator	Self
	Standard class typedefs. More...
typedef Object	Superclass

Public Member Functions
void	Compute (void)
	Compute the Otsu's threshold for the input image. More...
	itkGetMacro (NumberOfHistogramBins, unsigned long)
	itkGetMacro (Threshold, PixelType)
	Return the Otsu's threshold value. More...
	itkNewMacro (Self)
	Method for creation through the object factory. More...
	itkSetClampMacro (NumberOfHistogramBins, unsigned long, 1, NumericTraits< unsigned long >::max())
	Set/Get the number of histogram bins. More...
	itkSetConstObjectMacro (Image, ImageType)
	Set the input image. More...
	itkTypeMacro (RemovePeaksOtsuThresholdImageCalculator, Object)
	Run-time type information (and related methods). More...
void	SetRegion (const RegionType &region)
	Set the region over which the values will be computed. More...

Protected Member Functions
	RemovePeaksOtsuThresholdImageCalculator ()
virtual	~RemovePeaksOtsuThresholdImageCalculator ()
void	PrintSelf (std::ostream &os, Indent indent) const override

Detailed Description

template<class TInputImage>
class itk::RemovePeaksOtsuThresholdImageCalculator< 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.

Member Typedef Documentation

ConstPointer

template<class TInputImage >

typedef SmartPointer<const Self> itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::ConstPointer

ImageConstPointer

template<class TInputImage >

typedef TInputImage::ConstPointer itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::ImageConstPointer

Const Pointer type for the image.

ImagePointer

template<class TInputImage >

typedef TInputImage::Pointer itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::ImagePointer

Pointer type for the image.

ImageType

template<class TInputImage >

typedef TInputImage itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::ImageType

Type definition for the input image.

PixelType

template<class TInputImage >

typedef TInputImage::PixelType itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::PixelType

Type definition for the input image pixel type.

Pointer

template<class TInputImage >

typedef SmartPointer<Self> itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::Pointer

RegionType

template<class TInputImage >

typedef TInputImage::RegionType itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::RegionType

Type definition for the input image region type.

Self

template<class TInputImage >

typedef RemovePeaksOtsuThresholdImageCalculator itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::Self

Standard class typedefs.

Superclass

template<class TInputImage >

typedef Object itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::Superclass

Constructor & Destructor Documentation

RemovePeaksOtsuThresholdImageCalculator()

template<class TInputImage >

itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::RemovePeaksOtsuThresholdImageCalculator ( )

protected

~RemovePeaksOtsuThresholdImageCalculator()

template<class TInputImage >

virtual itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::~RemovePeaksOtsuThresholdImageCalculator ( )

inlineprotectedvirtual

Member Function Documentation

Compute()

template<class TInputImage >

void itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::Compute

(

void

)

Compute the Otsu's threshold for the input image.

itkGetMacro() [1/2]

template<class TInputImage >

itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::itkGetMacro	(	NumberOfHistogramBins	,
		unsigned long
	)

itkGetMacro() [2/2]

template<class TInputImage >

itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::itkGetMacro	(	Threshold	,
		PixelType
	)

Return the Otsu's threshold value.

itkNewMacro()

template<class TInputImage >

itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::itkNewMacro

(

Self

)

Method for creation through the object factory.

itkSetClampMacro()

template<class TInputImage >

itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::itkSetClampMacro	(	NumberOfHistogramBins	,
		unsigned long	,
		1	,
		NumericTraits< unsigned long >	::max()
	)

Set/Get the number of histogram bins.

Default is 128.

itkSetConstObjectMacro()

template<class TInputImage >

itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::itkSetConstObjectMacro	(	Image	,
		ImageType
	)

Set the input image.

itkTypeMacro()

template<class TInputImage >

itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::itkTypeMacro	(	RemovePeaksOtsuThresholdImageCalculator< TInputImage >	,
		Object
	)

Run-time type information (and related methods).

PrintSelf()

template<class TInputImage >

void itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotected

SetRegion()

template<class TInputImage >

void itk::RemovePeaksOtsuThresholdImageCalculator< TInputImage >::SetRegion

(

const RegionType &

region

)

Set the region over which the values will be computed.

---

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

• Toolkit/RemovePeaksOtsu/itkRemovePeaksOtsuThresholdImageCalculator.h