itk::AccumulateImageFilter< TInputImage, TOutputImage > Class Template Reference
[Intensity Image Filters, Singlethreaded Filters]

Implements an accumulation of an image along a selected direction. More...

#include <itkAccumulateImageFilter.h>

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

[legend]Collaboration diagram for itk::AccumulateImageFilter< TInputImage, TOutputImage >:

[legend]List of all members.

Public Types
typedef AccumulateImageFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef InputImageType::PixelType	InputImagePixelType
typedef TOutputImage	OutputImageType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef OutputImageType::PixelType	OutputImagePixelType
enum	{ ImageDimensionCheck = 0 }
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
	itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)
virtual unsigned int	GetAccumulateDimension ()
virtual void	SetAccumulateDimension (unsigned int _arg)
virtual void	SetAverage (bool _arg)
virtual bool	GetAverage ()
virtual void	AverageOn ()
virtual void	AverageOff ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	AccumulateImageFilter ()
virtual	~AccumulateImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	GenerateOutputInformation ()
virtual void	GenerateInputRequestedRegion ()
void	GenerateData (void)

---

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

Definition at line 52 of file itkAccumulateImageFilter.h.

---

Member Typedef Documentation

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 59 of file itkAccumulateImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InputImageType::PixelType itk::AccumulateImageFilter< TInputImage, TOutputImage >::InputImagePixelType

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 71 of file itkAccumulateImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InputImageType::Pointer itk::AccumulateImageFilter< TInputImage, TOutputImage >::InputImagePointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 69 of file itkAccumulateImageFilter.h.

template<class TInputImage, class TOutputImage> typedef InputImageType::RegionType itk::AccumulateImageFilter< TInputImage, TOutputImage >::InputImageRegionType

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 70 of file itkAccumulateImageFilter.h.

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

Some convenient typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 68 of file itkAccumulateImageFilter.h.

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

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 75 of file itkAccumulateImageFilter.h.

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

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 73 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 74 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 72 of file itkAccumulateImageFilter.h.

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 58 of file itkAccumulateImageFilter.h.

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

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 56 of file itkAccumulateImageFilter.h.

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 57 of file itkAccumulateImageFilter.h.

---

Member Enumeration Documentation

template<class TInputImage, class TOutputImage> anonymous enum

Input and output images must be the same dimension. Enumeration values: ImageDimensionCheck  Definition at line 88 of file itkAccumulateImageFilter.h.

---

Constructor & Destructor Documentation

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

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

Definition at line 111 of file itkAccumulateImageFilter.h.

---

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> 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 (   )  [virtual]

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 (   )  [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 >.

template<class TInputImage, class TOutputImage> itk::AccumulateImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro (  OutputImageDimension  , unsigned  int, TOutputImage::ImageDimension  )

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

template<class TInputImage, class TOutputImage> itk::AccumulateImageFilter< TInputImage, TOutputImage >::itkStaticConstMacro (  InputImageDimension  , unsigned  int, TInputImage::ImageDimension  )

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

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

Method for creation through the object factory. Reimplemented from itk::Object.

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

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

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

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

---

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

• itkAccumulateImageFilter.h

---