itk::simple::ThresholdImageFilter Class Reference

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

#include <sitkThresholdImageFilter.h>

Inheritance diagram for itk::simple::ThresholdImageFilter:

Collaboration diagram for itk::simple::ThresholdImageFilter:

Detailed Description

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

ThresholdImageFilter sets image values to a user-specified "outside" value (by default, zero) if the image values are below, above, or outside 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 <=.

See also

itk::simple::Threshold for the procedural interface

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

Definition at line 53 of file sitkThresholdImageFilter.h.

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList
using	Self = ThresholdImageFilter
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 &image1)
Image	Execute (Image &&image1)
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)
void	ThresholdAbove (double threshold)
void	ThresholdBelow (double threshold)
	ThresholdImageFilter ()
void	ThresholdOutside (double lower, double upper)
std::string	ToString () const
virtual	~ThresholdImageFilter ()
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 &image1)

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

Private Attributes
bool	m_InPlace {false}
double	m_Lower {0.0}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
double	m_OutsideValue {0.0}
double	m_Upper {1.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. 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::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::ThresholdImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

private

Setup for member function dispatching

Definition at line 122 of file sitkThresholdImageFilter.h.

PixelIDTypeList

using itk::simple::ThresholdImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 65 of file sitkThresholdImageFilter.h.

Self

using itk::simple::ThresholdImageFilter::Self = ThresholdImageFilter

Definition at line 55 of file sitkThresholdImageFilter.h.

Constructor & Destructor Documentation

~ThresholdImageFilter()

virtual itk::simple::ThresholdImageFilter::~ThresholdImageFilter ( )

virtual

Destructor

ThresholdImageFilter()

itk::simple::ThresholdImageFilter::ThresholdImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Execute() [1/2]

Image itk::simple::ThresholdImageFilter::Execute

(

const Image &

image1

)

Execute() [2/2]

Image itk::simple::ThresholdImageFilter::Execute

(

Image &&

image1

)

Execute the filter on the input image

ExecuteInternal()

template<class TImageType >

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

private

GetLower()

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

inline

Set/Get methods to set the lower threshold.

Definition at line 76 of file sitkThresholdImageFilter.h.

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 99 of file sitkThresholdImageFilter.h.

GetOutsideValue()

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

inline

Get the "outside" pixel value.

Definition at line 96 of file sitkThresholdImageFilter.h.

GetUpper()

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

inline

Set/Get methods to set the upper threshold.

Definition at line 86 of file sitkThresholdImageFilter.h.

SetLower()

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

inline

Set/Get methods to set the lower threshold.

Definition at line 71 of file sitkThresholdImageFilter.h.

SetOutsideValue()

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 91 of file sitkThresholdImageFilter.h.

SetUpper()

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

inline

Set/Get methods to set the upper threshold.

Definition at line 81 of file sitkThresholdImageFilter.h.

ThresholdAbove()

void itk::simple::ThresholdImageFilter::ThresholdAbove

(

double

threshold

)

ThresholdBelow()

void itk::simple::ThresholdImageFilter::ThresholdBelow

(

double

threshold

)

ThresholdOutside()

void itk::simple::ThresholdImageFilter::ThresholdOutside	(	double	lower,
		double	upper
	)

ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 126 of file sitkThresholdImageFilter.h.

Member Data Documentation

m_InPlace

bool itk::simple::ThresholdImageFilter::m_InPlace {false}

private

Definition at line 138 of file sitkThresholdImageFilter.h.

m_Lower

double itk::simple::ThresholdImageFilter::m_Lower {0.0}

private

Definition at line 131 of file sitkThresholdImageFilter.h.

m_MemberFactory

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

private

Definition at line 128 of file sitkThresholdImageFilter.h.

m_OutsideValue

double itk::simple::ThresholdImageFilter::m_OutsideValue {0.0}

private

Definition at line 135 of file sitkThresholdImageFilter.h.

m_Upper

double itk::simple::ThresholdImageFilter::m_Upper {1.0}

private

Definition at line 133 of file sitkThresholdImageFilter.h.

---

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

• sitkThresholdImageFilter.h