itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator > Class Template Reference

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

#include <itkProjectionImageFilter.h>

Inheritance diagram for itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >:

Collaboration diagram for itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >:

List of all members.

Public Types
typedef TAccumulator	AccumulatorType
typedef SmartPointer< const Self >	ConstPointer
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< Self >	Pointer
typedef ProjectionImageFilter	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
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
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual AccumulatorType	NewAccumulator (SizeValueType) const
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
Private Member Functions
void	operator= (const Self &)
	ProjectionImageFilter (const Self &)
Private Attributes
unsigned int	m_ProjectionDimension
virtual void	SetProjectionDimension (unsigned int _arg)
virtual const unsigned int &	GetProjectionDimension ()
	ProjectionImageFilter ()
virtual	~ProjectionImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

template<class TInputImage, class TOutputImage, class TAccumulator>
class itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >

Implements an accumulation of an image along a selected direction.

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

Each pixel is the cumulative sum of the pixels along the collapsed dimension and reduces 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.

This class was contributed to the Insight Journal by Emilian Beronich and Gaetan Lehmann. The original paper can be found at http://hdl.handle.net/1926/164

Author:

Emiliano Beronich

Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

See also:

AccumulateImageFilter

Definition at line 55 of file itkProjectionImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef TAccumulator itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::AccumulatorType

Reimplemented in itk::BinaryProjectionImageFilter< TInputImage, TOutputImage >, and itk::BinaryThresholdProjectionImageFilter< TInputImage, TOutputImage >.

Definition at line 81 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef SmartPointer< const Self > itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::ConstPointer

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

Reimplemented in itk::BinaryProjectionImageFilter< TInputImage, TOutputImage >, itk::MaximumProjectionImageFilter< TInputImage, TOutputImage >, itk::MeanProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::MedianProjectionImageFilter< TInputImage, TOutputImage >, itk::MinimumProjectionImageFilter< TInputImage, TOutputImage >, itk::StandardDeviationProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::SumProjectionImageFilter< TInputImage, TOutputImage >, and itk::BinaryThresholdProjectionImageFilter< TInputImage, TOutputImage >.

Definition at line 63 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef InputImageType::PixelType itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::InputImagePixelType

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

Definition at line 75 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef InputImageType::Pointer itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::InputImagePointer

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

Definition at line 73 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef InputImageType::RegionType itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::InputImageRegionType

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

Definition at line 74 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef TInputImage itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::InputImageType

Some convenient typedefs.

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

Reimplemented in itk::BinaryProjectionImageFilter< TInputImage, TOutputImage >, itk::MaximumProjectionImageFilter< TInputImage, TOutputImage >, itk::MeanProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::MinimumProjectionImageFilter< TInputImage, TOutputImage >, itk::StandardDeviationProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::SumProjectionImageFilter< TInputImage, TOutputImage >, and itk::BinaryThresholdProjectionImageFilter< TInputImage, TOutputImage >.

Definition at line 69 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef OutputImageType::PixelType itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::OutputImagePixelType

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

Definition at line 79 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef OutputImageType::Pointer itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 77 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef OutputImageType::RegionType itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::OutputImageRegionType

Superclass typedefs.

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

Definition at line 78 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef TOutputImage itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in itk::BinaryProjectionImageFilter< TInputImage, TOutputImage >, itk::MeanProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::SumProjectionImageFilter< TInputImage, TOutputImage >, and itk::BinaryThresholdProjectionImageFilter< TInputImage, TOutputImage >.

Definition at line 76 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef SmartPointer< Self > itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::Pointer

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

Reimplemented in itk::BinaryProjectionImageFilter< TInputImage, TOutputImage >, itk::MaximumProjectionImageFilter< TInputImage, TOutputImage >, itk::MeanProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::MedianProjectionImageFilter< TInputImage, TOutputImage >, itk::MinimumProjectionImageFilter< TInputImage, TOutputImage >, itk::StandardDeviationProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::SumProjectionImageFilter< TInputImage, TOutputImage >, and itk::BinaryThresholdProjectionImageFilter< TInputImage, TOutputImage >.

Definition at line 62 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef ProjectionImageFilter itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::Self

Standard class typedefs.

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

Reimplemented in itk::BinaryProjectionImageFilter< TInputImage, TOutputImage >, itk::MaximumProjectionImageFilter< TInputImage, TOutputImage >, itk::MeanProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::MedianProjectionImageFilter< TInputImage, TOutputImage >, itk::MinimumProjectionImageFilter< TInputImage, TOutputImage >, itk::StandardDeviationProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::SumProjectionImageFilter< TInputImage, TOutputImage >, and itk::BinaryThresholdProjectionImageFilter< TInputImage, TOutputImage >.

Definition at line 60 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

typedef ImageToImageFilter< TInputImage, TOutputImage > itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::Superclass

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

Reimplemented in itk::BinaryProjectionImageFilter< TInputImage, TOutputImage >, itk::MaximumProjectionImageFilter< TInputImage, TOutputImage >, itk::MeanProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::MedianProjectionImageFilter< TInputImage, TOutputImage >, itk::MinimumProjectionImageFilter< TInputImage, TOutputImage >, itk::StandardDeviationProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::SumProjectionImageFilter< TInputImage, TOutputImage >, and itk::BinaryThresholdProjectionImageFilter< TInputImage, TOutputImage >.

Definition at line 61 of file itkProjectionImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage, class TAccumulator>

itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::ProjectionImageFilter

(

)

[protected]

End concept checking Set/Get 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, class TAccumulator>

virtual itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::~ProjectionImageFilter

(

)

[inline, protected, virtual]

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

Definition at line 109 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::ProjectionImageFilter

(

const Self &

)

[private]

---

Member Function Documentation

template<class TInputImage, class TOutputImage, class TAccumulator>

virtual::itk::LightObject::Pointer itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::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::BinaryProjectionImageFilter< TInputImage, TOutputImage >, itk::MaximumProjectionImageFilter< TInputImage, TOutputImage >, itk::MeanProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::MedianProjectionImageFilter< TInputImage, TOutputImage >, itk::MinimumProjectionImageFilter< TInputImage, TOutputImage >, itk::StandardDeviationProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::SumProjectionImageFilter< TInputImage, TOutputImage >, and itk::BinaryThresholdProjectionImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TAccumulator>

virtual void itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::GenerateInputRequestedRegion

(

)

[protected, virtual]

Apply changes to the input image requested region.

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

template<class TInputImage, class TOutputImage, class TAccumulator>

virtual void itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::GenerateOutputInformation

(

)

[protected, virtual]

Apply changes to the output image information.

Reimplemented from itk::ProcessObject.

template<class TInputImage, class TOutputImage, class TAccumulator>

virtual const char* itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::GetNameOfClass

(

)

const [virtual]

Run-time type information (and related methods).

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

Reimplemented in itk::BinaryProjectionImageFilter< TInputImage, TOutputImage >, itk::MaximumProjectionImageFilter< TInputImage, TOutputImage >, itk::MeanProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::MedianProjectionImageFilter< TInputImage, TOutputImage >, itk::MinimumProjectionImageFilter< TInputImage, TOutputImage >, itk::StandardDeviationProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::SumProjectionImageFilter< TInputImage, TOutputImage >, and itk::BinaryThresholdProjectionImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TAccumulator>

virtual const unsigned int& itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::GetProjectionDimension

(

)

[virtual]

End concept checking Set/Get 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, class TAccumulator>

static Pointer itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::New

(

)

[static]

Method for creation through the object factory.

Reimplemented from itk::Object.

Reimplemented in itk::BinaryProjectionImageFilter< TInputImage, TOutputImage >, itk::MaximumProjectionImageFilter< TInputImage, TOutputImage >, itk::MeanProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::MedianProjectionImageFilter< TInputImage, TOutputImage >, itk::MinimumProjectionImageFilter< TInputImage, TOutputImage >, itk::StandardDeviationProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::SumProjectionImageFilter< TInputImage, TOutputImage >, and itk::BinaryThresholdProjectionImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TAccumulator>

virtual AccumulatorType itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::NewAccumulator

(

SizeValueType

)

const [protected, virtual]

Reimplemented in itk::BinaryProjectionImageFilter< TInputImage, TOutputImage >, and itk::BinaryThresholdProjectionImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TAccumulator>

void itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::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::BinaryProjectionImageFilter< TInputImage, TOutputImage >, itk::MaximumProjectionImageFilter< TInputImage, TOutputImage >, itk::MeanProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::MedianProjectionImageFilter< TInputImage, TOutputImage >, itk::MinimumProjectionImageFilter< TInputImage, TOutputImage >, itk::StandardDeviationProjectionImageFilter< TInputImage, TOutputImage, TAccumulate >, itk::SumProjectionImageFilter< TInputImage, TOutputImage >, and itk::BinaryThresholdProjectionImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TAccumulator>

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

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

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

Reimplemented in itk::BinaryProjectionImageFilter< TInputImage, TOutputImage >, and itk::BinaryThresholdProjectionImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage, class TAccumulator>

virtual void itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::SetProjectionDimension

(

unsigned int

_arg

)

[virtual]

End concept checking Set/Get 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, class TAccumulator>

virtual void itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::ThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		ThreadIdType	threadId
	)		[protected, virtual]

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

See also:

GenerateData(), SplitRequestedRegion()

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage, class TAccumulator>

itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::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, class TAccumulator>

const unsigned int itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::InputImageDimension = TInputImage::ImageDimension [static]

ImageDimension enumeration

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

Definition at line 85 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

unsigned int itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::m_ProjectionDimension [private]

Definition at line 128 of file itkProjectionImageFilter.h.

template<class TInputImage, class TOutputImage, class TAccumulator>

const unsigned int itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::OutputImageDimension = TOutputImage::ImageDimension [static]

ImageDimension enumeration

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

Definition at line 87 of file itkProjectionImageFilter.h.

---

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

• itkProjectionImageFilter.h