Threshold an image using the Li Threshold. More...

#include <sitkLiThresholdImageFilter.h>

Inheritance diagram for itk::simple::LiThresholdImageFilter:

Collaboration diagram for itk::simple::LiThresholdImageFilter:

Public Types
typedef BasicPixelIDTypeList	PixelIDTypeList

typedef LiThresholdImageFilter	Self

Public Types inherited from itk::simple::ImageFilter< 0 >
typedef ImageFilter	Self

Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
Image	Execute (const Image &image, const Image &maskImage)

Image	Execute (const Image &image)

Image	Execute (const Image &image, const Image &maskImage, uint8_t insideValue, uint8_t outsideValue, uint32_t numberOfHistogramBins, bool maskOutput, uint8_t maskValue)

Image	Execute (const Image &image, uint8_t insideValue, uint8_t outsideValue, uint32_t numberOfHistogramBins, bool maskOutput, uint8_t maskValue)

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

	LiThresholdImageFilter ()

Self &	MaskOutputOff ()

Self &	MaskOutputOn ()

Self &	SetInsideValue (uint8_t InsideValue)

Self &	SetMaskOutput (bool MaskOutput)

Self &	SetMaskValue (uint8_t MaskValue)

Self &	SetNumberOfHistogramBins (uint32_t NumberOfHistogramBins)

Self &	SetOutsideValue (uint8_t OutsideValue)

std::string	ToString () const

virtual	~LiThresholdImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter< 0 >
	ImageFilter ()

virtual	~ImageFilter ()=0

Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()

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

Private Types
typedef Image(Self::*	MemberFunctionType) (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

bool	m_MaskOutput

uint8_t	m_MaskValue

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

uint32_t	m_NumberOfHistogramBins

uint8_t	m_OutsideValue

double	m_Threshold

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 void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()

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

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) SITK_NOEXCEPT

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()

Static Protected Member Functions inherited from itk::simple::ImageFilter< 0 >
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 TImageType >
static Image	CastITKToImage (TImageType *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)

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)

Detailed Description

Threshold an image using the Li Threshold.

This filter creates a binary thresholded image that separates an image into foreground and background components. The filter computes the threshold using the LiThresholdCalculator 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://hdl.handle.net/10380/3279 or http://www.insight-journal.org/browse/publication/811

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

Definition at line 50 of file sitkLiThresholdImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::LiThresholdImageFilter::MemberFunctionType) (const Image *image, const Image *maskImage)

private

Setup for member function dispatching

Definition at line 149 of file sitkLiThresholdImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::LiThresholdImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 62 of file sitkLiThresholdImageFilter.h.

typedef LiThresholdImageFilter itk::simple::LiThresholdImageFilter::Self

Definition at line 52 of file sitkLiThresholdImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::LiThresholdImageFilter::~LiThresholdImageFilter ( )

virtual

Destructor

itk::simple::LiThresholdImageFilter::LiThresholdImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input image

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

Image itk::simple::LiThresholdImageFilter::Execute	(	const Image &	image,
		const Image &	maskImage,
		uint8_t	insideValue,
		uint8_t	outsideValue,
		uint32_t	numberOfHistogramBins,
		bool	maskOutput,
		uint8_t	maskValue
	)

Execute the filter on the input image with the given parameters

Image itk::simple::LiThresholdImageFilter::Execute	(	const Image &	image,
		uint8_t	insideValue,
		uint8_t	outsideValue,
		uint32_t	numberOfHistogramBins,
		bool	maskOutput,
		uint8_t	maskValue
	)

template<class TImageType >

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

private

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

inline

Get the "inside" pixel value.

Definition at line 76 of file sitkLiThresholdImageFilter.h.

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

inline

Definition at line 111 of file sitkLiThresholdImageFilter.h.

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

inline

Definition at line 120 of file sitkLiThresholdImageFilter.h.

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 130 of file sitkLiThresholdImageFilter.h.

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

inline

Definition at line 98 of file sitkLiThresholdImageFilter.h.

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

inline

Get the "outside" pixel value.

Definition at line 88 of file sitkLiThresholdImageFilter.h.

double itk::simple::LiThresholdImageFilter::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 127 of file sitkLiThresholdImageFilter.h.

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

inline

Definition at line 107 of file sitkLiThresholdImageFilter.h.

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

inline

Set the value of MaskOutput to true or false respectfully.

Definition at line 106 of file sitkLiThresholdImageFilter.h.

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

inline

Set the "inside" pixel value.

Definition at line 70 of file sitkLiThresholdImageFilter.h.

Self& itk::simple::LiThresholdImageFilter::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 103 of file sitkLiThresholdImageFilter.h.

Self& itk::simple::LiThresholdImageFilter::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 116 of file sitkLiThresholdImageFilter.h.

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

inline

Set/Get the number of histogram bins.

Definition at line 94 of file sitkLiThresholdImageFilter.h.

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

inline

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

Definition at line 82 of file sitkLiThresholdImageFilter.h.

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

virtual

Print ourselves out