itk::simple::ThresholdImageFilter Class Reference

Set image values to a user-specified value if they are below, above, or between simple threshold values. More...

#include <sitkThresholdImageFilter.h>

Inheritance diagram for itk::simple::ThresholdImageFilter:

Collaboration diagram for itk::simple::ThresholdImageFilter:

Public Types
typedef BasicPixelIDTypeList	PixelIDTypeList
typedef ThresholdImageFilter	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
Image	Execute (const Image &image1)
Image	Execute (const Image &image1, double lower, double upper, double outsideValue)
double	GetLower () const
std::string	GetName () const
double	GetOutsideValue () const
double	GetUpper () const
Self &	SetLower (double Lower)
Self &	SetOutsideValue (double OutsideValue)
Self &	SetUpper (double Upper)
	ThresholdImageFilter ()
std::string	ToString () const
	~ThresholdImageFilter ()
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
double	m_Lower
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
double	m_OutsideValue
double	m_Upper

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) throw ()
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

Set image values to a user-specified value if they are below, above, or between simple threshold values.

ThresholdImageFilter sets image values to a user-specified "outside" value (by default, "black") if the image values are below, above, or between simple threshold values.

The available methods are:

ThresholdAbove() : The values greater than the threshold value are set to OutsideValue

ThresholdBelow() : The values less than the threshold value are set to OutsideValue

ThresholdOutside() : The values outside the threshold range (less than lower or greater than upper) are set to OutsideValue

Note that these definitions indicate that pixels equal to the threshold value are not set to OutsideValue in any of these methods

The pixels must support the operators >= and <=.

Wiki Examples:

• All Examples

• Threshold an image

  See also

  itk::simple::Threshold for the procedural interface

  itk::ThresholdImageFilter for the Doxygen on the original ITK class.

Definition at line 60 of file sitkThresholdImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 124 of file sitkThresholdImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::ThresholdImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 72 of file sitkThresholdImageFilter.h.

typedef ThresholdImageFilter itk::simple::ThresholdImageFilter::Self

Definition at line 62 of file sitkThresholdImageFilter.h.

Constructor & Destructor Documentation

itk::simple::ThresholdImageFilter::ThresholdImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

itk::simple::ThresholdImageFilter::~ThresholdImageFilter

(

)

Destructor

Member Function Documentation

Image itk::simple::ThresholdImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

Image itk::simple::ThresholdImageFilter::Execute	(	const Image &	image1,
		double	lower,
		double	upper,
		double	outsideValue
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

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

private

double itk::simple::ThresholdImageFilter::GetLower ( ) const

inline

Set/Get methods to set the lower threshold.

Definition at line 84 of file sitkThresholdImageFilter.h.

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 106 of file sitkThresholdImageFilter.h.

double itk::simple::ThresholdImageFilter::GetOutsideValue ( ) const

inline

Get the "outside" pixel value.

Definition at line 104 of file sitkThresholdImageFilter.h.

double itk::simple::ThresholdImageFilter::GetUpper ( ) const

inline

Set/Get methods to set the upper threshold.

Definition at line 94 of file sitkThresholdImageFilter.h.

Self& itk::simple::ThresholdImageFilter::SetLower ( double  Lower )

inline

Set/Get methods to set the lower threshold.

Definition at line 79 of file sitkThresholdImageFilter.h.

Self& itk::simple::ThresholdImageFilter::SetOutsideValue ( double  OutsideValue )

inline

The pixel type must support comparison operators. Set the "outside" pixel value. The default value NumericTraits<PixelType>::ZeroValue() .

Definition at line 99 of file sitkThresholdImageFilter.h.

Self& itk::simple::ThresholdImageFilter::SetUpper ( double  Upper )

inline

Set/Get methods to set the upper threshold.

Definition at line 89 of file sitkThresholdImageFilter.h.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 129 of file sitkThresholdImageFilter.h.

Member Data Documentation

double itk::simple::ThresholdImageFilter::m_Lower

private

Definition at line 134 of file sitkThresholdImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ThresholdImageFilter::m_MemberFactory

private

Definition at line 131 of file sitkThresholdImageFilter.h.

double itk::simple::ThresholdImageFilter::m_OutsideValue

private

Definition at line 136 of file sitkThresholdImageFilter.h.

double itk::simple::ThresholdImageFilter::m_Upper

private

Definition at line 135 of file sitkThresholdImageFilter.h.

---

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

• sitkThresholdImageFilter.h