ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::AccumulateImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkAccumulateImageFilter.h>

+ Inheritance diagram for itk::AccumulateImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::AccumulateImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef InputImageType::PixelType InputImagePixelType
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef TInputImage InputImageType
typedef OutputImageType::PixelType OutputImagePixelType
typedef OutputImageType::Pointer OutputImagePointer
typedef OutputImageType::RegionType OutputImageRegionType
typedef TOutputImage OutputImageType
typedef SmartPointer< SelfPointer
typedef AccumulateImageFilter Self
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
 typedef (Concept::SameDimensionOrMinusOne< itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >) ImageDimensionCheck
virtual unsigned int GetAccumulateDimension () const
virtual void SetAccumulateDimension (unsigned int _arg)

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions

void GenerateData (void)
virtual void GenerateInputRequestedRegion ()
virtual void GenerateOutputInformation ()

Private Member Functions

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

Private Attributes

unsigned int m_AccumulateDimension
bool m_Average
virtual void SetAverage (bool _arg)
virtual bool GetAverage () const
virtual void AverageOn ()
virtual void AverageOff ()
 AccumulateImageFilter ()
virtual ~AccumulateImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::AccumulateImageFilter< TInputImage, TOutputImage >

Implements an accumulation of an image along a selected direction.

This class accumulates an image along a dimension and reduce the size of this dimension to 1. The dimension being accumulated is set by AccumulateDimension.

Each pixel is the cumulative sum of the pixels along the collapsed dimension and reduce the size of the accumulated dimension to 1 (only on the accumulated).

The dimensions of the InputImage and the OutputImage must be the same.

This class is parameterized over the type of the input image and the type of the output image.

Author:
Emiliano Beronich

This filter was contributed by Emiliano Beronich

See also:
GetAverageSliceImageFilter

Definition at line 54 of file itkAccumulateImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TOutputImage >
typedef SmartPointer< const Self > itk::AccumulateImageFilter< TInputImage, TOutputImage >::ConstPointer
template<class TInputImage , class TOutputImage >
typedef InputImageType::PixelType itk::AccumulateImageFilter< TInputImage, TOutputImage >::InputImagePixelType
template<class TInputImage , class TOutputImage >
typedef InputImageType::Pointer itk::AccumulateImageFilter< TInputImage, TOutputImage >::InputImagePointer
template<class TInputImage , class TOutputImage >
typedef InputImageType::RegionType itk::AccumulateImageFilter< TInputImage, TOutputImage >::InputImageRegionType
template<class TInputImage , class TOutputImage >
typedef TInputImage itk::AccumulateImageFilter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 67 of file itkAccumulateImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef OutputImageType::PixelType itk::AccumulateImageFilter< TInputImage, TOutputImage >::OutputImagePixelType
template<class TInputImage , class TOutputImage >
typedef OutputImageType::Pointer itk::AccumulateImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 76 of file itkAccumulateImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef OutputImageType::RegionType itk::AccumulateImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Superclass typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 77 of file itkAccumulateImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TOutputImage itk::AccumulateImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 75 of file itkAccumulateImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef SmartPointer< Self > itk::AccumulateImageFilter< TInputImage, TOutputImage >::Pointer
template<class TInputImage , class TOutputImage >
typedef AccumulateImageFilter itk::AccumulateImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::GetAverageSliceImageFilter< TInputImage, TOutputImage >.

Definition at line 58 of file itkAccumulateImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef ImageToImageFilter< TInputImage, TOutputImage > itk::AccumulateImageFilter< TInputImage, TOutputImage >::Superclass

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >
itk::AccumulateImageFilter< TInputImage, TOutputImage >::AccumulateImageFilter ( ) [protected]

Perform a division by the size of the accumulated dimension after the accumulation is done. If true, the output image is the average of the accumulated dimension, if false the output is the sum of the pixels along the selected direction. The default value is false.

template<class TInputImage , class TOutputImage >
virtual itk::AccumulateImageFilter< TInputImage, TOutputImage >::~AccumulateImageFilter ( ) [inline, protected, virtual]

Perform a division by the size of the accumulated dimension after the accumulation is done. If true, the output image is the average of the accumulated dimension, if false the output is the sum of the pixels along the selected direction. The default value is false.

Definition at line 116 of file itkAccumulateImageFilter.h.

template<class TInputImage , class TOutputImage >
itk::AccumulateImageFilter< TInputImage, TOutputImage >::AccumulateImageFilter ( const Self ) [private]

Member Function Documentation

template<class TInputImage , class TOutputImage >
virtual void itk::AccumulateImageFilter< TInputImage, TOutputImage >::AverageOff ( ) [virtual]

Perform a division by the size of the accumulated dimension after the accumulation is done. If true, the output image is the average of the accumulated dimension, if false the output is the sum of the pixels along the selected direction. The default value is false.

template<class TInputImage , class TOutputImage >
virtual void itk::AccumulateImageFilter< TInputImage, TOutputImage >::AverageOn ( ) [virtual]

Perform a division by the size of the accumulated dimension after the accumulation is done. If true, the output image is the average of the accumulated dimension, if false the output is the sum of the pixels along the selected direction. The default value is false.

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer itk::AccumulateImageFilter< TInputImage, TOutputImage >::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::GetAverageSliceImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
void itk::AccumulateImageFilter< TInputImage, TOutputImage >::GenerateData ( void  ) [protected, virtual]

This method implements the actual accumulation of the image.

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

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage >
virtual void itk::AccumulateImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( ) [protected, virtual]

Apply changes to the input image requested region.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
virtual void itk::AccumulateImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( ) [protected, virtual]

Apply changes to the output image information.

Reimplemented from itk::ProcessObject.

template<class TInputImage , class TOutputImage >
virtual unsigned int itk::AccumulateImageFilter< TInputImage, TOutputImage >::GetAccumulateDimension ( ) const [virtual]

End concept checking Set the direction in which to accumulate the data. It must be set before the update of the filter. Defaults to the last dimension.

template<class TInputImage , class TOutputImage >
virtual bool itk::AccumulateImageFilter< TInputImage, TOutputImage >::GetAverage ( ) const [virtual]

Perform a division by the size of the accumulated dimension after the accumulation is done. If true, the output image is the average of the accumulated dimension, if false the output is the sum of the pixels along the selected direction. The default value is false.

template<class TInputImage , class TOutputImage >
virtual const char* itk::AccumulateImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::GetAverageSliceImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
static Pointer itk::AccumulateImageFilter< TInputImage, TOutputImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

Reimplemented in itk::GetAverageSliceImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
void itk::AccumulateImageFilter< TInputImage, TOutputImage >::operator= ( const Self ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::GetAverageSliceImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
void itk::AccumulateImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

Perform a division by the size of the accumulated dimension after the accumulation is done. If true, the output image is the average of the accumulated dimension, if false the output is the sum of the pixels along the selected direction. The default value is false.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::GetAverageSliceImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
virtual void itk::AccumulateImageFilter< TInputImage, TOutputImage >::SetAccumulateDimension ( unsigned int  _arg) [virtual]

End concept checking Set the direction in which to accumulate the data. It must be set before the update of the filter. Defaults to the last dimension.

template<class TInputImage , class TOutputImage >
virtual void itk::AccumulateImageFilter< TInputImage, TOutputImage >::SetAverage ( bool  _arg) [virtual]

Perform a division by the size of the accumulated dimension after the accumulation is done. If true, the output image is the average of the accumulated dimension, if false the output is the sum of the pixels along the selected direction. The default value is false.

template<class TInputImage , class TOutputImage >
itk::AccumulateImageFilter< TInputImage, TOutputImage >::typedef ( Concept::SameDimensionOrMinusOne< itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >  )

Input and output images must be the same dimension, or the output's dimension must be one less than that of the input. Begin concept checking This class requires ImageDimensionCheck in the form of ( Concept::SameDimensionOrMinusOne< itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) > )


Member Data Documentation

template<class TInputImage , class TOutputImage >
const unsigned int itk::AccumulateImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension [static]

ImageDimension enumeration

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 82 of file itkAccumulateImageFilter.h.

template<class TInputImage , class TOutputImage >
unsigned int itk::AccumulateImageFilter< TInputImage, TOutputImage >::m_AccumulateDimension [private]

Definition at line 136 of file itkAccumulateImageFilter.h.

template<class TInputImage , class TOutputImage >
bool itk::AccumulateImageFilter< TInputImage, TOutputImage >::m_Average [private]

Definition at line 137 of file itkAccumulateImageFilter.h.

template<class TInputImage , class TOutputImage >
const unsigned int itk::AccumulateImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension [static]

ImageDimension enumeration

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 84 of file itkAccumulateImageFilter.h.


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