itk::Functor::JoinFunctor< TPixel1, TPixel2 > Class Template Reference

Join the components of two pixel types into a single pixel type. More...

#include <itkJoinImageFilter.h>

List of all members.

Classes
struct	CopierDispatch
struct	CopierDispatchBase
Public Types
typedef Vector< JoinValueType, itkGetStaticConstMacro(JoinDimension)>	JoinType
typedef JoinTraits< ValueType1, ValueType2 >::ValueType	JoinValueType
typedef JoinFunctor	Self
typedef PixelTraits< TPixel1 > ::ValueType	ValueType1
typedef PixelTraits< TPixel2 > ::ValueType	ValueType2
Public Member Functions
	JoinFunctor ()
bool	operator!= (const JoinFunctor &) const
JoinType	operator() (const TPixel1 &A, const TPixel2 &B) const
bool	operator== (const JoinFunctor &other) const
	~JoinFunctor ()
static const unsigned int	Dimension1 = PixelTraits<TPixel1>::Dimension
static const unsigned int	Dimension2 = PixelTraits<TPixel2>::Dimension
static const unsigned int	JoinDimension = Dimension1 + Dimension2

---

Detailed Description

template<class TPixel1, class TPixel2>
class itk::Functor::JoinFunctor< TPixel1, TPixel2 >

Join the components of two pixel types into a single pixel type.

JoinFunctor combines the components of two pixel types into a single pixel type. The components of one pixel are appended to the components of the other pixel. The output pixel type is an itk::Vector. The ValueType of the vector is the smallest scalar type that can represent the dynamic range of the both the input pixel value types. Hence, joining a char and unsigned char results in a short since that is the smallest datatype with a large enough dynamic range. To define a consistent behavior across different architectures, the join of an int and an unsigned int is float. On a 64 bit architecture, this join could be represented in a long. But on 32 bit architectures, the only safe join value type is a float. For this and similar ambiguous cases, the join value type is promoted to a float.

Definition at line 46 of file itkJoinImageFilter.h.

---

Member Typedef Documentation

template<class TPixel1 , class TPixel2 >

typedef Vector<JoinValueType, itkGetStaticConstMacro(JoinDimension)> itk::Functor::JoinFunctor< TPixel1, TPixel2 >::JoinType

A vector of the join dimension.

Definition at line 71 of file itkJoinImageFilter.h.

template<class TPixel1 , class TPixel2 >

typedef JoinTraits<ValueType1, ValueType2>::ValueType itk::Functor::JoinFunctor< TPixel1, TPixel2 >::JoinValueType

Definition at line 59 of file itkJoinImageFilter.h.

template<class TPixel1 , class TPixel2 >

typedef JoinFunctor itk::Functor::JoinFunctor< TPixel1, TPixel2 >::Self

Standard typedefs

Definition at line 54 of file itkJoinImageFilter.h.

template<class TPixel1 , class TPixel2 >

typedef PixelTraits<TPixel1>::ValueType itk::Functor::JoinFunctor< TPixel1, TPixel2 >::ValueType1

Typedefs for the output join type.

Definition at line 57 of file itkJoinImageFilter.h.

template<class TPixel1 , class TPixel2 >

typedef PixelTraits<TPixel2>::ValueType itk::Functor::JoinFunctor< TPixel1, TPixel2 >::ValueType2

Definition at line 58 of file itkJoinImageFilter.h.

---

Constructor & Destructor Documentation

template<class TPixel1 , class TPixel2 >

itk::Functor::JoinFunctor< TPixel1, TPixel2 >::JoinFunctor

(

)

[inline]

Definition at line 49 of file itkJoinImageFilter.h.

template<class TPixel1 , class TPixel2 >

itk::Functor::JoinFunctor< TPixel1, TPixel2 >::~JoinFunctor

(

)

[inline]

Definition at line 50 of file itkJoinImageFilter.h.

---

Member Function Documentation

template<class TPixel1 , class TPixel2 >

bool itk::Functor::JoinFunctor< TPixel1, TPixel2 >::operator!=

(

const JoinFunctor< TPixel1, TPixel2 > &

)

const [inline]

Definition at line 73 of file itkJoinImageFilter.h.

template<class TPixel1 , class TPixel2 >

JoinType itk::Functor::JoinFunctor< TPixel1, TPixel2 >::operator()	(	const TPixel1 &	A,
		const TPixel2 &	B
	)			const [inline]

operator(). This is the "call" method of the functor.

Definition at line 83 of file itkJoinImageFilter.h.

References itk::Functor::JoinFunctor< TPixel1, TPixel2 >::Dimension1.

template<class TPixel1 , class TPixel2 >

bool itk::Functor::JoinFunctor< TPixel1, TPixel2 >::operator==

(

const JoinFunctor< TPixel1, TPixel2 > &

other

)

const [inline]

Definition at line 77 of file itkJoinImageFilter.h.

---

Member Data Documentation

template<class TPixel1 , class TPixel2 >

const unsigned int itk::Functor::JoinFunctor< TPixel1, TPixel2 >::Dimension1 = PixelTraits<TPixel1>::Dimension [static]

Capture the dimensions of the image.

Definition at line 63 of file itkJoinImageFilter.h.

Referenced by itk::Functor::JoinFunctor< TPixel1, TPixel2 >::operator()().

template<class TPixel1 , class TPixel2 >

const unsigned int itk::Functor::JoinFunctor< TPixel1, TPixel2 >::Dimension2 = PixelTraits<TPixel2>::Dimension [static]

Capture the dimensions of the image.

Definition at line 65 of file itkJoinImageFilter.h.

template<class TPixel1 , class TPixel2 >

const unsigned int itk::Functor::JoinFunctor< TPixel1, TPixel2 >::JoinDimension = Dimension1 + Dimension2 [static]

Capture the dimensions of the image.

Definition at line 67 of file itkJoinImageFilter.h.

---

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

• itkJoinImageFilter.h