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:

Public Types
typedef BasicPixelIDTypeList	PixelIDTypeList
typedef ClampImageFilter	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
	ClampImageFilter ()
Image	Execute (const Image &image1)
Image	Execute (const Image &image1, PixelIDValueEnum outputPixelType, double lowerBound, double upperBound)
double	GetLowerBound () const
std::string	GetName () const
PixelIDValueEnum	GetOutputPixelType () const
double	GetUpperBound () const
Self &	SetLowerBound (double LowerBound)
Self &	SetOutputPixelType (PixelIDValueEnum OutputPixelType)
Self &	SetUpperBound (double UpperBound)
std::string	ToString () const
virtual	~ClampImageFilter ()
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 TImageType1 , class TImageType2 >
Image	DualExecuteInternal (const Image &image1)
template<class TImageType1 , class TImageType2 >
Image	DualExecuteInternalVector (const Image &image1)

Private Attributes
nsstd::auto_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > >	m_DualMemberFactory
double	m_LowerBound
PixelIDValueEnum	m_OutputPixelType
double	m_UpperBound

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

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 51 of file sitkClampImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 107 of file sitkClampImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::ClampImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 63 of file sitkClampImageFilter.h.

typedef ClampImageFilter itk::simple::ClampImageFilter::Self

Definition at line 53 of file sitkClampImageFilter.h.

Constructor & Destructor Documentation

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

virtual

Destructor

itk::simple::ClampImageFilter::ClampImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

template<class TImageType1 , class TImageType2 >

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

private

template<class TImageType1 , class TImageType2 >

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

private

Image itk::simple::ClampImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

Image itk::simple::ClampImageFilter::Execute	(	const Image &	image1,
		PixelIDValueEnum	outputPixelType,
		double	lowerBound,
		double	upperBound
	)

Execute the filter on the input image with the given parameters

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

inline

Definition at line 81 of file sitkClampImageFilter.h.

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 91 of file sitkClampImageFilter.h.

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

inline

Definition at line 73 of file sitkClampImageFilter.h.

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

inline

Definition at line 89 of file sitkClampImageFilter.h.

Self& itk::simple::ClampImageFilter::SetLowerBound ( double  LowerBound )

inline

Definition at line 77 of file sitkClampImageFilter.h.

Self& itk::simple::ClampImageFilter::SetOutputPixelType ( PixelIDValueEnum  OutputPixelType )

inline

Definition at line 69 of file sitkClampImageFilter.h.

Self& itk::simple::ClampImageFilter::SetUpperBound ( double  UpperBound )

inline

Definition at line 85 of file sitkClampImageFilter.h.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::DualExecuteInternalAddressor< MemberFunctionType >

friend

Definition at line 109 of file sitkClampImageFilter.h.

friend struct detail::DualExecuteInternalVectorAddressor< MemberFunctionType >

friend

Definition at line 111 of file sitkClampImageFilter.h.

Member Data Documentation

nsstd::auto_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > itk::simple::ClampImageFilter::m_DualMemberFactory

private

Definition at line 114 of file sitkClampImageFilter.h.

double itk::simple::ClampImageFilter::m_LowerBound

private

Definition at line 119 of file sitkClampImageFilter.h.

PixelIDValueEnum itk::simple::ClampImageFilter::m_OutputPixelType

private

Definition at line 118 of file sitkClampImageFilter.h.

double itk::simple::ClampImageFilter::m_UpperBound

private

Definition at line 120 of file sitkClampImageFilter.h.

---

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

• sitkClampImageFilter.h