open_iA  2020.04
A tool for the visual analysis and processing of volumetric datasets, with a focus on industrial computed tomography.
Public Types | Public Member Functions | Protected Member Functions | List of all members
itk::RemovePeaksOtsuThresholdImageFilter< TInputImage, TOutputImage > Class Template Reference

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

#include <itkRemovePeaksOtsuThresholdImageFilter.h>

Inheritance diagram for itk::RemovePeaksOtsuThresholdImageFilter< TInputImage, TOutputImage >:
Collaboration diagram for itk::RemovePeaksOtsuThresholdImageFilter< TInputImage, TOutputImage >:

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef TInputImage::Pointer InputImagePointer
 Image related typedefs. More...
 
typedef TInputImage::RegionType InputImageRegionType
 
typedef TInputImage::IndexType InputIndexType
 
typedef TInputImage::PixelType InputPixelType
 Image pixel value typedef. More...
 
typedef TInputImage::SizeType InputSizeType
 
typedef TOutputImage::Pointer OutputImagePointer
 
typedef TOutputImage::RegionType OutputImageRegionType
 
typedef TOutputImage::IndexType OutputIndexType
 
typedef TOutputImage::PixelType OutputPixelType
 
typedef TOutputImage::SizeType OutputSizeType
 
typedef SmartPointer< SelfPointer
 
typedef RemovePeaksOtsuThresholdImageFilter Self
 Standard Self typedef. More...
 
typedef ImageToImageFilter< TInputImage, TOutputImage > Superclass
 

Public Member Functions

 itkGetMacro (InsideValue, OutputPixelType)
 Get the "inside" pixel value. More...
 
 itkGetMacro (NumberOfHistogramBins, unsigned long)
 
 itkGetMacro (OutsideValue, OutputPixelType)
 Get the "outside" pixel value. More...
 
 itkGetMacro (Threshold, InputPixelType)
 Get the computed threshold. 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...
 
 itkSetMacro (InsideValue, OutputPixelType)
 Set the "inside" pixel value. More...
 
 itkSetMacro (OutsideValue, OutputPixelType)
 Set the "outside" pixel value. More...
 
 itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
 Image related typedefs. More...
 
 itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)
 
 itkTypeMacro (RemovePeaksOtsuThresholdImageFilter, ImageToImageFilter)
 Runtime information support. More...
 

Protected Member Functions

void GenerateData () override
 
void GenerateInputRequestedRegion () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 RemovePeaksOtsuThresholdImageFilter ()
 
 ~RemovePeaksOtsuThresholdImageFilter ()
 

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::RemovePeaksOtsuThresholdImageFilter< 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 RemovePeaksOtsuThresholdImageCalculator 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
RemovePeaksOtsuThresholdImageCalculator
BinaryThresholdImageFilter

Member Typedef Documentation

◆ ConstPointer

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

◆ InputImagePointer

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

Image related typedefs.

◆ InputImageRegionType

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

◆ InputIndexType

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

◆ InputPixelType

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

Image pixel value typedef.

◆ InputSizeType

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

◆ OutputImagePointer

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

◆ OutputImageRegionType

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

◆ OutputIndexType

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

◆ OutputPixelType

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

◆ OutputSizeType

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

◆ Pointer

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

◆ Self

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

Standard Self typedef.

◆ Superclass

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

Constructor & Destructor Documentation

◆ RemovePeaksOtsuThresholdImageFilter()

template<class TInputImage , class TOutputImage >
itk::RemovePeaksOtsuThresholdImageFilter< TInputImage, TOutputImage >::RemovePeaksOtsuThresholdImageFilter ( )
protected

◆ ~RemovePeaksOtsuThresholdImageFilter()

template<class TInputImage , class TOutputImage >
itk::RemovePeaksOtsuThresholdImageFilter< TInputImage, TOutputImage >::~RemovePeaksOtsuThresholdImageFilter ( )
inlineprotected

Member Function Documentation

◆ GenerateData()

template<class TInputImage , class TOutputImage >
void itk::RemovePeaksOtsuThresholdImageFilter< TInputImage, TOutputImage >::GenerateData ( )
overrideprotected

◆ GenerateInputRequestedRegion()

template<class TInputImage , class TOutputImage >
void itk::RemovePeaksOtsuThresholdImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )
overrideprotected

◆ itkGetMacro() [1/4]

template<class TInputImage , class TOutputImage >
itk::RemovePeaksOtsuThresholdImageFilter< TInputImage, TOutputImage >::itkGetMacro ( InsideValue  ,
OutputPixelType   
)

Get the "inside" pixel value.

◆ itkGetMacro() [2/4]

template<class TInputImage , class TOutputImage >
itk::RemovePeaksOtsuThresholdImageFilter< TInputImage, TOutputImage >::itkGetMacro ( NumberOfHistogramBins  ,
unsigned long   
)

◆ itkGetMacro() [3/4]

template<class TInputImage , class TOutputImage >
itk::RemovePeaksOtsuThresholdImageFilter< TInputImage, TOutputImage >::itkGetMacro ( OutsideValue  ,
OutputPixelType   
)

Get the "outside" pixel value.

◆ itkGetMacro() [4/4]

template<class TInputImage , class TOutputImage >
itk::RemovePeaksOtsuThresholdImageFilter< TInputImage, TOutputImage >::itkGetMacro ( Threshold  ,
InputPixelType   
)

Get the computed threshold.

◆ itkNewMacro()

template<class TInputImage , class TOutputImage >
itk::RemovePeaksOtsuThresholdImageFilter< TInputImage, TOutputImage >::itkNewMacro ( Self  )

Method for creation through the object factory.

◆ itkSetClampMacro()

template<class TInputImage , class TOutputImage >
itk::RemovePeaksOtsuThresholdImageFilter< TInputImage, TOutputImage >::itkSetClampMacro ( NumberOfHistogramBins  ,
unsigned long  ,
,
NumericTraits< unsigned long >  ::max() 
)

Set/Get the number of histogram bins.

Defaults is 128.

◆ itkSetMacro() [1/2]

template<class TInputImage , class TOutputImage >
itk::RemovePeaksOtsuThresholdImageFilter< TInputImage, TOutputImage >::itkSetMacro ( InsideValue  ,
OutputPixelType   
)

Set the "inside" pixel value.

The default value NumericTraits<OutputPixelType>::max()

◆ itkSetMacro() [2/2]

template<class TInputImage , class TOutputImage >
itk::RemovePeaksOtsuThresholdImageFilter< TInputImage, TOutputImage >::itkSetMacro ( OutsideValue  ,
OutputPixelType   
)

Set the "outside" pixel value.

The default value NumericTraits<OutputPixelType>::Zero.

◆ itkStaticConstMacro() [1/2]

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

Image related typedefs.

◆ itkStaticConstMacro() [2/2]

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

◆ itkTypeMacro()

template<class TInputImage , class TOutputImage >
itk::RemovePeaksOtsuThresholdImageFilter< TInputImage, TOutputImage >::itkTypeMacro ( RemovePeaksOtsuThresholdImageFilter< TInputImage, TOutputImage >  ,
ImageToImageFilter   
)

Runtime information support.

◆ PrintSelf()

template<class TInputImage , class TOutputImage >
void itk::RemovePeaksOtsuThresholdImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotected

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