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

#include <itkPadImageFilter.h>

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

List of all members.

Public Types

typedef BoundaryConditionTypeBoundaryConditionPointerType
typedef ImageBoundaryCondition
< TInputImage, TOutputImage > 
BoundaryConditionType
typedef SmartPointer< const SelfConstPointer
typedef TInputImage::IndexType InputImageIndexType
typedef TInputImage::PixelType InputImagePixelType
typedef TInputImage::RegionType InputImageRegionType
typedef TInputImage::SizeType InputImageSizeType
typedef TOutputImage::IndexType OutputImageIndexType
typedef TOutputImage::PixelType OutputImagePixelType
typedef TOutputImage::RegionType OutputImageRegionType
typedef TOutputImage::SizeType OutputImageSizeType
typedef SmartPointer< SelfPointer
typedef PadImageFilter Self
typedef TInputImage::SizeType SizeType
typedef TInputImage::SizeValueType SizeValueType
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef
InputImageType::ConstPointer 
InputImageConstPointer
typedef InputImageType::Pointer InputImagePointer
typedef TInputImage InputImageType
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
typedef DataObject::Pointer DataObjectPointer
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
typedef OutputImageType::Pointer OutputImagePointer
typedef TOutputImage OutputImageType
- 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
void SetPadBound (const InputImageSizeType &bound)
virtual void SetPadLowerBound (SizeType _arg)
virtual void SetPadUpperBound (SizeType _arg)
virtual const SizeTypeGetPadLowerBound ()
virtual const SizeTypeGetPadUpperBound ()
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 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 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

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 ()
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 &)
 PadImageFilter (const Self &)

Private Attributes

BoundaryConditionPointerType m_BoundaryCondition
SizeType m_PadLowerBound
SizeType m_PadUpperBound

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

Increase the image size by padding. Superclass for filters that fill in extra pixels.

PadImageFilter.png
Visual explanation of padding regions.

PadImageFilter changes the image boundary of an image by padding each dimension with subclass defined algorithms. The number of pixels to pad for the upper and lower bounds of each dimension must be specified.

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

See also:
WrapPadImageFilter, MirrorPadImageFilter, ConstantPadImageFilter

Definition at line 47 of file itkPadImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TOutputImage >
typedef BoundaryConditionType* itk::PadImageFilter< TInputImage, TOutputImage >::BoundaryConditionPointerType

Definition at line 78 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef ImageBoundaryCondition< TInputImage, TOutputImage > itk::PadImageFilter< TInputImage, TOutputImage >::BoundaryConditionType

Typedef to describe the boundary condition.

Definition at line 77 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef SmartPointer< const Self > itk::PadImageFilter< TInputImage, TOutputImage >::ConstPointer
template<class TInputImage , class TOutputImage >
typedef TInputImage::IndexType itk::PadImageFilter< TInputImage, TOutputImage >::InputImageIndexType
template<class TInputImage , class TOutputImage >
typedef TInputImage::PixelType itk::PadImageFilter< TInputImage, TOutputImage >::InputImagePixelType
template<class TInputImage , class TOutputImage >
typedef TInputImage::RegionType itk::PadImageFilter< TInputImage, TOutputImage >::InputImageRegionType
template<class TInputImage , class TOutputImage >
typedef TInputImage::SizeType itk::PadImageFilter< TInputImage, TOutputImage >::InputImageSizeType
template<class TInputImage , class TOutputImage >
typedef TOutputImage::IndexType itk::PadImageFilter< TInputImage, TOutputImage >::OutputImageIndexType
template<class TInputImage , class TOutputImage >
typedef TOutputImage::PixelType itk::PadImageFilter< TInputImage, TOutputImage >::OutputImagePixelType
template<class TInputImage , class TOutputImage >
typedef TOutputImage::RegionType itk::PadImageFilter< TInputImage, TOutputImage >::OutputImageRegionType
template<class TInputImage , class TOutputImage >
typedef TOutputImage::SizeType itk::PadImageFilter< TInputImage, TOutputImage >::OutputImageSizeType
template<class TInputImage , class TOutputImage >
typedef SmartPointer< Self > itk::PadImageFilter< TInputImage, TOutputImage >::Pointer
template<class TInputImage , class TOutputImage >
typedef PadImageFilter itk::PadImageFilter< TInputImage, TOutputImage >::Self
template<class TInputImage , class TOutputImage >
typedef TInputImage::SizeType itk::PadImageFilter< TInputImage, TOutputImage >::SizeType
template<class TInputImage , class TOutputImage >
typedef TInputImage::SizeValueType itk::PadImageFilter< TInputImage, TOutputImage >::SizeValueType

Definition at line 74 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef ImageToImageFilter< TInputImage, TOutputImage > itk::PadImageFilter< TInputImage, TOutputImage >::Superclass

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >
itk::PadImageFilter< TInputImage, TOutputImage >::PadImageFilter ( )
protected
template<class TInputImage , class TOutputImage >
itk::PadImageFilter< TInputImage, TOutputImage >::~PadImageFilter ( )
inlineprotected

Definition at line 110 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >
itk::PadImageFilter< TInputImage, TOutputImage >::PadImageFilter ( const Self )
private

Member Function Documentation

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

Reimplemented in itk::ZeroFluxNeumannPadImageFilter< TInputImage, TOutputImage >, itk::WrapPadImageFilter< TInputImage, TOutputImage >, itk::MirrorPadImageFilter< TInputImage, TOutputImage >, and itk::ConstantPadImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
virtual void itk::PadImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )
protectedvirtual

PadImageFilter needs a smaller input requested region than output requested region. As such, PadImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See also:
ProcessObject::GenerateInputRequestedRegion()

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

Reimplemented in itk::MirrorPadImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
virtual void itk::PadImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( )
protectedvirtual

PadImageFilter produces an image which is a different resolution than its input image. As such, PadImageFilter needs to provide an implementation for GenerateOutputInformation() in order to inform the pipeline execution model. The original documentation of this method is below.

See also:
ProcessObject::GenerateOutputInformaton()

Reimplemented from itk::ProcessObject.

template<class TInputImage , class TOutputImage >
virtual BoundaryConditionPointerType itk::PadImageFilter< TInputImage, TOutputImage >::GetBoundaryCondition ( ) const
virtual

Set/get the boundary condition.

template<class TInputImage , class TOutputImage >
virtual const char* itk::PadImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual
template<class TInputImage , class TOutputImage >
virtual const SizeType& itk::PadImageFilter< TInputImage, TOutputImage >::GetPadLowerBound ( )
virtual

Set/Get the output image padding. Default is no padding (same as input).

template<class TInputImage , class TOutputImage >
virtual const SizeType& itk::PadImageFilter< TInputImage, TOutputImage >::GetPadUpperBound ( )
virtual

Set/Get the output image padding. Default is no padding (same as input).

template<class TInputImage , class TOutputImage >
void itk::PadImageFilter< TInputImage, TOutputImage >::InternalSetBoundaryCondition ( const BoundaryConditionPointerType  boundaryCondition)
protected

Method for subclasses to set the boundary condition.

template<class TInputImage , class TOutputImage >
static Pointer itk::PadImageFilter< TInputImage, TOutputImage >::New ( )
static
template<class TInputImage , class TOutputImage >
void itk::PadImageFilter< 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 >.

Reimplemented in itk::MirrorPadImageFilter< TInputImage, TOutputImage >, itk::ConstantPadImageFilter< TInputImage, TOutputImage >, itk::ZeroFluxNeumannPadImageFilter< TInputImage, TOutputImage >, and itk::WrapPadImageFilter< TInputImage, TOutputImage >.

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

Reimplemented in itk::ConstantPadImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >
virtual void itk::PadImageFilter< TInputImage, TOutputImage >::SetBoundaryCondition ( BoundaryConditionPointerType  _arg)
virtual

Set/get the boundary condition.

template<class TInputImage , class TOutputImage >
void itk::PadImageFilter< TInputImage, TOutputImage >::SetPadBound ( const InputImageSizeType bound)
inline

Definition at line 97 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >
virtual void itk::PadImageFilter< TInputImage, TOutputImage >::SetPadLowerBound ( SizeType  _arg)
virtual

Set/Get the output image padding. Default is no padding (same as input).

template<class TInputImage , class TOutputImage >
virtual void itk::PadImageFilter< TInputImage, TOutputImage >::SetPadLowerBound ( const SizeValueType  data[])
virtual

Set/Get the output image padding. Default is no padding (same as input).

template<class TInputImage , class TOutputImage >
virtual void itk::PadImageFilter< TInputImage, TOutputImage >::SetPadUpperBound ( SizeType  _arg)
virtual

Set/Get the output image padding. Default is no padding (same as input).

template<class TInputImage , class TOutputImage >
virtual void itk::PadImageFilter< TInputImage, TOutputImage >::SetPadUpperBound ( const SizeValueType  data[])
virtual

Set/Get the output image padding. Default is no padding (same as input).

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

This class can be multithreaded.

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in itk::MirrorPadImageFilter< TInputImage, TOutputImage >.


Member Data Documentation

template<class TInputImage , class TOutputImage >
const unsigned int itk::PadImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension
static
template<class TInputImage , class TOutputImage >
BoundaryConditionPointerType itk::PadImageFilter< TInputImage, TOutputImage >::m_BoundaryCondition
private

Definition at line 142 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >
SizeType itk::PadImageFilter< TInputImage, TOutputImage >::m_PadLowerBound
private

Definition at line 139 of file itkPadImageFilter.h.

template<class TInputImage , class TOutputImage >
SizeType itk::PadImageFilter< TInputImage, TOutputImage >::m_PadUpperBound
private

Definition at line 140 of file itkPadImageFilter.h.


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