Threshold an image using the MaximumEntropy Threshold. More...

#include <sitkMaximumEntropyThresholdImageFilter.h>

Inheritance diagram for itk::simple::MaximumEntropyThresholdImageFilter:

Collaboration diagram for itk::simple::MaximumEntropyThresholdImageFilter:

Detailed Description

Threshold an image using the MaximumEntropy Threshold.

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

Author: Richard Beare. Department of Medicine, Monash University, Melbourne, Australia.; Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

This implementation was taken from the Insight Journal paper: https://doi.org/10.54294/efycla

See also: HistogramThresholdImageFilter; itk::simple::MaximumEntropyThreshold for the procedural interface; itk::MaximumEntropyThresholdImageFilter for the Doxygen on the original ITK class.

Definition at line 55 of file sitkMaximumEntropyThresholdImageFilter.h.

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList

using	Self = MaximumEntropyThresholdImageFilter

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.

void	MaskOutputOff ()

void	MaskOutputOn ()

	MaximumEntropyThresholdImageFilter ()

void	SetInsideValue (uint8_t InsideValue)

void	SetMaskOutput (bool MaskOutput)

void	SetMaskValue (uint8_t MaskValue)

void	SetNumberOfHistogramBins (uint32_t NumberOfHistogramBins)

void	SetOutsideValue (uint8_t OutsideValue)

std::string	ToString () const

virtual	~MaximumEntropyThresholdImageFilter ()

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.

virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event.

virtual float	GetProgress () const
	An Active Measurement of the progress of execution.

virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event.

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands.

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

Private Member Functions
template<class TImageType>
Image	ExecuteInternal (const Image image, const Image maskImage)

Static Private Member Functions
static const detail::MemberFunctionFactory< MemberFunctionType > &	GetMemberFunctionFactory ()

Private Attributes
uint8_t	m_InsideValue { 1u }

bool	m_MaskOutput { true }

uint8_t	m_MaskValue { 255u }

uint32_t	m_NumberOfHistogramBins { 256u }

uint8_t	m_OutsideValue { 0u }

double	m_Threshold { 0.0 }

Friends
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.

static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces.

static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces.

static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces.

static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects.

static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects.

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects.

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::ProcessObject *	GetActiveProcess ()

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

NonCopyable &	operator= (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<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)

template<class TImageType>
static Image	CastITKToImage (TImageType *img)

static const itk::EventObject &	GetITKEventObject (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)

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::MaximumEntropyThresholdImageFilter::MemberFunctionType

private

Initial value:

 Image (Self::*)(const Image *
    image, const Image *
    maskImage)

Setup for member function dispatching

Definition at line 162 of file sitkMaximumEntropyThresholdImageFilter.h.

◆ PixelIDTypeList

using itk::simple::MaximumEntropyThresholdImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 67 of file sitkMaximumEntropyThresholdImageFilter.h.

◆ Self

using itk::simple::MaximumEntropyThresholdImageFilter::Self = MaximumEntropyThresholdImageFilter

Definition at line 57 of file sitkMaximumEntropyThresholdImageFilter.h.

Constructor & Destructor Documentation

◆ ~MaximumEntropyThresholdImageFilter()

virtual itk::simple::MaximumEntropyThresholdImageFilter::~MaximumEntropyThresholdImageFilter ( )

virtual

Destructor

◆ MaximumEntropyThresholdImageFilter()

itk::simple::MaximumEntropyThresholdImageFilter::MaximumEntropyThresholdImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

Image itk::simple::MaximumEntropyThresholdImageFilter::Execute ( const Image & image )

◆ Execute() [2/2]

Image itk::simple::MaximumEntropyThresholdImageFilter::Execute	(	const Image &	image,
		const Image &	maskImage )

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType>

Image itk::simple::MaximumEntropyThresholdImageFilter::ExecuteInternal	(	const Image *	image,
		const Image *	maskImage )

private

Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.

◆ GetInsideValue()

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

inline

Get the "inside" pixel value.

Definition at line 82 of file sitkMaximumEntropyThresholdImageFilter.h.

References m_InsideValue.

◆ GetMaskOutput()

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

inline

Definition at line 125 of file sitkMaximumEntropyThresholdImageFilter.h.

References m_MaskOutput.

◆ GetMaskValue()

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

inline

Definition at line 138 of file sitkMaximumEntropyThresholdImageFilter.h.

References m_MaskValue.

◆ GetMemberFunctionFactory()

static const detail::MemberFunctionFactory< MemberFunctionType > & itk::simple::MaximumEntropyThresholdImageFilter::GetMemberFunctionFactory ( )

staticprivate

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 149 of file sitkMaximumEntropyThresholdImageFilter.h.

◆ GetNumberOfHistogramBins()

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

inline

Definition at line 107 of file sitkMaximumEntropyThresholdImageFilter.h.

References m_NumberOfHistogramBins.

◆ GetOutsideValue()

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

inline

Get the "outside" pixel value.

Definition at line 95 of file sitkMaximumEntropyThresholdImageFilter.h.

References m_OutsideValue.

◆ GetThreshold()

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

inline

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 146 of file sitkMaximumEntropyThresholdImageFilter.h.

References m_Threshold.

◆ MaskOutputOff()

void itk::simple::MaximumEntropyThresholdImageFilter::MaskOutputOff ( )

inline

Definition at line 121 of file sitkMaximumEntropyThresholdImageFilter.h.

References SetMaskOutput().

◆ MaskOutputOn()

void itk::simple::MaximumEntropyThresholdImageFilter::MaskOutputOn ( )

inline

Set the value of MaskOutput to true or false respectfully.

Definition at line 119 of file sitkMaximumEntropyThresholdImageFilter.h.

References SetMaskOutput().

◆ SetInsideValue()

void itk::simple::MaximumEntropyThresholdImageFilter::SetInsideValue ( uint8_t InsideValue )

inline

Set the "inside" pixel value.

Definition at line 76 of file sitkMaximumEntropyThresholdImageFilter.h.

References m_InsideValue.

◆ SetMaskOutput()

void itk::simple::MaximumEntropyThresholdImageFilter::SetMaskOutput ( bool MaskOutput )

inline

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 114 of file sitkMaximumEntropyThresholdImageFilter.h.

References m_MaskOutput.

Referenced by MaskOutputOff(), and MaskOutputOn().

◆ SetMaskValue()

void itk::simple::MaximumEntropyThresholdImageFilter::SetMaskValue ( uint8_t MaskValue )

inline

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 133 of file sitkMaximumEntropyThresholdImageFilter.h.

References m_MaskValue.