#include <itkCyclicShiftImageFilter.h>

Detailed Description

template<typename TInputImage, typename 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.

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

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

Public Types
using	ConstPointer = SmartPointer<const Self>

using	IndexType = typename OutputImageType::IndexType

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	OffsetType = typename OutputImageType::OffsetType

using	OffsetValueType = typename OutputImageType::OffsetValueType

using	OutputImageConstPointer = typename OutputImageType::ConstPointer

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer<Self>

using	Self = CyclicShiftImageFilter

using	SizeType = typename OutputImageType::SizeType

using	Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Public Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
using	ConstPointer

using	InputImageConstPointer

using	InputImagePixelType

using	InputImagePointer

using	InputImageRegionType

using	InputImageType

typedef typename OutputImageType::PixelType	OutputImagePixelType

using	OutputImagePixelType

typedef typename OutputImageType::RegionType	OutputImageRegionType

using	OutputImageRegionType

using	Pointer

using	Self

using	Superclass

Public Types inherited from itk::ImageSource< TInputImage >
using	ConstPointer

using	DataObjectIdentifierType

using	DataObjectPointer

using	DataObjectPointerArraySizeType

using	OutputImagePixelType

using	OutputImagePointer

using	OutputImageRegionType

using	OutputImageType

using	Pointer

using	Self

using	Superclass

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer<const Self>

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector<DataObjectPointer>

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector<DataObjectIdentifierType>

using	Pointer = SmartPointer<Self>

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = LightObject

Public Member Functions
virtual::itk::LightObject::Pointer	CreateAnother () const

const char *	GetNameOfClass () const override


virtual void	SetShift (OffsetType _arg)

virtual OffsetType	GetShift () const

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
const InputImageType *	GetInput () const

const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

const InputImageType *	GetInput (unsigned int idx) const

const char *	GetNameOfClass () const override

const char *	GetNameOfClass () const override

void	PopBackInput () override

void	PopBackInput () override

void	PopFrontInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TInputImage >
OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *output)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = TInputImage::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TInputImage >
static constexpr unsigned int	OutputImageDimension

Protected Member Functions
	CyclicShiftImageFilter ()

void	DynamicThreadedGenerateData (const OutputImageRegionType &) override

void	GenerateInputRequestedRegion () override

void	PrintSelf (std::ostream &os, Indent indent) const override

	~CyclicShiftImageFilter () override=default

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

void	GenerateInputRequestedRegion () override

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

	ImageToImageFilter ()

void	PrintSelf (std::ostream &os, Indent indent) const override

void	PrintSelf (std::ostream &os, Indent indent) const override

void	VerifyInputInformation () const override

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

	~ImageToImageFilter () override=default

Protected Member Functions inherited from itk::ImageSource< TInputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOff ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

void	PrintSelf (std::ostream &os, Indent indent) const override

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

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 idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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 ()

Protected Attributes
OffsetType	m_Shift {}

Protected Attributes inherited from itk::ImageSource< TInputImage >
bool	m_DynamicMultiThreading

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
using	InputToOutputRegionCopierType

using	OutputToInputRegionCopierType

Static Protected Member Functions inherited from itk::ImageSource< TInputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject>
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 55 of file itkCyclicShiftImageFilter.h.

◆ IndexType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::IndexType = typename OutputImageType::IndexType

Definition at line 68 of file itkCyclicShiftImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 61 of file itkCyclicShiftImageFilter.h.

◆ InputImagePixelType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 63 of file itkCyclicShiftImageFilter.h.

◆ InputImagePointer

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 60 of file itkCyclicShiftImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 62 of file itkCyclicShiftImageFilter.h.

◆ InputImageType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Some convenient type alias.

Definition at line 58 of file itkCyclicShiftImageFilter.h.

◆ OffsetType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::OffsetType = typename OutputImageType::OffsetType

Definition at line 70 of file itkCyclicShiftImageFilter.h.

◆ OffsetValueType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::OffsetValueType = typename OutputImageType::OffsetValueType

Definition at line 71 of file itkCyclicShiftImageFilter.h.

◆ OutputImageConstPointer

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::OutputImageConstPointer = typename OutputImageType::ConstPointer

Definition at line 65 of file itkCyclicShiftImageFilter.h.

◆ OutputImagePixelType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::OutputImagePixelType = typename OutputImageType::PixelType

Definition at line 67 of file itkCyclicShiftImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 64 of file itkCyclicShiftImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 66 of file itkCyclicShiftImageFilter.h.

◆ OutputImageType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 59 of file itkCyclicShiftImageFilter.h.

◆ Pointer

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 54 of file itkCyclicShiftImageFilter.h.

◆ Self

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::Self = CyclicShiftImageFilter

Standard class type aliases.

Definition at line 52 of file itkCyclicShiftImageFilter.h.

◆ SizeType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::SizeType = typename OutputImageType::SizeType

Definition at line 69 of file itkCyclicShiftImageFilter.h.

◆ Superclass

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 53 of file itkCyclicShiftImageFilter.h.

Constructor & Destructor Documentation

◆ CyclicShiftImageFilter()

template<typename TInputImage, typename TOutputImage = TInputImage>

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

protected

◆ ~CyclicShiftImageFilter()

template<typename TInputImage, typename TOutputImage = TInputImage>

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

overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TInputImage, typename TOutputImage = TInputImage>

virtual::itk::LightObject::Pointer itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::CreateAnother ( ) 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::LightObject.

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

◆ DynamicThreadedGenerateData()

template<typename TInputImage, typename TOutputImage = TInputImage>

void itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType & )

overrideprotectedvirtual

This filter is multi-threaded.

Reimplemented from itk::ImageSource< TInputImage >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage, typename TOutputImage = TInputImage>

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

overrideprotectedvirtual

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

Reimplemented from itk::ProcessObject.

◆ GetNameOfClass()

template<typename TInputImage, typename TOutputImage = TInputImage>

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

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

◆ GetShift()

template<typename TInputImage, typename TOutputImage = TInputImage>

virtual OffsetType itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::GetShift ( ) const

virtual

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

◆ New()

template<typename TInputImage, typename TOutputImage = TInputImage>

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

static

Standard New method.

◆ PrintSelf()

template<typename TInputImage, typename TOutputImage = TInputImage>

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

overrideprotectedvirtual

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::LightObject.

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

◆ SetShift()

template<typename TInputImage, typename TOutputImage = TInputImage>

virtual void itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::SetShift ( OffsetType _arg )

virtual

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

Member Data Documentation

◆ ImageDimension

template<typename TInputImage, typename TOutputImage = TInputImage>

unsigned int itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension

staticconstexpr

ImageDimension constants

Definition at line 74 of file itkCyclicShiftImageFilter.h.

◆ m_Shift

template<typename TInputImage, typename TOutputImage = TInputImage>

OffsetType itk::CyclicShiftImageFilter< TInputImage, TOutputImage >::m_Shift {}

protected

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

Definition at line 105 of file itkCyclicShiftImageFilter.h.

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

itkCyclicShiftImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ IndexType

◆ InputImageConstPointer

◆ InputImagePixelType

◆ InputImagePointer

◆ InputImageRegionType

◆ InputImageType

◆ OffsetType

◆ OffsetValueType

◆ OutputImageConstPointer

◆ OutputImagePixelType

◆ OutputImagePointer

◆ OutputImageRegionType

◆ OutputImageType

◆ Pointer

◆ Self

◆ SizeType

◆ Superclass

Constructor & Destructor Documentation

◆ CyclicShiftImageFilter()

◆ ~CyclicShiftImageFilter()

Member Function Documentation

◆ CreateAnother()

◆ DynamicThreadedGenerateData()

◆ GenerateInputRequestedRegion()

◆ GetNameOfClass()

◆ GetShift()

◆ New()

◆ PrintSelf()

◆ SetShift()

Member Data Documentation

◆ ImageDimension

◆ m_Shift