Binarize an input image by thresholding. More...

#include <sitkBinaryThresholdImageFilter.h>

Inheritance diagram for itk::simple::BinaryThresholdImageFilter:

Collaboration diagram for itk::simple::BinaryThresholdImageFilter:

Public Types
typedef BasicPixelIDTypeList	PixelIDTypeList

typedef BinaryThresholdImageFilter	Self

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

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

Public Member Functions
	BinaryThresholdImageFilter ()

Image	Execute (const Image &image1)

Image	Execute (const Image &image1, double lowerThreshold, double upperThreshold, uint8_t insideValue, uint8_t outsideValue)

uint8_t	GetInsideValue () const

double	GetLowerThreshold () const

std::string	GetName () const

uint8_t	GetOutsideValue () const

double	GetUpperThreshold () const

Self &	SetInsideValue (uint8_t InsideValue)

Self &	SetLowerThreshold (double LowerThreshold)

Self &	SetOutsideValue (uint8_t OutsideValue)

Self &	SetUpperThreshold (double UpperThreshold)

std::string	ToString () const

virtual	~BinaryThresholdImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter< 1 >
	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 &image1)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image &image1)

Private Attributes
uint8_t	m_InsideValue

double	m_LowerThreshold

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

uint8_t	m_OutsideValue

double	m_UpperThreshold

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

Binarize an input image by thresholding.

This filter produces an output image whose pixels are either one of two values ( OutsideValue or InsideValue ), depending on whether the corresponding input image pixels lie between the two thresholds ( LowerThreshold and UpperThreshold ). Values equal to either threshold is considered to be between the thresholds.

More precisely

$Output(x_i) = \begin{cases} InsideValue & \text{if \f$LowerThreshold \leq x_i \leq UpperThreshold\f$} \\ OutsideValue & \text{otherwise} \end{cases}$

This filter is templated over the input image type and the output image type.

The filter expect both images to have the same number of dimensions.

The default values for LowerThreshold and UpperThreshold are: LowerThreshold = NumericTraits<TInput>::NonpositiveMin() ; UpperThreshold = NumericTraits<TInput>::max() ; Therefore, generally only one of these needs to be set, depending on whether the user wants to threshold above or below the desired threshold.

See also: itk::simple::BinaryThreshold for the procedural interface; itk::BinaryThresholdImageFilter for the Doxygen on the original ITK class.

Definition at line 50 of file sitkBinaryThresholdImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::BinaryThresholdImageFilter::MemberFunctionType) (const Image &image1)

private

Setup for member function dispatching

Definition at line 121 of file sitkBinaryThresholdImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::BinaryThresholdImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 62 of file sitkBinaryThresholdImageFilter.h.

typedef BinaryThresholdImageFilter itk::simple::BinaryThresholdImageFilter::Self

Definition at line 52 of file sitkBinaryThresholdImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::BinaryThresholdImageFilter::~BinaryThresholdImageFilter ( )

virtual

Destructor

itk::simple::BinaryThresholdImageFilter::BinaryThresholdImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::BinaryThresholdImageFilter::Execute ( const Image & image1 )

Execute the filter on the input image

Image itk::simple::BinaryThresholdImageFilter::Execute	(	const Image &	image1,
		double	lowerThreshold,
		double	upperThreshold,
		uint8_t	insideValue,
		uint8_t	outsideValue
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

Image itk::simple::BinaryThresholdImageFilter::ExecuteInternal ( const Image & image1 )

private

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

inline

Get the "inside" pixel value.

Definition at line 92 of file sitkBinaryThresholdImageFilter.h.

double itk::simple::BinaryThresholdImageFilter::GetLowerThreshold ( ) const

inline

Definition at line 72 of file sitkBinaryThresholdImageFilter.h.

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 104 of file sitkBinaryThresholdImageFilter.h.

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

inline

Get the "outside" pixel value.

Definition at line 102 of file sitkBinaryThresholdImageFilter.h.

double itk::simple::BinaryThresholdImageFilter::GetUpperThreshold ( ) const

inline

Get the threshold values.

Definition at line 82 of file sitkBinaryThresholdImageFilter.h.

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

inline

Set the "inside" pixel value. The default value NumericTraits<OutputPixelType>::max()

Definition at line 87 of file sitkBinaryThresholdImageFilter.h.

Self& itk::simple::BinaryThresholdImageFilter::SetLowerThreshold ( double LowerThreshold )

inline

Definition at line 68 of file sitkBinaryThresholdImageFilter.h.

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

inline

Set the "outside" pixel value. The default value NumericTraits<OutputPixelType>::ZeroValue() .

Definition at line 97 of file sitkBinaryThresholdImageFilter.h.

Self& itk::simple::BinaryThresholdImageFilter::SetUpperThreshold ( double UpperThreshold )

inline

Set the thresholds. The default lower threshold is NumericTraits<InputPixelType>::NonpositiveMin() . The default upper threshold is NumericTraits<InputPixelType>::max . An execption is thrown if the lower threshold is greater than the upper threshold.

Definition at line 77 of file sitkBinaryThresholdImageFilter.h.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.