SimpleITK  2.0.0rc2.post21
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::YenThresholdImageFilter Class Reference

Threshold an image using the Yen Threshold. More...

#include <sitkYenThresholdImageFilter.h>

+ Inheritance diagram for itk::simple::YenThresholdImageFilter:
+ Collaboration diagram for itk::simple::YenThresholdImageFilter:

Public Types

using PixelIDTypeList = BasicPixelIDTypeList
using Self = YenThresholdImageFilter
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject

Public Member Functions

Image Execute (const Image &image)
Image Execute (const Image &image, const Image &maskImage)
uint8_t GetInsideValue () const
bool GetMaskOutput () const
uint8_t GetMaskValue () const
std::string GetName () const
uint32_t GetNumberOfHistogramBins () const
uint8_t GetOutsideValue () const
double GetThreshold () const
 Get the computed threshold. More...
SelfMaskOutputOff ()
SelfMaskOutputOn ()
SelfSetInsideValue (uint8_t InsideValue)
SelfSetMaskOutput (bool MaskOutput)
SelfSetMaskValue (uint8_t MaskValue)
SelfSetNumberOfHistogramBins (uint32_t NumberOfHistogramBins)
SelfSetOutsideValue (uint8_t OutsideValue)
std::string ToString () const
 YenThresholdImageFilter ()
virtual ~YenThresholdImageFilter ()
- Public Member Functions inherited from itk::simple::ImageFilter
 ImageFilter ()
virtual ~ImageFilter ()=0
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event. More...
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 ProcessObject ()
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
virtual ~ProcessObject ()
virtual void DebugOn ()
virtual void DebugOff ()
virtual bool GetDebug () const
virtual void SetDebug (bool debugFlag)
virtual void SetNumberOfThreads (unsigned int n)
virtual unsigned int GetNumberOfThreads () const
virtual void SetNumberOfWorkUnits (unsigned int n)
virtual unsigned int GetNumberOfWorkUnits () const

Private Types

using MemberFunctionType = Image(Self::*)(const Image *image, const Image *maskImage)

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image *image, const Image *maskImage)

Private Attributes

uint8_t m_InsideValue {1u}
bool m_MaskOutput {true}
uint8_t m_MaskValue {255u}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
uint32_t m_NumberOfHistogramBins {256u}
uint8_t m_OutsideValue {0u}
double m_Threshold {0.0}


struct detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
static void GlobalDefaultDebugOff ()
static void GlobalDefaultDebugOn ()
static void SetGlobalDefaultDebug (bool debugFlag)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static void SetGlobalWarningDisplay (bool flag)
static bool GetGlobalWarningDisplay ()
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
- Protected Member Functions inherited from itk::simple::ImageFilter
void CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
void CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
void CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
virtual itk::ProcessObjectGetActiveProcess ()
virtual void OnActiveProcessDelete ()
virtual void onCommandDelete (const itk::simple::Command *cmd) noexcept
virtual void PreUpdate (itk::ProcessObject *p)
virtual void RemoveITKObserver (EventCommand &e)
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 NonCopyable (const NonCopyable &)=delete
NonCopyableoperator= (const NonCopyable &)=delete
- Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
static void FixNonZeroIndex (TImageType *img)
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
template<class TImageType >
static Image CastITKToImage (TImageType *img)
static const itk::EventObjectGetITKEventObject (EventEnum e)
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)

Detailed Description

Threshold an image using the Yen Threshold.

This filter creates a binary thresholded image that separates an image into foreground and background components. The filter computes the threshold using the YenThresholdCalculator and applies that threshold to the input image using the BinaryThresholdImageFilter .

Richard Beare
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

This implementation was taken from the Insight Journal paper: or

See also
itk::simple::YenThreshold for the procedural interface
itk::YenThresholdImageFilter for the Doxygen on the original ITK class.

Definition at line 52 of file sitkYenThresholdImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::YenThresholdImageFilter::MemberFunctionType = Image (Self::*)( const Image * image, const Image * maskImage )

Setup for member function dispatching

Definition at line 147 of file sitkYenThresholdImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 64 of file sitkYenThresholdImageFilter.h.

◆ Self

Definition at line 54 of file sitkYenThresholdImageFilter.h.

Constructor & Destructor Documentation

◆ ~YenThresholdImageFilter()

virtual itk::simple::YenThresholdImageFilter::~YenThresholdImageFilter ( )


◆ YenThresholdImageFilter()

itk::simple::YenThresholdImageFilter::YenThresholdImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

Image itk::simple::YenThresholdImageFilter::Execute ( const Image image)

◆ Execute() [2/2]

Image itk::simple::YenThresholdImageFilter::Execute ( const Image image,
const Image maskImage 

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::YenThresholdImageFilter::ExecuteInternal ( const Image image,
const Image maskImage 

◆ GetInsideValue()

uint8_t itk::simple::YenThresholdImageFilter::GetInsideValue ( ) const

Get the "inside" pixel value.

Definition at line 77 of file sitkYenThresholdImageFilter.h.

◆ GetMaskOutput()

bool itk::simple::YenThresholdImageFilter::GetMaskOutput ( ) const

Definition at line 112 of file sitkYenThresholdImageFilter.h.

◆ GetMaskValue()

uint8_t itk::simple::YenThresholdImageFilter::GetMaskValue ( ) const

Definition at line 121 of file sitkYenThresholdImageFilter.h.

◆ GetName()

std::string itk::simple::YenThresholdImageFilter::GetName ( ) const

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 132 of file sitkYenThresholdImageFilter.h.

◆ GetNumberOfHistogramBins()

uint32_t itk::simple::YenThresholdImageFilter::GetNumberOfHistogramBins ( ) const

Definition at line 99 of file sitkYenThresholdImageFilter.h.

◆ GetOutsideValue()

uint8_t itk::simple::YenThresholdImageFilter::GetOutsideValue ( ) const

Get the "outside" pixel value.

Definition at line 89 of file sitkYenThresholdImageFilter.h.

◆ GetThreshold()

double itk::simple::YenThresholdImageFilter::GetThreshold ( ) const

Get the computed threshold.

This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

Definition at line 128 of file sitkYenThresholdImageFilter.h.

◆ MaskOutputOff()

Self& itk::simple::YenThresholdImageFilter::MaskOutputOff ( )

Definition at line 108 of file sitkYenThresholdImageFilter.h.

◆ MaskOutputOn()

Self& itk::simple::YenThresholdImageFilter::MaskOutputOn ( )

Set the value of MaskOutput to true or false respectfully.

Definition at line 107 of file sitkYenThresholdImageFilter.h.

◆ SetInsideValue()

Self& itk::simple::YenThresholdImageFilter::SetInsideValue ( uint8_t  InsideValue)

Set the "inside" pixel value.

Definition at line 71 of file sitkYenThresholdImageFilter.h.

◆ SetMaskOutput()

Self& itk::simple::YenThresholdImageFilter::SetMaskOutput ( bool  MaskOutput)

Do you want the output to be masked by the mask used in histogram construction. Only relevant if masking is in use.

Definition at line 104 of file sitkYenThresholdImageFilter.h.

◆ SetMaskValue()

Self& itk::simple::YenThresholdImageFilter::SetMaskValue ( uint8_t  MaskValue)

The value in the mask image, if used, indicating voxels that should be included. Default is the max of pixel type, as in the MaskedImageToHistogramFilter

Definition at line 117 of file sitkYenThresholdImageFilter.h.

◆ SetNumberOfHistogramBins()

Self& itk::simple::YenThresholdImageFilter::SetNumberOfHistogramBins ( uint32_t  NumberOfHistogramBins)

Set/Get the number of histogram bins.

Definition at line 95 of file sitkYenThresholdImageFilter.h.

◆ SetOutsideValue()

Self& itk::simple::YenThresholdImageFilter::SetOutsideValue ( uint8_t  OutsideValue)

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

Definition at line 83 of file sitkYenThresholdImageFilter.h.

◆ ToString()

std::string itk::simple::YenThresholdImageFilter::ToString ( ) const

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 151 of file sitkYenThresholdImageFilter.h.

Member Data Documentation

◆ m_InsideValue

uint8_t itk::simple::YenThresholdImageFilter::m_InsideValue {1u}

Definition at line 156 of file sitkYenThresholdImageFilter.h.

◆ m_MaskOutput

bool itk::simple::YenThresholdImageFilter::m_MaskOutput {true}

Definition at line 162 of file sitkYenThresholdImageFilter.h.

◆ m_MaskValue

uint8_t itk::simple::YenThresholdImageFilter::m_MaskValue {255u}

Definition at line 164 of file sitkYenThresholdImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::YenThresholdImageFilter::m_MemberFactory

Definition at line 153 of file sitkYenThresholdImageFilter.h.

◆ m_NumberOfHistogramBins

uint32_t itk::simple::YenThresholdImageFilter::m_NumberOfHistogramBins {256u}

Definition at line 160 of file sitkYenThresholdImageFilter.h.

◆ m_OutsideValue

uint8_t itk::simple::YenThresholdImageFilter::m_OutsideValue {0u}

Definition at line 158 of file sitkYenThresholdImageFilter.h.

◆ m_Threshold

double itk::simple::YenThresholdImageFilter::m_Threshold {0.0}

Definition at line 167 of file sitkYenThresholdImageFilter.h.

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