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

#include <itkInterpolateImageFilter.h>

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

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef
Superclass::InputImagePointer 
InputImagePointer
typedef Superclass::InputImageType InputImageType
typedef TInputImage::PixelType InputPixelType
typedef Image< InputPixelType,
itkGetStaticConstMacro(IntermediateImageDimension) > 
IntermediateImageType
typedef
InterpolateImageFunction
< IntermediateImageType
InterpolatorType
typedef
Superclass::OutputImagePointer 
OutputImagePointer
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
typedef Superclass::OutputImageType OutputImageType
typedef SmartPointer< SelfPointer
typedef InterpolateImageFilter Self
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef
InputImageType::ConstPointer 
InputImageConstPointer
typedef InputImageType::PixelType InputImagePixelType
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
- 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

void AfterThreadedGenerateData ()
void BeforeThreadedGenerateData ()
virtual ::itk::LightObject::Pointer CreateAnother (void) const
const InputImageTypeGetInput2 ()
virtual InterpolatorTypeGetInterpolator ()
virtual const char * GetNameOfClass () const
void SetInput2 (const InputImageType *image)
virtual void SetInterpolator (InterpolatorType *_arg)
 typedef (Concept::HasNumericTraits< InputPixelType >) InputHasNumericTraitsCheck
void SetInput1 (const InputImageType *image)
const InputImageTypeGetInput1 ()
virtual void SetDistance (double _arg)
virtual double GetDistance () 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 = TOutputImage::ImageDimension
static const unsigned int IntermediateImageDimension = TOutputImage::ImageDimension + 1
- 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

void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 InterpolateImageFilter ()
 ~InterpolateImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
- 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)
virtual void GenerateInputRequestedRegion ()
 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 AllocateOutputs ()
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 ()
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

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

Private Attributes

double m_Distance
IntermediateImageType::Pointer m_IntermediateImage
InterpolatorType::Pointer m_Interpolator

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

Interpolate an image from two N-D images.

Interpolates an image from two input images of the same type and same dimension (N). In particular, this filter forms an intermediate (N+1)D image by concatenating the two input images and interpolating an image a distance $ d \in [0,1] $ away from the first image.

The interpolation is delegated to a user specified InterpolateImageFunction. By default, linear interpolation is used.

The filter is templated over the input image type and output image type. It assumes that the input and output have the same number of dimensions.

Definition at line 44 of file itkInterpolateImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TOutputImage >
typedef SmartPointer< const Self > itk::InterpolateImageFilter< TInputImage, TOutputImage >::ConstPointer
template<class TInputImage , class TOutputImage >
typedef Superclass::InputImagePointer itk::InterpolateImageFilter< TInputImage, TOutputImage >::InputImagePointer
template<class TInputImage , class TOutputImage >
typedef Superclass::InputImageType itk::InterpolateImageFilter< TInputImage, TOutputImage >::InputImageType

Inherit typedefs from Superclass

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

Definition at line 58 of file itkInterpolateImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef TInputImage::PixelType itk::InterpolateImageFilter< TInputImage, TOutputImage >::InputPixelType

Interpolator typedef.

Definition at line 75 of file itkInterpolateImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef Image< InputPixelType, itkGetStaticConstMacro(IntermediateImageDimension) > itk::InterpolateImageFilter< TInputImage, TOutputImage >::IntermediateImageType

Definition at line 76 of file itkInterpolateImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef InterpolateImageFunction< IntermediateImageType > itk::InterpolateImageFilter< TInputImage, TOutputImage >::InterpolatorType

Definition at line 77 of file itkInterpolateImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef Superclass::OutputImagePointer itk::InterpolateImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 64 of file itkInterpolateImageFilter.h.

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

Superclass typedefs.

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

Definition at line 65 of file itkInterpolateImageFilter.h.

template<class TInputImage , class TOutputImage >
typedef Superclass::OutputImageType itk::InterpolateImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 63 of file itkInterpolateImageFilter.h.

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

Standard class typedefs.

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

Definition at line 49 of file itkInterpolateImageFilter.h.

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

Constructor & Destructor Documentation

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

End concept checking

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

End concept checking

Definition at line 119 of file itkInterpolateImageFilter.h.

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

Member Function Documentation

template<class TInputImage , class TOutputImage >
void itk::InterpolateImageFilter< TInputImage, TOutputImage >::AfterThreadedGenerateData ( )
virtual

This method is used to run after multi-threading.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage >
void itk::InterpolateImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( )
virtual

This method is used to set the state of the filter before multi-threading.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage >
virtual::itk::LightObject::Pointer itk::InterpolateImageFilter< 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 >
virtual double itk::InterpolateImageFilter< TInputImage, TOutputImage >::GetDistance ( ) const
virtual

Set/Get the distance from the first image from which to generate interpolated image. The default value is 0.5

template<class TInputImage , class TOutputImage >
const InputImageType* itk::InterpolateImageFilter< TInputImage, TOutputImage >::GetInput1 ( )
inline

Set/Get the first image

Definition at line 82 of file itkInterpolateImageFilter.h.

template<class TInputImage , class TOutputImage >
const InputImageType* itk::InterpolateImageFilter< TInputImage, TOutputImage >::GetInput2 ( )
template<class TInputImage , class TOutputImage >
virtual InterpolatorType* itk::InterpolateImageFilter< TInputImage, TOutputImage >::GetInterpolator ( )
virtual

Get a pointer to the interpolator function.

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

Run-time type information (and related methods).

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

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

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage , class TOutputImage >
void itk::InterpolateImageFilter< 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::InterpolateImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

End concept checking

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

template<class TInputImage , class TOutputImage >
virtual void itk::InterpolateImageFilter< TInputImage, TOutputImage >::SetDistance ( double  _arg)
virtual

Set/Get the distance from the first image from which to generate interpolated image. The default value is 0.5

template<class TInputImage , class TOutputImage >
void itk::InterpolateImageFilter< TInputImage, TOutputImage >::SetInput1 ( const InputImageType image)
inline

Set/Get the first image

Definition at line 80 of file itkInterpolateImageFilter.h.

template<class TInputImage , class TOutputImage >
void itk::InterpolateImageFilter< TInputImage, TOutputImage >::SetInput2 ( const InputImageType image)

Set/Get the second image

template<class TInputImage , class TOutputImage >
virtual void itk::InterpolateImageFilter< TInputImage, TOutputImage >::SetInterpolator ( InterpolatorType _arg)
virtual

Set the interpolator function

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

InterpolateImageFilter can be implemented as a multithreaded filter.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage >
itk::InterpolateImageFilter< TInputImage, TOutputImage >::typedef ( Concept::HasNumericTraits< InputPixelType )

Begin concept checking This class requires InputHasNumericTraitsCheck in the form of ( Concept::HasNumericTraits< InputPixelType > )


Member Data Documentation

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

Number of dimensions.

Definition at line 69 of file itkInterpolateImageFilter.h.

template<class TInputImage , class TOutputImage >
const unsigned int itk::InterpolateImageFilter< TInputImage, TOutputImage >::IntermediateImageDimension = TOutputImage::ImageDimension + 1
static

Number of dimensions.

Definition at line 71 of file itkInterpolateImageFilter.h.

template<class TInputImage , class TOutputImage >
double itk::InterpolateImageFilter< TInputImage, TOutputImage >::m_Distance
private

Definition at line 135 of file itkInterpolateImageFilter.h.

template<class TInputImage , class TOutputImage >
IntermediateImageType::Pointer itk::InterpolateImageFilter< TInputImage, TOutputImage >::m_IntermediateImage
private

Definition at line 133 of file itkInterpolateImageFilter.h.

template<class TInputImage , class TOutputImage >
InterpolatorType::Pointer itk::InterpolateImageFilter< TInputImage, TOutputImage >::m_Interpolator
private

Definition at line 131 of file itkInterpolateImageFilter.h.


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