#include <itkBoxImageFilter.h>

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

Collaboration diagram for itk::BoxImageFilter< TInputImage, TOutputImage >:

Public Types
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 InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
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
void	GenerateInputRequestedRegion ()
virtual const char *	GetNameOfClass () const
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	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 >

Protected Member Functions
	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 void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
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
	BoxImageFilter (const Self &)
void	operator= (const Self &)

Private Attributes
RadiusType	m_Radius

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 itk::BoxImageFilter< TInputImage, TOutputImage >

A base class for all the filters working on a box neighborhood.

This filter provides the code to store the radius information about the neighborhood used in the subclasses. It also conveniently reimplement the GenerateInputRequestedRegion() so that region is well defined for the provided radius.

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

Definition at line 40 of file itkBoxImageFilter.h.

Member Typedef Documentation

template<class TInputImage, class TOutputImage>

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

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

Definition at line 48 of file itkBoxImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef TInputImage::IndexType itk::BoxImageFilter< TInputImage, TOutputImage >::IndexType

Definition at line 61 of file itkBoxImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef TInputImage itk::BoxImageFilter< TInputImage, TOutputImage >::InputImageType

Image related typedefs.

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

Definition at line 55 of file itkBoxImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef TInputImage::PixelType itk::BoxImageFilter< TInputImage, TOutputImage >::InputPixelType

Definition at line 64 of file itkBoxImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef TInputImage::OffsetType itk::BoxImageFilter< TInputImage, TOutputImage >::OffsetType

Definition at line 62 of file itkBoxImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef TOutputImage itk::BoxImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 66 of file itkBoxImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef TOutputImage::PixelType itk::BoxImageFilter< TInputImage, TOutputImage >::OutputPixelType

Definition at line 67 of file itkBoxImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef SmartPointer< Self > itk::BoxImageFilter< TInputImage, TOutputImage >::Pointer

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

Definition at line 47 of file itkBoxImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef TInputImage::SizeType itk::BoxImageFilter< TInputImage, TOutputImage >::RadiusType

n-dimensional Kernel radius.

Definition at line 74 of file itkBoxImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef TInputImage::SizeValueType itk::BoxImageFilter< TInputImage, TOutputImage >::RadiusValueType

Reimplemented in itk::GPUBoxImageFilter< TInputImage, TOutputImage, MeanImageFilter< TInputImage, TOutputImage > >.

Definition at line 75 of file itkBoxImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef TInputImage::RegionType itk::BoxImageFilter< TInputImage, TOutputImage >::RegionType

Definition at line 59 of file itkBoxImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef BoxImageFilter itk::BoxImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

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

Definition at line 45 of file itkBoxImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef TInputImage::SizeType itk::BoxImageFilter< TInputImage, TOutputImage >::SizeType

Definition at line 60 of file itkBoxImageFilter.h.

template<class TInputImage, class TOutputImage>

typedef ImageToImageFilter< TInputImage, TOutputImage > itk::BoxImageFilter< TInputImage, TOutputImage >::Superclass

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

Definition at line 46 of file itkBoxImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage>

itk::BoxImageFilter< TInputImage, TOutputImage >::BoxImageFilter ( )

protected

template<class TInputImage, class TOutputImage>

itk::BoxImageFilter< TInputImage, TOutputImage >::~BoxImageFilter ( )

inlineprotected

Definition at line 87 of file itkBoxImageFilter.h.

template<class TInputImage, class TOutputImage>

itk::BoxImageFilter< TInputImage, TOutputImage >::BoxImageFilter ( const Self & )

private

Member Function Documentation

template<class TInputImage, class TOutputImage>

virtual::itk::LightObject::Pointer itk::BoxImageFilter< 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::Object.

template<class TInputImage, class TOutputImage>

void itk::BoxImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )

virtual

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierarchy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See also:: ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

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

Reimplemented in itk::BinaryOpeningByReconstructionImageFilter< TInputImage, TKernel >, and itk::BinaryClosingByReconstructionImageFilter< TInputImage, TKernel >.

template<class TInputImage, class TOutputImage>

virtual const char* itk::BoxImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

virtual

Runtime information support.

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

template<class TInputImage, class TOutputImage>

virtual const RadiusType& itk::BoxImageFilter< TInputImage, TOutputImage >::GetRadius ( )

virtual

template<class TInputImage, class TOutputImage>

static Pointer itk::BoxImageFilter< TInputImage, TOutputImage >::New ( )

static

Standard New method.

Reimplemented from itk::Object.

template<class TInputImage, class TOutputImage>

void itk::BoxImageFilter< 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::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage>

void itk::BoxImageFilter< TInputImage, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

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::BoxImageFilter< TInputImage, TOutputImage >::SetRadius ( const RadiusType & radius )

virtual

Reimplemented in itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >, itk::KernelImageFilter< TInputImage, TInputImage, TKernel >, itk::KernelImageFilter< TImage, TImage, TKernel >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, and itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, RankImageFilter< TInputImage, TInputImage, FlatStructuringElement< ::itk::GetImageDimension< TInputImage >::ImageDimension > > >.

template<class TInputImage, class TOutputImage>

virtual void itk::BoxImageFilter< TInputImage, TOutputImage >::SetRadius ( const RadiusValueType & radius )

virtual

Member Data Documentation

template<class TInputImage, class TOutputImage>

const unsigned int itk::BoxImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension

static

Image related typedefs.

Definition at line 71 of file itkBoxImageFilter.h.

template<class TInputImage, class TOutputImage>

RadiusType itk::BoxImageFilter< TInputImage, TOutputImage >::m_Radius

private

Definition at line 95 of file itkBoxImageFilter.h.

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

itkBoxImageFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class TInputImage, class TOutputImage> class itk::BoxImageFilter< TInputImage, TOutputImage >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TInputImage, class TOutputImage>
class itk::BoxImageFilter< TInputImage, TOutputImage >