itk::OtsuThresholdImageFilter< TInputImage, TOutputImage > Class Template Reference
[Intensity Image Filters, Multithreaded Filters]

Threshold an image using the Otsu Threshold. More...

#include <itkOtsuThresholdImageFilter.h>

Inheritance diagram for itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >:

[legend]Collaboration diagram for itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >:

[legend]List of all members.

Public Types
typedef OtsuThresholdImageFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage::PixelType	InputPixelType
typedef TOutputImage::PixelType	OutputPixelType
typedef TInputImage::Pointer	InputImagePointer
typedef TOutputImage::Pointer	OutputImagePointer
typedef TInputImage::SizeType	InputSizeType
typedef TInputImage::IndexType	InputIndexType
typedef TInputImage::RegionType	InputImageRegionType
typedef TOutputImage::SizeType	OutputSizeType
typedef TOutputImage::IndexType	OutputIndexType
typedef TOutputImage::RegionType	OutputImageRegionType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual void	SetOutsideValue (OutputPixelType _arg)
virtual OutputPixelType	GetOutsideValue ()
virtual void	SetInsideValue (OutputPixelType _arg)
virtual OutputPixelType	GetInsideValue ()
virtual InputPixelType	GetThreshold ()
	itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
	itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)
virtual void	SetNumberOfHistogramBins (unsigned long _arg)
virtual unsigned long	GetNumberOfHistogramBins ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	OtsuThresholdImageFilter ()
	~OtsuThresholdImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	GenerateInputRequestedRegion ()
void	GenerateData ()

---

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >

Threshold an image using the Otsu Threshold.

This filter creates a binary thresholded image that separates an image into foreground and background components. The filter computes the threshold using the OtsuThresholdImageCalculator and applies that theshold to the input image using the BinaryThresholdImageFilter. The NunberOfHistogram bins can be set for the Calculator. The InsideValue and OutsideValue can be set for the BinaryThresholdImageFilter.

See also:

OtsuThresholdImageCalculator

BinaryThresholdImageFilter

Definition at line 42 of file itkOtsuThresholdImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage, class TOutputImage> typedef SmartPointer<const Self> itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 50 of file itkOtsuThresholdImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TInputImage::Pointer itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::InputImagePointer

Image related typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 63 of file itkOtsuThresholdImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TInputImage::RegionType itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 68 of file itkOtsuThresholdImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TInputImage::IndexType itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::InputIndexType

Definition at line 67 of file itkOtsuThresholdImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TInputImage::PixelType itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::InputPixelType

Image pixel value typedef. Definition at line 59 of file itkOtsuThresholdImageFilter.h. Referenced by itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::~OtsuThresholdImageFilter().

template<class TInputImage, class TOutputImage> typedef TInputImage::SizeType itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::InputSizeType

Definition at line 66 of file itkOtsuThresholdImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TOutputImage::Pointer itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 64 of file itkOtsuThresholdImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TOutputImage::RegionType itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Superclass typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 71 of file itkOtsuThresholdImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TOutputImage::IndexType itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::OutputIndexType

Definition at line 70 of file itkOtsuThresholdImageFilter.h.

template<class TInputImage, class TOutputImage> typedef TOutputImage::PixelType itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::OutputPixelType

Definition at line 60 of file itkOtsuThresholdImageFilter.h. Referenced by itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::~OtsuThresholdImageFilter().

template<class TInputImage, class TOutputImage> typedef TOutputImage::SizeType itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::OutputSizeType

Definition at line 69 of file itkOtsuThresholdImageFilter.h.

template<class TInputImage, class TOutputImage> typedef SmartPointer<Self> itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::Pointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 49 of file itkOtsuThresholdImageFilter.h.

template<class TInputImage, class TOutputImage> typedef OtsuThresholdImageFilter itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::Self

Standard Self typedef Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 47 of file itkOtsuThresholdImageFilter.h. Referenced by itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::~OtsuThresholdImageFilter().

template<class TInputImage, class TOutputImage> typedef ImageToImageFilter<TInputImage,TOutputImage> itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 48 of file itkOtsuThresholdImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage> itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::OtsuThresholdImageFilter (   )  [protected]

template<class TInputImage, class TOutputImage> itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::~OtsuThresholdImageFilter (   )  [inline, protected]

Definition at line 107 of file itkOtsuThresholdImageFilter.h. References itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::InputPixelType, itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::OutputPixelType, and itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::Self.

---

Member Function Documentation

template<class TInputImage, class TOutputImage> void itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::GenerateData (   )  [protected, virtual]

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead. See also: ThreadedGenerateData() Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage> void itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion (   )  [protected, virtual]

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierachy. Up till now, the base assumption has been that the largest possible region will be requested of the input. This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types. See also: ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion() Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual OutputPixelType itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::GetInsideValue (   )  [virtual]

Get the "inside" pixel value.

template<class TInputImage, class TOutputImage> virtual const char* itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::GetNameOfClass (   )  const [virtual]

Runtime information support. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual unsigned long itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::GetNumberOfHistogramBins (   )  [virtual]

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

template<class TInputImage, class TOutputImage> virtual OutputPixelType itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::GetOutsideValue (   )  [virtual]

Get the "outside" pixel value.

template<class TInputImage, class TOutputImage> virtual InputPixelType itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::GetThreshold (   )  [virtual]

Get the computed threshold.

template<class TInputImage, class TOutputImage> itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro (  OutputImageDimension  , unsigned  int, TOutputImage::ImageDimension  )

Image related typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro (  InputImageDimension  , unsigned  int, TInputImage::ImageDimension  )

Image related typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> Pointer itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::New (   )  [static]

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

template<class TInputImage, class TOutputImage> void itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::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::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage> virtual void itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::SetInsideValue (  OutputPixelType  _arg  )  [virtual]

Set the "inside" pixel value. The default value NumericTraits<OutputPixelType>::max()

template<class TInputImage, class TOutputImage> virtual void itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::SetNumberOfHistogramBins (  unsigned long  _arg  )  [virtual]

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

template<class TInputImage, class TOutputImage> virtual void itk::OtsuThresholdImageFilter< TInputImage, TOutputImage >::SetOutsideValue (  OutputPixelType  _arg  )  [virtual]

Set the "outside" pixel value. The default value NumericTraits<OutputPixelType>::Zero.

---

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

• itkOtsuThresholdImageFilter.h

---