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

#include <itkBoxMeanImageFilter.h>

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

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer
typedef TInputImage::IndexType IndexType
typedef TInputImage InputImageType
typedef TInputImage::OffsetType OffsetType
typedef
Superclass::OutputImageRegionType 		OutputImageRegionType
typedef TOutputImage OutputImageType
typedef TOutputImage::PixelType OutputPixelType
typedef TInputImage::PixelType PixelType
typedef SmartPointer< Self > Pointer
typedef TInputImage::RegionType RegionType
typedef BoxMeanImageFilter Self
typedef TInputImage::SizeType SizeType
typedef BoxImageFilter
< TInputImage, TOutputImage > 		Superclass
- Public Types inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
typedef TInputImage::PixelType InputPixelType
typedef TInputImage::SizeType RadiusType
typedef TInputImage::SizeValueType RadiusValueType
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef
InputImageType::ConstPointer 		InputImageConstPointer
typedef InputImageType::PixelType InputImagePixelType
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef
Superclass::OutputImagePixelType 		OutputImagePixelType
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef
Superclass::DataObjectIdentifierType 		DataObjectIdentifierType
typedef DataObject::Pointer DataObjectPointer
typedef
Superclass::DataObjectPointerArraySizeType 		DataObjectPointerArraySizeType
typedef OutputImageType::Pointer OutputImagePointer
- 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::SameDimension< itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >) SameDimension
- Public Member Functions inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
void GenerateInputRequestedRegion ()
virtual const RadiusType & GetRadius ()
virtual void SetRadius (const RadiusType &radius)
virtual void SetRadius (const RadiusValueType &radius)
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType * GetInput (void) const
const InputImageType * GetInput (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 >
OutputImageType * GetOutput (unsigned int idx)
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
virtual void GraftOutput (DataObject *output)
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType * GetOutput (void)
const OutputImageType * GetOutput (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 ThreadIdType & GetNumberOfThreads ()
- 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
Command * GetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionary & GetMetaDataDictionary (void)
const MetaDataDictionary & GetMetaDataDictionary (void) const
virtual unsigned long GetMTime () const
virtual const TimeStamp & GetTimeStamp () 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 OutputImageDimension = TOutputImage::ImageDimension
static const unsigned int InputImageDimension = TInputImage::ImageDimension
- Static Public Attributes inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
static const unsigned int ImageDimension = TInputImage::ImageDimension
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >

Protected Member Functions

 BoxMeanImageFilter ()
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 ~BoxMeanImageFilter ()
- Protected Member Functions inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
 BoxImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
 ~BoxImageFilter ()
- 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 GenerateOutputInformation ()
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 ()
DataObject * GetInput (const DataObjectIdentifierType &key)
const DataObject * GetInput (const DataObjectIdentifierType &key) const
DataObject * GetInput (DataObjectPointerArraySizeType)
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
DataObject * GetPrimaryInput ()
const DataObject * GetPrimaryInput () const
DataObject * GetOutput (const DataObjectIdentifierType &key)
const DataObject * GetOutput (const DataObjectIdentifierType &key) const
DataObject * GetOutput (DataObjectPointerArraySizeType idx)
const DataObject * GetOutput (DataObjectPointerArraySizeType idx) const
DataObject * GetPrimaryOutput ()
const DataObject * GetPrimaryOutput () 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

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

Detailed Description

template<class TInputImage, class TOutputImage = TInputImage>
class itk::BoxMeanImageFilter< TInputImage, TOutputImage >

Implements a fast rectangular mean filter using the accumulator approach.

This code was contributed in the Insight Journal paper: "Efficient implementation of kernel filtering" by Beare R., Lehmann G http://hdl.handle.net/1926/555 http://www.insight-journal.org/browse/publication/160

Author:
Richard Beare

Definition at line 43 of file itkBoxMeanImageFilter.h.

Member Typedef Documentation

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

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

Definition at line 51 of file itkBoxMeanImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
typedef TInputImage::IndexType itk::BoxMeanImageFilter< TInputImage, TOutputImage >::IndexType

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

Definition at line 65 of file itkBoxMeanImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
typedef TInputImage itk::BoxMeanImageFilter< TInputImage, TOutputImage >::InputImageType

Image related typedefs.

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

Definition at line 58 of file itkBoxMeanImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
typedef TInputImage::OffsetType itk::BoxMeanImageFilter< TInputImage, TOutputImage >::OffsetType

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

Definition at line 67 of file itkBoxMeanImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
typedef Superclass::OutputImageRegionType itk::BoxMeanImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Superclass typedefs.

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

Definition at line 68 of file itkBoxMeanImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
typedef TOutputImage itk::BoxMeanImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs.

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

Definition at line 62 of file itkBoxMeanImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
typedef TOutputImage::PixelType itk::BoxMeanImageFilter< TInputImage, TOutputImage >::OutputPixelType

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

Definition at line 69 of file itkBoxMeanImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
typedef TInputImage::PixelType itk::BoxMeanImageFilter< TInputImage, TOutputImage >::PixelType

Definition at line 66 of file itkBoxMeanImageFilter.h.

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

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

Definition at line 50 of file itkBoxMeanImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
typedef TInputImage::RegionType itk::BoxMeanImageFilter< TInputImage, TOutputImage >::RegionType

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

Definition at line 63 of file itkBoxMeanImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
typedef BoxMeanImageFilter itk::BoxMeanImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

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

Definition at line 48 of file itkBoxMeanImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
typedef TInputImage::SizeType itk::BoxMeanImageFilter< TInputImage, TOutputImage >::SizeType

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

Definition at line 64 of file itkBoxMeanImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
typedef BoxImageFilter< TInputImage, TOutputImage > itk::BoxMeanImageFilter< TInputImage, TOutputImage >::Superclass

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

Definition at line 49 of file itkBoxMeanImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage = TInputImage>
itk::BoxMeanImageFilter< TInputImage, TOutputImage >::BoxMeanImageFilter ( )
protected

End concept checking

template<class TInputImage , class TOutputImage = TInputImage>
itk::BoxMeanImageFilter< TInputImage, TOutputImage >::~BoxMeanImageFilter ( )
inlineprotected

Definition at line 88 of file itkBoxMeanImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
itk::BoxMeanImageFilter< TInputImage, TOutputImage >::BoxMeanImageFilter ( const Self &  )
private

Member Function Documentation

template<class TInputImage , class TOutputImage = TInputImage>
virtual::itk::LightObject::Pointer itk::BoxMeanImageFilter< 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::BoxImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage = TInputImage>
virtual const char* itk::BoxMeanImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Runtime information support.

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

template<class TInputImage , class TOutputImage = TInputImage>
static Pointer itk::BoxMeanImageFilter< TInputImage, TOutputImage >::New ( )
static

Standard New method.

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

template<class TInputImage , class TOutputImage = TInputImage>
void itk::BoxMeanImageFilter< 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::BoxImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage = TInputImage>
void itk::BoxMeanImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread,
ThreadIdType  threadId 
)
protectedvirtual

Multi-thread version GenerateData.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage = TInputImage>
itk::BoxMeanImageFilter< TInputImage, TOutputImage >::typedef ( Concept::SameDimension< itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >  )

Begin concept checking This class requires SameDimension in the form of ( Concept::SameDimension< itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) > )

Member Data Documentation

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

Image related typedefs.

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

Definition at line 75 of file itkBoxMeanImageFilter.h.

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

Image related typedefs.

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

Definition at line 73 of file itkBoxMeanImageFilter.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Tue Jul 10 2012 23:55:26 for ITK by doxygen 1.8.1