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.

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 SmartPointer< const Self >	ConstPointer

typedef TInputImage::IndexType	IndexType

typedef TInputImage	InputImageType

typedef TInputImage::PixelType	InputPixelType

typedef TInputImage::OffsetType	OffsetType

typedef TOutputImage	OutputImageType

typedef TOutputImage::PixelType	OutputPixelType

typedef SmartPointer< Self >	Pointer

typedef TInputImage::SizeType	RadiusType

typedef TInputImage::SizeValueType	RadiusValueType

typedef TInputImage::RegionType	RegionType

typedef BoxImageFilter	Self

typedef TInputImage::SizeType	SizeType

typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TInputImage	InputImageType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef SmartPointer< Self >	Pointer

typedef ImageToImageFilter	Self

typedef ImageSource< TOutputImage >	Superclass

Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

typedef OutputImageType::PixelType	OutputImagePixelType

typedef OutputImageType::Pointer	OutputImagePointer

typedef OutputImageType::RegionType	OutputImageRegionType

typedef TOutputImage	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef ImageSource	Self

typedef ProcessObject	Superclass

Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef std::vector < DataObjectIdentifierType >	NameArray

typedef SmartPointer< Self >	Pointer

typedef ProcessObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

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)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

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 ModifiedTimeType	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 Member Functions inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
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 const unsigned int	InputImageDimension = TInputImage::ImageDimension

static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

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

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter (void) const

	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)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))

	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))

	itkLegacyMacro (virtual void RemoveInput(DataObject *input))

	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) 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)

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	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)

virtual void	SetPrimaryInput (DataObject *input)

virtual void	SetPrimaryOutput (DataObject *output)

virtual void	VerifyPreconditions ()

	~ProcessObject ()

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName (void) const

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

void	SetRequiredInputNames (const NameArray &)

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName (void) 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 &)

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

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating