itk::simple::ClampImageFilter Class Reference

Casts input pixels to output pixel type and clamps the output pixel values to a specified range. More...

#include <sitkClampImageFilter.h>

Inheritance diagram for itk::simple::ClampImageFilter:

Collaboration diagram for itk::simple::ClampImageFilter:

Detailed Description

Casts input pixels to output pixel type and clamps the output pixel values to a specified range.

Default range corresponds to the range supported by the pixel type of the output image.

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

Author

Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

See also

UnaryFunctorImageFilter

CastImageFilter

itk::simple::Clamp for the procedural interface

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

Definition at line 54 of file sitkClampImageFilter.h.

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList
using	Self = ClampImageFilter
Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter
Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
	ClampImageFilter ()
Image	Execute (const Image &image1)
Image	Execute (Image &&image1)
double	GetLowerBound () const
std::string	GetName () const
PixelIDValueEnum	GetOutputPixelType () const
double	GetUpperBound () const
void	SetLowerBound (double LowerBound)
void	SetOutputPixelType (PixelIDValueEnum OutputPixelType)
void	SetUpperBound (double UpperBound)
std::string	ToString () const
virtual	~ClampImageFilter ()
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 = Image (Self::*)(const Image &image1)

Private Member Functions
template<class TImageType1, class TImageType2>
Image	DualExecuteInternal (const Image &image1)
template<class TImageType1, class TImageType2>
Image	DualExecuteInternalVector (const Image &image1)

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

Private Attributes
bool	m_InPlace {false}
double	m_LowerBound { -std::numeric_limits<double>::max() }
PixelIDValueEnum	m_OutputPixelType { itk::simple::sitkUnknown }
double	m_UpperBound { std::numeric_limits<double>::max() }

Friends
struct	detail::DualExecuteInternalAddressor< MemberFunctionType >
struct	detail::DualExecuteInternalVectorAddressor< 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::ClampImageFilter::MemberFunctionType = Image (Self::*)(const Image &image1)

private

Setup for member function dispatching

Definition at line 120 of file sitkClampImageFilter.h.

PixelIDTypeList

using itk::simple::ClampImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 66 of file sitkClampImageFilter.h.

Self

using itk::simple::ClampImageFilter::Self = ClampImageFilter

Definition at line 56 of file sitkClampImageFilter.h.

Constructor & Destructor Documentation

~ClampImageFilter()

virtual itk::simple::ClampImageFilter::~ClampImageFilter ( )

virtual

Destructor

ClampImageFilter()

itk::simple::ClampImageFilter::ClampImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

DualExecuteInternal()

template<class TImageType1, class TImageType2>

Image itk::simple::ClampImageFilter::DualExecuteInternal ( const Image & image1 )

private

Referenced by detail::DualExecuteInternalVectorAddressor< MemberFunctionType >.

DualExecuteInternalVector()

template<class TImageType1, class TImageType2>

Image itk::simple::ClampImageFilter::DualExecuteInternalVector ( const Image & image1 )

private

Execute() [1/2]

Image itk::simple::ClampImageFilter::Execute

(

const Image &

image1

)

Execute() [2/2]

Image itk::simple::ClampImageFilter::Execute

(

Image &&

image1

)

Execute the filter on the input image

Referenced by detail::DualExecuteInternalAddressor< MemberFunctionType >.

GetLowerBound()

double itk::simple::ClampImageFilter::GetLowerBound ( ) const

inline

Definition at line 90 of file sitkClampImageFilter.h.

References m_LowerBound.

GetMemberFunctionFactory()

static const detail::DualMemberFunctionFactory< MemberFunctionType > & itk::simple::ClampImageFilter::GetMemberFunctionFactory ( )

staticprivate

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 105 of file sitkClampImageFilter.h.

GetOutputPixelType()

PixelIDValueEnum itk::simple::ClampImageFilter::GetOutputPixelType ( ) const

inline

Definition at line 79 of file sitkClampImageFilter.h.

References m_OutputPixelType.

GetUpperBound()

double itk::simple::ClampImageFilter::GetUpperBound ( ) const

inline

Definition at line 101 of file sitkClampImageFilter.h.

References m_UpperBound.

SetLowerBound()

void itk::simple::ClampImageFilter::SetLowerBound ( double LowerBound )

inline

Definition at line 85 of file sitkClampImageFilter.h.

References m_LowerBound.

SetOutputPixelType()

void itk::simple::ClampImageFilter::SetOutputPixelType ( PixelIDValueEnum OutputPixelType )

inline

Definition at line 74 of file sitkClampImageFilter.h.

References m_OutputPixelType.

SetUpperBound()

void itk::simple::ClampImageFilter::SetUpperBound ( double UpperBound )

inline

Definition at line 96 of file sitkClampImageFilter.h.

References m_UpperBound.

ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Symbol Documentation

detail::DualExecuteInternalAddressor< MemberFunctionType >

friend struct detail::DualExecuteInternalAddressor< MemberFunctionType >

friend

Definition at line 115 of file sitkClampImageFilter.h.

References Execute().

detail::DualExecuteInternalVectorAddressor< MemberFunctionType >

friend struct detail::DualExecuteInternalVectorAddressor< MemberFunctionType >

friend

Definition at line 123 of file sitkClampImageFilter.h.

References DualExecuteInternal().

Member Data Documentation

m_InPlace

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

private

Definition at line 145 of file sitkClampImageFilter.h.

m_LowerBound

double itk::simple::ClampImageFilter::m_LowerBound { -std::numeric_limits<double>::max() }

private

Definition at line 135 of file sitkClampImageFilter.h.

Referenced by GetLowerBound(), and SetLowerBound().

m_OutputPixelType

PixelIDValueEnum itk::simple::ClampImageFilter::m_OutputPixelType { itk::simple::sitkUnknown }

private

Definition at line 133 of file sitkClampImageFilter.h.

Referenced by GetOutputPixelType(), and SetOutputPixelType().

m_UpperBound

double itk::simple::ClampImageFilter::m_UpperBound { std::numeric_limits<double>::max() }

private

Definition at line 137 of file sitkClampImageFilter.h.

Referenced by GetUpperBound(), and SetUpperBound().

---

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

• sitkClampImageFilter.h