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

#include <itkCyclicShiftImageFilter.h>

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

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef OutputImageType::IndexType IndexType
typedef
InputImageType::ConstPointer 
InputImageConstPointer
typedef InputImageType::PixelType InputImagePixelType
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef TInputImage InputImageType
typedef OutputImageType::OffsetType OffsetType
typedef
OutputImageType::OffsetValueType 
OffsetValueType
typedef
OutputImageType::ConstPointer 
OutputImageConstPointer
typedef OutputImageType::PixelType OutputImagePixelType
typedef OutputImageType::Pointer OutputImagePointer
typedef OutputImageType::RegionType OutputImageRegionType
typedef TOutputImage OutputImageType
typedef SmartPointer< SelfPointer
typedef CyclicShiftImageFilter Self
typedef OutputImageType::SizeType SizeType
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
virtual void SetShift (OffsetType _arg)
virtual OffsetType GetShift () const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = TInputImage::ImageDimension

Protected Member Functions

 CyclicShiftImageFilter ()
void GenerateInputRequestedRegion ()
void PrintSelf (std::ostream &os, Indent indent) const
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 ~CyclicShiftImageFilter ()

Protected Attributes

OffsetType m_Shift

Private Member Functions

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

Detailed Description

template<class TInputImage, class TOutputImage = TInputImage>
class itk::CyclicShiftImageFilter< TInputImage, TOutputImage >

Perform a cyclic spatial shift of image intensities on the image grid.

This filter supports arbitrary cyclic shifts of pixel values on the image grid. If the Shift is set to [xOff, yOff], the value of the pixel at [0, 0] in the input image will be the value of the pixel in the output image at index [xOff modulo xSize, yOff modulo ySize] where xSize and ySize are the sizes of the image in the x and y dimensions, respectively. If a pixel value is moved across a boundary, the pixel value is wrapped around that boundary. For example, if the image is 40-by-40 and the Shift is [13, 47], then the value of the pixel at [0, 0] in the input image will be the value of the pixel in the output image at index [13, 7].

Negative Shifts are supported. This filter also works with images whose largest possible region starts at a non-zero index.

Definition at line 46 of file itkCyclicShiftImageFilter.h.


Member Typedef Documentation

template<class TInputImage , class TOutputImage = TInputImage>
typedef SmartPointer< const Self > itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::ConstPointer
template<class TInputImage , class TOutputImage = TInputImage>
typedef OutputImageType::IndexType itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::IndexType
template<class TInputImage , class TOutputImage = TInputImage>
typedef InputImageType::ConstPointer itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::InputImageConstPointer
template<class TInputImage , class TOutputImage = TInputImage>
typedef InputImageType::PixelType itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::InputImagePixelType
template<class TInputImage , class TOutputImage = TInputImage>
typedef InputImageType::Pointer itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::InputImagePointer
template<class TInputImage , class TOutputImage = TInputImage>
typedef InputImageType::RegionType itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::InputImageRegionType
template<class TInputImage , class TOutputImage = TInputImage>
typedef TInputImage itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs.

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

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

Definition at line 57 of file itkCyclicShiftImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
typedef OutputImageType::OffsetType itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::OffsetType

Definition at line 69 of file itkCyclicShiftImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
typedef OutputImageType::OffsetValueType itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::OffsetValueType

Definition at line 70 of file itkCyclicShiftImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
typedef OutputImageType::ConstPointer itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::OutputImageConstPointer
template<class TInputImage , class TOutputImage = TInputImage>
typedef OutputImageType::PixelType itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::OutputImagePixelType
template<class TInputImage , class TOutputImage = TInputImage>
typedef OutputImageType::Pointer itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::OutputImagePointer
template<class TInputImage , class TOutputImage = TInputImage>
typedef OutputImageType::RegionType itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Superclass typedefs.

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

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

Definition at line 65 of file itkCyclicShiftImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
typedef TOutputImage itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

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

Definition at line 58 of file itkCyclicShiftImageFilter.h.

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

Standard class typedefs.

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

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

Definition at line 51 of file itkCyclicShiftImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
typedef OutputImageType::SizeType itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::SizeType
template<class TInputImage , class TOutputImage = TInputImage>
typedef ImageToImageFilter< TInputImage, TOutputImage > itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::Superclass

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage = TInputImage>
itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::CyclicShiftImageFilter ( ) [protected]
template<class TInputImage , class TOutputImage = TInputImage>
itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::~CyclicShiftImageFilter ( ) [inline, protected]

Definition at line 89 of file itkCyclicShiftImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::CyclicShiftImageFilter ( const Self ) [private]

Member Function Documentation

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

template<class TInputImage , class TOutputImage = TInputImage>
void itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( ) [protected, virtual]

This filter needs the entire input be available so it needs to provide an implementation of GenerateInputRequestedRegion().

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

template<class TInputImage , class TOutputImage = TInputImage>
virtual const char* itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const [virtual]

Runtime information support.

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

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

template<class TInputImage , class TOutputImage = TInputImage>
virtual OffsetType itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::GetShift ( ) const [virtual]

Set/get the shift. Shifts may be positive or negative.

template<class TInputImage , class TOutputImage = TInputImage>
static Pointer itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::New ( ) [static]

Standard New method.

Reimplemented from itk::Object.

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

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

template<class TInputImage , class TOutputImage = TInputImage>
void itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

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

template<class TInputImage , class TOutputImage = TInputImage>
virtual void itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::SetShift ( OffsetType  _arg) [virtual]

Set/get the shift. Shifts may be positive or negative.

template<class TInputImage , class TOutputImage = TInputImage>
void itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
ThreadIdType  threadId 
) [protected, virtual]

This filter can be threaded.

Reimplemented from itk::ImageSource< TOutputImage >.


Member Data Documentation

template<class TInputImage , class TOutputImage = TInputImage>
const unsigned int itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension [static]

ImageDimension constants

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

Definition at line 74 of file itkCyclicShiftImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>
OffsetType itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::m_Shift [protected]

Protected so that subclasses may set it without calling Modified().

Definition at line 103 of file itkCyclicShiftImageFilter.h.


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