itk::Functor::Clamp< TInput, TOutput > Class Template Reference

#include <itkClampImageFilter.h>

Inheritance diagram for itk::Functor::Clamp< TInput, TOutput >:

Collaboration diagram for itk::Functor::Clamp< TInput, TOutput >:

Detailed Description

template<class TInput, class TOutput = TInput>
class itk::Functor::Clamp< TInput, TOutput >

Functor used to clamp a value to a specified range.

Default range corresponds to the range supported by the output type.

It is templated over an input and an output-type in order to be able to cast the output value.

Definition at line 42 of file itkClampImageFilter.h.

Public Types
typedef TInput	InputType
typedef TOutput	OutputType
typedef Clamp	Self

Public Member Functions
	Clamp ()
OutputType	GetLowerBound () const
OutputType	GetUpperBound () const
bool	operator!= (const Self &other) const
OutputType	operator() (const InputType &A) const
bool	operator== (const Self &other) const
void	SetBounds (const OutputType lowerBound, const OutputType upperBound)
	typedef (Concept::Convertible< InputType, OutputType >) InputConvertibleToOutputCheck
	typedef (Concept::Convertible< InputType, double >) InputConvertibleToDoubleCheck
	typedef (Concept::LessThanComparable< double, OutputType >) DoubleLessThanComparableToOutputCheck
	typedef (Concept::GreaterThanComparable< double, OutputType >) DoubleGreaterThanComparableToOutputCheck
	~Clamp ()

Private Attributes
OutputType	m_LowerBound
OutputType	m_UpperBound

Member Typedef Documentation

template<class TInput, class TOutput = TInput>

typedef TInput itk::Functor::Clamp< TInput, TOutput >::InputType

Definition at line 48 of file itkClampImageFilter.h.

template<class TInput, class TOutput = TInput>

typedef TOutput itk::Functor::Clamp< TInput, TOutput >::OutputType

Definition at line 49 of file itkClampImageFilter.h.

template<class TInput, class TOutput = TInput>

typedef Clamp itk::Functor::Clamp< TInput, TOutput >::Self

Definition at line 46 of file itkClampImageFilter.h.

Constructor & Destructor Documentation

template<class TInput, class TOutput = TInput>

itk::Functor::Clamp< TInput, TOutput >::Clamp

(

)

Creates the functor and initializes the bounds to the output-type limits.

template<class TInput, class TOutput = TInput>

itk::Functor::Clamp< TInput, TOutput >::~Clamp

(

)

Member Function Documentation

template<class TInput, class TOutput = TInput>

OutputType itk::Functor::Clamp< TInput, TOutput >::GetLowerBound

(

)

const

template<class TInput, class TOutput = TInput>

OutputType itk::Functor::Clamp< TInput, TOutput >::GetUpperBound

(

)

const

template<class TInput, class TOutput = TInput>

bool itk::Functor::Clamp< TInput, TOutput >::operator!=

(

const Self &

other

)

const

template<class TInput , class TOutput >

Clamp< TInput, TOutput >::OutputType itk::Functor::Clamp< TInput, TOutput >::operator() ( const InputType &  A ) const

inline

Definition at line 93 of file itkClampImageFilter.h.

template<class TInput, class TOutput = TInput>

bool itk::Functor::Clamp< TInput, TOutput >::operator==

(

const Self &

other

)

const

template<class TInput, class TOutput = TInput>

void itk::Functor::Clamp< TInput, TOutput >::SetBounds	(	const OutputType	lowerBound,
		const OutputType	upperBound
	)

Set the bounds of the range in which the data will be clamped. If the lower-bound is greater than the upper-bound, an itk::ExceptionObject will be thrown.

template<class TInput, class TOutput = TInput>

itk::Functor::Clamp< TInput, TOutput >::typedef

(

Concept::Convertible< InputType, OutputType >

)

This class requires InputConvertibleToOutputCheck in the form of (Concept::Convertible< InputType, OutputType >)

template<class TInput, class TOutput = TInput>

itk::Functor::Clamp< TInput, TOutput >::typedef

(

Concept::Convertible< InputType, double >

)

This class requires InputConvertibleToDoubleCheck in the form of (Concept::Convertible< InputType, double > )

template<class TInput, class TOutput = TInput>

itk::Functor::Clamp< TInput, TOutput >::typedef

(

Concept::LessThanComparable< double, OutputType >

)

This class requires DoubleLessThanComparableToOutputCheck in the form of (Concept::LessThanComparable< double, OutputType > )

template<class TInput, class TOutput = TInput>

itk::Functor::Clamp< TInput, TOutput >::typedef

(

Concept::GreaterThanComparable< double, OutputType >

)

This class requires DoubleGreaterThanComparableToOutputCheck in the form of (Concept::GreaterThanComparable< double, OutputType > )

Member Data Documentation

template<class TInput, class TOutput = TInput>

OutputType itk::Functor::Clamp< TInput, TOutput >::m_LowerBound

private

Definition at line 80 of file itkClampImageFilter.h.

template<class TInput, class TOutput = TInput>

OutputType itk::Functor::Clamp< TInput, TOutput >::m_UpperBound

private

Definition at line 85 of file itkClampImageFilter.h.

---

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

• itkClampImageFilter.h