Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::OtsuSegmentationFilter Class Reference

A filter that performs a multiple threshold otsu image segmentation. More...

#include <mitkOtsuSegmentationFilter.h>

Inheritance diagram for mitk::OtsuSegmentationFilter:
Collaboration diagram for mitk::OtsuSegmentationFilter:

Public Types

typedef unsigned short OutputPixelType
 
typedef itk::Image< OutputPixelType, 3 > itkOutputImageType
 
typedef mitk::ITKImageImport< itkOutputImageType > ImageConverterType
 
- Public Types inherited from mitk::ImageToImageFilter
typedef Superclass::OutputImageRegionType OutputImageRegionType
 Superclass typedefs. More...
 
typedef mitk::Image InputImageType
 Some convenient typedefs. More...
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::ConstPointer InputImageConstPointer
 
typedef SlicedData::RegionType InputImageRegionType
 
- Public Types inherited from mitk::ImageSource
typedef mitk::Image OutputImageType
 Some convenient typedefs. More...
 
typedef OutputImageType OutputType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef SlicedData::RegionType OutputImageRegionType
 
- Public Types inherited from mitk::BaseDataSource
typedef BaseData OutputType
 Output data type. More...
 
typedef itk::DataObject::DataObjectIdentifierType DataObjectIdentifierType
 Identifier type for named data objects. More...
 

Public Member Functions

 mitkClassMacro (OtsuSegmentationFilter, ImageToImageFilter)
 
Pointer Clone () const
 
virtual unsigned int GetNumberOfThresholds ()
 Returns the number of thresholds to compute. More...
 
void SetNumberOfThresholds (unsigned int number)
 Sets the number of thresholds for Otsu's method. More...
 
void SetValleyEmphasis (bool useValley)
 Enables or disables valley emphasis in the Otsu threshold computation. More...
 
void SetNumberOfBins (unsigned int number)
 Sets the number of histogram bins for Otsu's threshold computation. More...
 
- Public Member Functions inherited from mitk::ImageToImageFilter
 mitkClassMacro (ImageToImageFilter, ImageSource)
 
Pointer Clone () const
 
virtual void SetInput (const InputImageType *image)
 Set the image input of this process object. More...
 
virtual void SetInput (unsigned int idx, const InputImageType *image)
 Set the image input at the specified index. More...
 
InputImageType * GetInput (void)
 Get the input image (non-const). More...
 
InputImageType * GetInput (unsigned int idx)
 Get the input image at the specified index (non-const). More...
 
const InputImageType * GetInput (void) const
 Get the input image (const). More...
 
const InputImageType * GetInput (unsigned int idx) const
 Get the input image at the specified index (const). More...
 
- Public Member Functions inherited from mitk::ImageSource
 mitkClassMacro (ImageSource, BaseDataSource)
 
Pointer Clone () const
 
mitkBaseDataSourceGetOutputDeclarations itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 Get the output data of this image source object. More...
 
itk::DataObject::Pointer MakeOutput (const DataObjectIdentifierType &name) override
 
virtual vtkImageData * GetVtkImageData ()
 Get the output as VTK image data (non-const version). More...
 
virtual const vtkImageData * GetVtkImageData () const
 Get the output as VTK image data (const version). More...
 
- Public Member Functions inherited from mitk::BaseDataSource
 mitkClassMacroItkParent (BaseDataSource, itk::ProcessObject)
 
OutputType * GetOutput ()
 
const OutputType * GetOutput () const
 
OutputType * GetOutput (DataObjectPointerArraySizeType idx)
 
const OutputType * GetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void GraftOutput (OutputType *output)
 Graft the specified BaseData onto this BaseDataSource's output. More...
 
virtual void GraftOutput (const DataObjectIdentifierType &key, OutputType *output)
 Graft the specified base data object onto a named output. More...
 
virtual void GraftNthOutput (unsigned int idx, OutputType *output)
 Graft the specified base data object onto this BaseDataSource's idx'th output. More...
 
bool Updating () const
 Check whether the pipeline is currently executing. More...
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from mitk::ImageToImageFilter
static Pointer New ()
 Method for creation through the object factory. More...
 
- Static Public Member Functions inherited from mitk::ImageSource
static Pointer New ()
 Method for creation through the object factory. More...
 

Protected Member Functions

 OtsuSegmentationFilter ()
 
 ~OtsuSegmentationFilter () override
 
void GenerateData () override
 
- Protected Member Functions inherited from mitk::ImageToImageFilter
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 Print self information to the given stream. More...
 
void GenerateInputRequestedRegion () override
 Determine the input requested region to produce the output requested region. More...
 
- Protected Member Functions inherited from mitk::ImageSource
 ImageSource ()
 
 ~ImageSource () override
 
void GenerateData () override
 A version of GenerateData() specific for image processing filters. More...
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). More...
 
void PrepareOutputs () override
 This method is intentionally left blank. More...
 
virtual void AllocateOutputs ()
 The GenerateData method normally allocates the buffers for all of the outputs of a filter. More...
 
virtual void BeforeThreadedGenerateData ()
 If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can provide an implementation for BeforeThreadedGenerateData(). More...
 
virtual void AfterThreadedGenerateData ()
 If an imaging filter needs to perform processing after all processing threads have completed, the filter can provide an implementation for AfterThreadedGenerateData(). More...
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
 Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". More...
 
- Protected Member Functions inherited from mitk::BaseDataSource
 BaseDataSource ()
 Constructor. More...
 
 ~BaseDataSource () override
 Destructor. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from mitk::ImageSource
static itk::ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 Static function used as a "callback" by the MultiThreader. More...
 
- Static Protected Member Functions inherited from mitk::BaseDataSource
static Pointer New ()
 

Detailed Description

A filter that performs a multiple threshold otsu image segmentation.

This class being an mitk::ImageToImageFilter performs a multiple threshold otsu image segmentation based on the image histogram. Internally, the itk::OtsuMultipleThresholdsImageFilter is used.

Remarks
In contrast to the itk filter. The MITK version generates classes starting with the pixel value 1 (and not 0 like the itk version). MITK uses 0 in Segmentation to indicate unlabeled pixel, but after otsu every pixel has a proposed class.

Definition at line 38 of file mitkOtsuSegmentationFilter.h.

Member Typedef Documentation

◆ ImageConverterType

◆ itkOutputImageType

◆ OutputPixelType

Definition at line 41 of file mitkOtsuSegmentationFilter.h.

Constructor & Destructor Documentation

◆ OtsuSegmentationFilter()

mitk::OtsuSegmentationFilter::OtsuSegmentationFilter ( )
protected

◆ ~OtsuSegmentationFilter()

mitk::OtsuSegmentationFilter::~OtsuSegmentationFilter ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::OtsuSegmentationFilter::Clone ( ) const

◆ GenerateData()

void mitk::OtsuSegmentationFilter::GenerateData ( )
overrideprotected

◆ GetNumberOfThresholds()

virtual unsigned int mitk::OtsuSegmentationFilter::GetNumberOfThresholds ( )
virtual

Returns the number of thresholds to compute.

◆ mitkClassMacro()

mitk::OtsuSegmentationFilter::mitkClassMacro ( OtsuSegmentationFilter  ,
ImageToImageFilter   
)

◆ New()

static Pointer mitk::OtsuSegmentationFilter::New ( )
static

◆ SetNumberOfBins()

void mitk::OtsuSegmentationFilter::SetNumberOfBins ( unsigned int  number)
inline

Sets the number of histogram bins for Otsu's threshold computation.

Parameters
[in]numberNumber of bins, must be >= 1.
Note
Values less than 1 are ignored with a warning.

Definition at line 82 of file mitkOtsuSegmentationFilter.h.

References MITK_WARN.

◆ SetNumberOfThresholds()

void mitk::OtsuSegmentationFilter::SetNumberOfThresholds ( unsigned int  number)
inline

Sets the number of thresholds for Otsu's method.

The number of resulting classes will be NumberOfThresholds + 1.

Parameters
[in]numberNumber of thresholds, must be >= 1.
Note
Values less than 1 are ignored with a warning.

Definition at line 60 of file mitkOtsuSegmentationFilter.h.

References MITK_WARN.

◆ SetValleyEmphasis()

void mitk::OtsuSegmentationFilter::SetValleyEmphasis ( bool  useValley)
inline

Enables or disables valley emphasis in the Otsu threshold computation.

Parameters
[in]useValleyIf true, valley emphasis is used for better threshold selection in images with unequal class variances.

Definition at line 75 of file mitkOtsuSegmentationFilter.h.


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