itk::WrapPadImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkWrapPadImageFilter.h>

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

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

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputImageConstPointer	InputImageConstPointer
typedef Superclass::InputImageIndexType	InputImageIndexType
typedef Superclass::InputImagePixelType	InputImagePixelType
typedef Superclass::InputImagePointer	InputImagePointer
typedef Superclass::InputImageRegionType	InputImageRegionType
typedef Superclass::InputImageSizeType	InputImageSizeType
typedef Superclass::InputImageType	InputImageType
typedef Superclass::OutputImageIndexType	OutputImageIndexType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImagePointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef Superclass::OutputImageSizeType	OutputImageSizeType
typedef Superclass::OutputImageType	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef WrapPadImageFilter	Self
typedef PadImageFilter < TInputImage, TOutputImage >	Superclass
Public Types inherited from itk::PadImageFilter< TInputImage, TOutputImage >
typedef BoundaryConditionType *	BoundaryConditionPointerType
typedef ImageBoundaryCondition < TInputImage, TOutputImage >	BoundaryConditionType
typedef TInputImage::SizeType	SizeType
typedef TInputImage::SizeValueType	SizeValueType
Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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::Convertible< InputImagePixelType, OutputImagePixelType >) InputConvertibleToOutputCheck
Public Member Functions inherited from itk::PadImageFilter< TInputImage, TOutputImage >
void	SetPadBound (const InputImageSizeType &bound)
virtual void	SetPadLowerBound (SizeType _arg)
virtual void	SetPadUpperBound (SizeType _arg)
virtual const SizeType &	GetPadLowerBound ()
virtual const SizeType &	GetPadUpperBound ()
virtual void	SetPadLowerBound (const SizeValueType data[])
virtual void	SetPadUpperBound (const SizeValueType data[])
virtual void	SetBoundaryCondition (BoundaryConditionPointerType _arg)
virtual BoundaryConditionPointerType	GetBoundaryCondition () const
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::PadImageFilter< TInputImage, TOutputImage >
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
	WrapPadImageFilter ()
	~WrapPadImageFilter ()
Protected Member Functions inherited from itk::PadImageFilter< TInputImage, TOutputImage >
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
void	InternalSetBoundaryCondition (const BoundaryConditionPointerType boundaryCondition)
	PadImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
	~PadImageFilter ()
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 ()
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
void	operator= (const Self &)
	WrapPadImageFilter (const Self &)

Private Attributes
PeriodicBoundaryCondition < TInputImage, TOutputImage >	m_InternalBoundaryCondition

---

Detailed Description

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

Increase the image size by padding with replicants of the input image value.

WrapPadImageFilter changes the image bounds of an image. Added pixels are filled in with a wrapped replica of the input image. For instance, if the output image needs a pixel that is two pixels to the left of the LargestPossibleRegion of the input image, the value assigned will be from the pixel two pixels inside the right boundary of the LargestPossibleRegion. The image bounds of the output must be specified.

Visual explanation of padding regions.

This filter is implemented as a multithreaded filter. It provides a ThreadedGenerateData() method for its implementation.

See also:

MirrorPadImageFilter, ConstantPadImageFilter

Wiki Examples:

• All Examples

• Pad an image by wrapping

Definition at line 53 of file itkWrapPadImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage , class TOutputImage >

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

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

Definition at line 61 of file itkWrapPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::InputImageConstPointer itk::WrapPadImageFilter< TInputImage, TOutputImage >::InputImageConstPointer

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

Definition at line 73 of file itkWrapPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::InputImageIndexType itk::WrapPadImageFilter< TInputImage, TOutputImage >::InputImageIndexType

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

Definition at line 85 of file itkWrapPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::InputImagePixelType itk::WrapPadImageFilter< TInputImage, TOutputImage >::InputImagePixelType

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

Definition at line 81 of file itkWrapPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::InputImagePointer itk::WrapPadImageFilter< TInputImage, TOutputImage >::InputImagePointer

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

Definition at line 71 of file itkWrapPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::InputImageRegionType itk::WrapPadImageFilter< TInputImage, TOutputImage >::InputImageRegionType

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

Definition at line 77 of file itkWrapPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::InputImageSizeType itk::WrapPadImageFilter< TInputImage, TOutputImage >::InputImageSizeType

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

Definition at line 87 of file itkWrapPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::InputImageType itk::WrapPadImageFilter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs.

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

Definition at line 67 of file itkWrapPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::OutputImageIndexType itk::WrapPadImageFilter< TInputImage, TOutputImage >::OutputImageIndexType

Typedef to describe the output and input image index and size types.

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

Definition at line 84 of file itkWrapPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::OutputImagePixelType itk::WrapPadImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Typedef to describe the type of pixel.

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

Definition at line 80 of file itkWrapPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::OutputImagePointer itk::WrapPadImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 72 of file itkWrapPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::OutputImageRegionType itk::WrapPadImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Typedef to describe the output image region type.

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

Definition at line 76 of file itkWrapPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::OutputImageSizeType itk::WrapPadImageFilter< TInputImage, TOutputImage >::OutputImageSizeType

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

Definition at line 86 of file itkWrapPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef Superclass::OutputImageType itk::WrapPadImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 70 of file itkWrapPadImageFilter.h.

template<class TInputImage , class TOutputImage >

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

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

Definition at line 60 of file itkWrapPadImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Standard class typedefs.

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

Definition at line 58 of file itkWrapPadImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef PadImageFilter< TInputImage, TOutputImage > itk::WrapPadImageFilter< TInputImage, TOutputImage >::Superclass

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

Definition at line 59 of file itkWrapPadImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >

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

protected

End concept checking

template<class TInputImage , class TOutputImage >

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

inlineprotected

Definition at line 102 of file itkWrapPadImageFilter.h.

template<class TInputImage , class TOutputImage >

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

private

---

Member Function Documentation

template<class TInputImage , class TOutputImage >

virtual::itk::LightObject::Pointer itk::WrapPadImageFilter< 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::PadImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

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

virtual

Run-time type information (and related methods).

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

template<class TInputImage , class TOutputImage >

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

static

Method for creation through the object factory.

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

template<class TInputImage , class TOutputImage >

void itk::WrapPadImageFilter< 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::PadImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

itk::WrapPadImageFilter< TInputImage, TOutputImage >::typedef

(

Concept::Convertible< InputImagePixelType, OutputImagePixelType >

)

Begin concept checking This class requires InputConvertibleToOutputCheck in the form of ( Concept::Convertible< InputImagePixelType, OutputImagePixelType > )

---

Member Data Documentation

template<class TInputImage , class TOutputImage >

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

static

ImageDimension enumeration.

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

Definition at line 91 of file itkWrapPadImageFilter.h.

template<class TInputImage , class TOutputImage >

PeriodicBoundaryCondition< TInputImage, TOutputImage > itk::WrapPadImageFilter< TInputImage, TOutputImage >::m_InternalBoundaryCondition

private

Definition at line 108 of file itkWrapPadImageFilter.h.

---

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

• itkWrapPadImageFilter.h