ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction > Class Template Reference

Implements pixel-wise generic operation of three images. More...

#include <itkTernaryFunctorImageFilter.h>

Inheritance diagram for itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >:
Collaboration diagram for itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef TFunction FunctorType
typedef Input1ImageType::PixelType Input1ImagePixelType
typedef
Input1ImageType::ConstPointer 
Input1ImagePointer
typedef Input1ImageType::RegionType Input1ImageRegionType
typedef TInputImage1 Input1ImageType
typedef Input2ImageType::PixelType Input2ImagePixelType
typedef
Input2ImageType::ConstPointer 
Input2ImagePointer
typedef Input2ImageType::RegionType Input2ImageRegionType
typedef TInputImage2 Input2ImageType
typedef Input3ImageType::PixelType Input3ImagePixelType
typedef
Input3ImageType::ConstPointer 
Input3ImagePointer
typedef Input3ImageType::RegionType Input3ImageRegionType
typedef TInputImage3 Input3ImageType
typedef OutputImageType::PixelType OutputImagePixelType
typedef OutputImageType::Pointer OutputImagePointer
typedef OutputImageType::RegionType OutputImageRegionType
typedef TOutputImage OutputImageType
typedef SmartPointer< SelfPointer
typedef TernaryFunctorImageFilter Self
typedef InPlaceImageFilter
< TInputImage1, TOutputImage > 
Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
FunctorTypeGetFunctor (void)
const FunctorTypeGetFunctor () const
virtual const char * GetNameOfClass () const
void SetInput1 (const TInputImage1 *image1)
void SetInput2 (const TInputImage2 *image2)
void SetInput3 (const TInputImage3 *image3)
 typedef (Concept::SameDimension< Input1ImageDimension, Input2ImageDimension >) SameDimensionCheck1
 typedef (Concept::SameDimension< Input1ImageDimension, OutputImageDimension >) SameDimensionCheck3
 typedef (Concept::SameDimension< Input1ImageDimension, Input3ImageDimension >) SameDimensionCheck2
void SetFunctor (const FunctorType &functor)

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int Input1ImageDimension = TInputImage1::ImageDimension
static const unsigned int Input2ImageDimension = TInputImage2::ImageDimension
static const unsigned int Input3ImageDimension = TInputImage3::ImageDimension
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions

void BeforeThreadedGenerateData ()
 TernaryFunctorImageFilter ()
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual ~TernaryFunctorImageFilter ()

Private Member Functions

void operator= (const Self &)
 TernaryFunctorImageFilter (const Self &)

Private Attributes

FunctorType m_Functor

Detailed Description

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
class itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >

Implements pixel-wise generic operation of three images.

This class is parameterized over the types of the three input images and the type of the output image. It is also parameterized by the operation to be applied, using a Functor style.

See also:
BinaryFunctorImageFilter UnaryFunctorImageFilter

Definition at line 40 of file itkTernaryFunctorImageFilter.h.


Member Typedef Documentation

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef SmartPointer< const Self > itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::ConstPointer
template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef TFunction itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::FunctorType

Some typedefs.

Definition at line 54 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef Input1ImageType::PixelType itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::Input1ImagePixelType

Definition at line 61 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef Input1ImageType::ConstPointer itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::Input1ImagePointer

Definition at line 59 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef Input1ImageType::RegionType itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::Input1ImageRegionType

Definition at line 60 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef TInputImage1 itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::Input1ImageType

Definition at line 58 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef Input2ImageType::PixelType itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::Input2ImagePixelType

Definition at line 65 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef Input2ImageType::ConstPointer itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::Input2ImagePointer

Definition at line 63 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef Input2ImageType::RegionType itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::Input2ImageRegionType

Definition at line 64 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef TInputImage2 itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::Input2ImageType

Definition at line 62 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef Input3ImageType::PixelType itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::Input3ImagePixelType

Definition at line 69 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef Input3ImageType::ConstPointer itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::Input3ImagePointer

Definition at line 67 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef Input3ImageType::RegionType itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::Input3ImageRegionType

Definition at line 68 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef TInputImage3 itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::Input3ImageType

Definition at line 66 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef OutputImageType::PixelType itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::OutputImagePixelType
template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef OutputImageType::Pointer itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::OutputImagePointer
template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef OutputImageType::RegionType itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::OutputImageRegionType

Superclass typedefs.

Reimplemented from itk::InPlaceImageFilter< TInputImage1, TOutputImage >.

Definition at line 72 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef TOutputImage itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::OutputImageType
template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef SmartPointer< Self > itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::Pointer
template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef TernaryFunctorImageFilter itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::Self
template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
typedef InPlaceImageFilter< TInputImage1, TOutputImage > itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::Superclass

Constructor & Destructor Documentation

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::TernaryFunctorImageFilter ( ) [protected]

End concept checking

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
virtual itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::~TernaryFunctorImageFilter ( ) [inline, protected, virtual]

Definition at line 139 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::TernaryFunctorImageFilter ( const Self ) [private]

Member Function Documentation

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
void itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::BeforeThreadedGenerateData ( ) [protected, virtual]

Validate the presence of all three inputs. If one or more inputs are missing, throw an exception.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
virtual::itk::LightObject::Pointer itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::CreateAnother ( void  ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

Reimplemented in itk::TernaryAddImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage >, itk::TernaryMagnitudeImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage >, itk::TernaryMagnitudeSquaredImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage >, itk::Compose3DCovariantVectorImageFilter< TInputImage, TOutputImage >, itk::Compose3DVectorImageFilter< TInputImage, TOutputImage >, and itk::ComposeRGBImageFilter< TInputImage, TOutputImage >.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
const FunctorType& itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::GetFunctor ( ) const [inline]

Get the functor object. The functor is returned by reference. (Functors do not have to derive from itk::LightObject, so they do not necessarily have a reference count. So we cannot return a SmartPointer.)

Definition at line 94 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
FunctorType& itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::GetFunctor ( void  ) [inline]

Get the functor object. The functor is returned by reference. (Functors do not have to derive from itk::LightObject, so they do not necessarily have a reference count. So we cannot return a SmartPointer).

Definition at line 88 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
virtual const char* itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::GetNameOfClass ( ) const [virtual]
template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
static Pointer itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::New ( ) [static]
template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
void itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::operator= ( const Self ) [private]
template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
void itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::SetFunctor ( const FunctorType functor) [inline]

Set the functor object. This replaces the current Functor with a copy of the specified Functor. This allows the user to specify a functor that has ivars set differently than the default functor. This method requires an operator==() be defined on the functor (or the compiler's default implementation of operator==() being appropriate).

Definition at line 105 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
void itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::SetInput1 ( const TInputImage1 *  image1)

Connect one of the operands for pixel-wise addition.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
void itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::SetInput2 ( const TInputImage2 *  image2)

Connect one of the operands for pixel-wise addition.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
void itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::SetInput3 ( const TInputImage3 *  image3)

Connect one of the operands for pixel-wise addition.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
void itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
ThreadIdType  threadId 
) [protected, virtual]

TernaryFunctorImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also:
ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::typedef ( Concept::SameDimension< Input1ImageDimension, Input2ImageDimension )

Begin concept checking This class requires SameDimensionCheck1 in the form of ( Concept::SameDimension< Input1ImageDimension, Input2ImageDimension > )

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::typedef ( Concept::SameDimension< Input1ImageDimension, OutputImageDimension )

This class requires SameDimensionCheck3 in the form of ( Concept::SameDimension< Input1ImageDimension, OutputImageDimension > )

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::typedef ( Concept::SameDimension< Input1ImageDimension, Input3ImageDimension )

This class requires SameDimensionCheck2 in the form of ( Concept::SameDimension< Input1ImageDimension, Input3ImageDimension > )


Member Data Documentation

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
const unsigned int itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::Input1ImageDimension = TInputImage1::ImageDimension [static]

Image dimensions

Definition at line 117 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
const unsigned int itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::Input2ImageDimension = TInputImage2::ImageDimension [static]

Image dimensions

Definition at line 119 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
const unsigned int itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::Input3ImageDimension = TInputImage3::ImageDimension [static]

Image dimensions

Definition at line 121 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
FunctorType itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::m_Functor [private]

Definition at line 162 of file itkTernaryFunctorImageFilter.h.

template<class TInputImage1, class TInputImage2, class TInputImage3, class TOutputImage, class TFunction>
const unsigned int itk::TernaryFunctorImageFilter< TInputImage1, TInputImage2, TInputImage3, TOutputImage, TFunction >::OutputImageDimension = TOutputImage::ImageDimension [static]

Image dimensions

Reimplemented from itk::InPlaceImageFilter< TInputImage1, TOutputImage >.

Definition at line 123 of file itkTernaryFunctorImageFilter.h.


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