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

#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 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 ProjectionImageFilter Self
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef
InputImageType::ConstPointer 
InputImageConstPointer
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
typedef DataObject::Pointer DataObjectPointer
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
- Public Types inherited from itk::ProcessObject
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
typedef std::vector
< DataObjectIdentifierType
NameArray
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
 typedef (Concept::SameDimensionOrMinusOne< itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >) ImageDimensionCheck
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput (void) const
const InputImageTypeGetInput (unsigned int idx) const
virtual void PopBackInput ()
virtual void PopFrontInput ()
virtual void PushBackInput (const InputImageType *image)
virtual void PushFrontInput (const InputImageType *image)
virtual void SetInput (const InputImageType *image)
virtual void SetInput (unsigned int, const TInputImage *image)
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
virtual void GraftOutput (DataObject *output)
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageTypeGetOutput (void)
const OutputImageTypeGetOutput (void) const
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
virtual void AbortGenerateDataOn ()
virtual void EnlargeOutputRequestedRegion (DataObject *)
virtual const bool & GetAbortGenerateData ()
NameArray GetInputNames () const
MultiThreader * GetMultiThreader () const
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType GetNumberOfInputs () const
DataObjectPointerArraySizeType GetNumberOfOutputs () const
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
NameArray GetOutputNames () const
virtual const float & GetProgress ()
NameArray GetRequiredInputNames () const
bool HasInput (const DataObjectIdentifierType &key) const
bool HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
virtual void PrepareOutputs ()
virtual void PropagateRequestedRegion (DataObject *output)
virtual void ResetPipeline ()
virtual void SetAbortGenerateData (bool _arg)
virtual void SetProgress (float _arg)
virtual void Update ()
virtual void UpdateLargestPossibleRegion ()
virtual void UpdateOutputData (DataObject *output)
virtual void UpdateOutputInformation ()
void UpdateProgress (float amount)
DataObjectPointerArray GetInputs ()
DataObjectPointerArray GetOutputs ()
DataObjectPointerArray GetIndexedInputs ()
DataObjectPointerArray GetIndexedOutputs ()
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
virtual void SetReleaseDataFlag (bool flag)
virtual bool GetReleaseDataFlag () const
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool & GetReleaseDataBeforeUpdateFlag ()
virtual void ReleaseDataBeforeUpdateFlagOn ()
virtual void ReleaseDataBeforeUpdateFlagOff ()
virtual void SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdTypeGetNumberOfThreads ()
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const
virtual void DebugOff () const
virtual void DebugOn () const
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long GetMTime () const
virtual const TimeStampGetTimeStamp () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void Modified () const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
virtual int GetReferenceCount () const
 itkCloneMacro (Self)
void Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >

Protected Member Functions

virtual void GenerateInputRequestedRegion ()
virtual void GenerateOutputInformation ()
virtual AccumulatorType NewAccumulator (SizeValueType) const
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 ImageToImageFilter ()
virtual void VerifyInputInformation ()
 ~ImageToImageFilter ()
void PushBackInput (const DataObject *input)
void PushFrontInput (const DataObject *input)
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
virtual void AllocateOutputs ()
virtual void BeforeThreadedGenerateData ()
virtual void GenerateData ()
 ImageSource ()
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual ~ImageSource ()
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
virtual void AddOutput (DataObject *output)
bool AddRequiredInputName (const DataObjectIdentifierType &)
virtual void CacheInputReleaseDataFlags ()
virtual void GenerateOutputRequestedRegion (DataObject *output)
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
bool IsIndexedName (const DataObjectIdentifierType &) const
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType MakeNameFromIndex (DataObjectPointerArraySizeType) const
 ProcessObject ()
virtual void PropagateResetPipeline ()
virtual void ReleaseInputs ()
virtual void RemoveInput (const DataObjectIdentifierType &key)
virtual void RemoveInput (DataObjectPointerArraySizeType)
virtual void RemoveOutput (const DataObjectIdentifierType &key)
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void RestoreInputReleaseDataFlags ()
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void SetPrimaryInput (DataObject *input)
virtual void SetPrimaryOutput (DataObject *output)
void SetRequiredInputNames (const NameArray &)
virtual void VerifyPreconditions ()
 ~ProcessObject ()
DataObjectGetInput (const DataObjectIdentifierType &key)
const DataObjectGetInput (const DataObjectIdentifierType &key) const
DataObjectGetInput (DataObjectPointerArraySizeType)
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryInput ()
const DataObjectGetPrimaryInput () const
DataObjectGetOutput (const DataObjectIdentifierType &key)
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryOutput ()
const DataObjectGetPrimaryOutput () const
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~Object ()
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 LightObject ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual ~LightObject ()

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

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType

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
template<class TInputImage, class TOutputImage, class TAccumulator>
typedef SmartPointer< const Self > itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::ConstPointer
template<class TInputImage, class TOutputImage, class TAccumulator>
typedef InputImageType::PixelType itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::InputImagePixelType
template<class TInputImage, class TOutputImage, class TAccumulator>
typedef InputImageType::Pointer itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::InputImagePointer
template<class TInputImage, class TOutputImage, class TAccumulator>
typedef InputImageType::RegionType itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::InputImageRegionType
template<class TInputImage, class TOutputImage, class TAccumulator>
typedef TInputImage itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::InputImageType
template<class TInputImage, class TOutputImage, class TAccumulator>
typedef OutputImageType::PixelType itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::OutputImagePixelType
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
template<class TInputImage, class TOutputImage, class TAccumulator>
typedef SmartPointer< Self > itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::Pointer
template<class TInputImage, class TOutputImage, class TAccumulator>
typedef ProjectionImageFilter itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::Self
template<class TInputImage, class TOutputImage, class TAccumulator>
typedef ImageToImageFilter< TInputImage, TOutputImage > itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::Superclass

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 ( )
inlineprotectedvirtual

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
template<class TInputImage, class TOutputImage, class TAccumulator>
virtual void itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::GenerateInputRequestedRegion ( )
protectedvirtual

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 ( )
protectedvirtual

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
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
template<class TInputImage, class TOutputImage, class TAccumulator>
virtual AccumulatorType itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::NewAccumulator ( SizeValueType  ) const
protectedvirtual
template<class TInputImage, class TOutputImage, class TAccumulator>
void itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::operator= ( const Self )
private
template<class TInputImage, class TOutputImage, class TAccumulator>
void itk::ProjectionImageFilter< TInputImage, TOutputImage, TAccumulator >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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 
)
protectedvirtual

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: