#include <itkMirrorPadImageFilter.h>

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	InputImageIndexType = typename Superclass::InputImageIndexType

using	InputImagePixelType = typename Superclass::InputImagePixelType

using	InputImageRegionType = typename Superclass::InputImageRegionType

using	InputImageSizeType = typename Superclass::InputImageSizeType

using	InputImageType = TInputImage

using	OutputImageIndexType = typename Superclass::OutputImageIndexType

using	OutputImagePixelType = typename Superclass::OutputImagePixelType

using	OutputImageRegionType = typename Superclass::OutputImageRegionType

using	OutputImageSizeType = typename Superclass::OutputImageSizeType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = MirrorPadImageFilter

using	Superclass = PadImageFilter< TInputImage, TOutputImage >

Public Types inherited from itk::PadImageFilter< TInputImage, TOutputImage >
using	BoundaryConditionPointerType = BoundaryConditionType *

using	BoundaryConditionType = ImageBoundaryCondition< TInputImage, TOutputImage >

using	ConstPointer = SmartPointer< const Self >

using	InputImageIndexType = typename TInputImage::IndexType

using	InputImagePixelType = typename TInputImage::PixelType

using	InputImageRegionType = typename TInputImage::RegionType

using	InputImageSizeType = typename TInputImage::SizeType

using	OutputImageIndexType = typename TOutputImage::IndexType

using	OutputImagePixelType = typename TOutputImage::PixelType

using	OutputImageRegionType = typename TOutputImage::RegionType

using	OutputImageSizeType = typename TOutputImage::SizeType

using	Pointer = SmartPointer< Self >

using	Self = PadImageFilter

using	SizeType = typename TInputImage::SizeType

using	SizeValueType = typename TInputImage::SizeValueType

using	Superclass = PadImageFilterBase< TInputImage, TOutputImage >

Public Types inherited from itk::PadImageFilterBase< TInputImage, TOutputImage >
using	BoundaryConditionPointerType = BoundaryConditionType *

using	BoundaryConditionType = ImageBoundaryCondition< TInputImage, TOutputImage >

using	ConstPointer = SmartPointer< const Self >

using	InputImageIndexType = typename TInputImage::IndexType

using	InputImagePixelType = typename TInputImage::PixelType

using	InputImageRegionType = typename TInputImage::RegionType

using	InputImageSizeType = typename TInputImage::SizeType

using	OutputImageIndexType = typename TOutputImage::IndexType

using	OutputImagePixelType = typename TOutputImage::PixelType

using	OutputImageRegionType = typename TOutputImage::RegionType

using	OutputImageSizeType = typename TOutputImage::SizeType

using	Pointer = SmartPointer< Self >

using	Self = PadImageFilterBase

using	SizeType = typename TInputImage::SizeType

using	SizeValueType = typename TInputImage::SizeValueType

using	Superclass = ImageToImageFilter< TInputImage, TOutputImage >

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	ConstPointer = SmartPointer< const Self >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	OutputImagePixelType = typename Superclass::OutputImagePixelType

using	OutputImageRegionType = typename Superclass::OutputImageRegionType

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< TOutputImage >

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

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageSource

using	Superclass = ProcessObject

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

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::PadImageFilter< TInputImage, TOutputImage >
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual void	SetPadLowerBound (SizeType _arg)

virtual void	SetPadUpperBound (SizeType _arg)

virtual const SizeType &	GetPadLowerBound () const

virtual const SizeType &	GetPadUpperBound () const

virtual void	SetPadLowerBound (const SizeValueType data[])

virtual void	SetPadUpperBound (const SizeValueType data[])

void	SetPadBound (const InputImageSizeType &bound)

Public Member Functions inherited from itk::PadImageFilterBase< TInputImage, TOutputImage >
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual void	SetBoundaryCondition (BoundaryConditionPointerType _arg)

virtual BoundaryConditionPointerType	GetBoundaryCondition () const

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

const InputImageType *	GetInput (unsigned int idx) const

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetInput (const InputImageType *input)

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

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

OutputImageType *	GetOutput (unsigned int idx)

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

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

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	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

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

MultiThreaderType *	GetMultiThreader () const

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	PrepareOutputs ()

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

unsigned long	AddObserver (const EventObject &event, Command *) const

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

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)

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::PadImageFilter< TInputImage, TOutputImage >
static Pointer	New ()

Static Public Member Functions inherited from itk::PadImageFilterBase< TInputImage, TOutputImage >
static Pointer	New ()

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

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static double	GetGlobalDefaultCoordinateTolerance ()

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::PadImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	ImageDimension = TInputImage::ImageDimension

Static Public Attributes inherited from itk::PadImageFilterBase< TInputImage, TOutputImage >
static constexpr unsigned int	ImageDimension = TInputImage::ImageDimension

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

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

double	m_DecayBase = 1.0

virtual double	GetDecayBase ()

virtual void	SetDecayBase (double _arg)

	MirrorPadImageFilter ()=default

	~MirrorPadImageFilter () override=default

void	ConvertOutputIndexToInputIndex (OutputImageIndexType &outputIndex, InputImageIndexType &inputIndex, OutputImageRegionType &outputRegion, InputImageRegionType &inputRegion, int *oddRegionArray, IndexValueType &distanceFromEdge)

void	ConvertOutputIndexToInputIndex (OutputImageIndexType &outputIndex, InputImageIndexType &inputIndex, OutputImageRegionType &outputRegion, InputImageRegionType &inputRegion, const int *oddRegionArray, double &outDecayFactor)

int	RegionIsOdd (long base, long test, long size)

void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

int	GenerateNextInputRegion (long regIndices, const long regLimit, std::vector< long > indices, std::vector< long > sizes, InputImageRegionType &inputRegion)

int	GenerateNextOutputRegion (long regIndices, const long regLimit, std::vector< long > indices, std::vector< long > sizes, OutputImageRegionType &outputRegion)

int	FindRegionsInArea (long start, long end, long size, long offset)

int	BuildInterRegions (std::vector< long > &inputRegionStart, std::vector< long > &outputRegionStart, std::vector< long > &inputRegionSizes, std::vector< long > &outputRegionSizes, long inputIndex, long outputIndex, long inputSize, long outputSize, int numRegs, int &regCtr)

int	BuildPreRegions (std::vector< long > &inputRegionStart, std::vector< long > &outputRegionStart, std::vector< long > &inputRegionSizes, std::vector< long > &outputRegionSizes, long inputIndex, long outputIndex, long inputSize, long outputSize, int numRegs, int &regCtr)

int	BuildPostRegions (std::vector< long > &inputRegionStart, std::vector< long > &outputRegionStart, std::vector< long > &inputRegionSizes, std::vector< long > &outputRegionSizes, long inputIndex, long outputIndex, long inputSize, long outputSize, int numRegs, int &regCtr)

void	GenerateInputRequestedRegion () override

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Protected Member Functions inherited from itk::PadImageFilter< TInputImage, TOutputImage >
	PadImageFilter ()

	~PadImageFilter () override=default

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

void	GenerateOutputInformation () override

Protected Member Functions inherited from itk::PadImageFilterBase< TInputImage, TOutputImage >
	PadImageFilterBase ()

	~PadImageFilterBase () override=default

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

void	GenerateInputRequestedRegion () override

void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

void	InternalSetBoundaryCondition (const BoundaryConditionPointerType boundaryCondition)

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
	ImageToImageFilter ()

	~ImageToImageFilter () override=default

void	VerifyInputInformation () ITKv5_CONST override

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

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

void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
	ImageSource ()

	~ImageSource () override=default

void	GenerateData () override

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

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

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

virtual void	AfterThreadedGenerateData ()

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

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

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOff ()

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

	~ProcessObject () override

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	AddInput (DataObject *input)

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

virtual void	SetPrimaryInput (DataObject *object)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

void	SetRequiredInputNames (const NameArray &)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

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

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

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual void	SetPrimaryOutput (DataObject *object)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

virtual void	AddOutput (DataObject *output)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

virtual void	VerifyPreconditions () ITKv5_CONST

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual void	PropagateResetPipeline ()

virtual void	ReleaseInputs ()

virtual void	CacheInputReleaseDataFlags ()

virtual void	RestoreInputReleaseDataFlags ()

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

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

	~Object () override

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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

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

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

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

Protected Attributes inherited from itk::ProcessObject
bool	m_Updating

TimeStamp	m_OutputInformationMTime

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

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::MirrorPadImageFilter< TInputImage, TOutputImage >

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

MirrorPadImageFilter changes the image bounds of an image. Any added pixels are filled in with a mirrored 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 left 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 DynamicThreadedGenerateData() method for its implementation.

Exponential decay in the bounds is enabled when DecayBase has to be in the range (0.0, 1.0]. When it is 1.0 it is disabled. The decay rate is based on the Manhattan distance.

See also: WrapPadImageFilter, ConstantPadImageFilter

ITK Sphinx Examples:

All ITK Sphinx Examples

Pad An Image By Mirroring

Examples: SphinxExamples/src/Filtering/ImageGrid/PadAnImageByMirroring/Code.cxx.

Definition at line 59 of file itkMirrorPadImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >

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

Definition at line 68 of file itkMirrorPadImageFilter.h.

◆ InputImageIndexType

template<typename TInputImage , typename TOutputImage >

using itk::MirrorPadImageFilter< TInputImage, TOutputImage >::InputImageIndexType = typename Superclass::InputImageIndexType

Definition at line 89 of file itkMirrorPadImageFilter.h.

◆ InputImagePixelType

template<typename TInputImage , typename TOutputImage >

using itk::MirrorPadImageFilter< TInputImage, TOutputImage >::InputImagePixelType = typename Superclass::InputImagePixelType

Definition at line 85 of file itkMirrorPadImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage , typename TOutputImage >

using itk::MirrorPadImageFilter< TInputImage, TOutputImage >::InputImageRegionType = typename Superclass::InputImageRegionType

Definition at line 81 of file itkMirrorPadImageFilter.h.

◆ InputImageSizeType

template<typename TInputImage , typename TOutputImage >

using itk::MirrorPadImageFilter< TInputImage, TOutputImage >::InputImageSizeType = typename Superclass::InputImageSizeType

Definition at line 91 of file itkMirrorPadImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage >

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

Definition at line 76 of file itkMirrorPadImageFilter.h.

◆ OutputImageIndexType

template<typename TInputImage , typename TOutputImage >

using itk::MirrorPadImageFilter< TInputImage, TOutputImage >::OutputImageIndexType = typename Superclass::OutputImageIndexType

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

Definition at line 88 of file itkMirrorPadImageFilter.h.

◆ OutputImagePixelType

template<typename TInputImage , typename TOutputImage >

using itk::MirrorPadImageFilter< TInputImage, TOutputImage >::OutputImagePixelType = typename Superclass::OutputImagePixelType

Typedef to describe the type of pixel.

Definition at line 84 of file itkMirrorPadImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TOutputImage >

using itk::MirrorPadImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename Superclass::OutputImageRegionType

Typedef to describe the output image region type.

Definition at line 80 of file itkMirrorPadImageFilter.h.

◆ OutputImageSizeType

template<typename TInputImage , typename TOutputImage >

using itk::MirrorPadImageFilter< TInputImage, TOutputImage >::OutputImageSizeType = typename Superclass::OutputImageSizeType

Definition at line 90 of file itkMirrorPadImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage >

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

Definition at line 77 of file itkMirrorPadImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >

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

Definition at line 67 of file itkMirrorPadImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >

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

Standard class type aliases.

Definition at line 65 of file itkMirrorPadImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >

using itk::MirrorPadImageFilter< TInputImage, TOutputImage >::Superclass = PadImageFilter<TInputImage, TOutputImage>

Definition at line 66 of file itkMirrorPadImageFilter.h.

Constructor & Destructor Documentation

◆ MirrorPadImageFilter()

template<typename TInputImage , typename TOutputImage >

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

protecteddefault

Get/Set the base for exponential decay in mirrored region.

◆ ~MirrorPadImageFilter()

template<typename TInputImage , typename TOutputImage >

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

overrideprotecteddefault

Get/Set the base for exponential decay in mirrored region.

Member Function Documentation

◆ BuildInterRegions()

template<typename TInputImage , typename TOutputImage >

int itk::MirrorPadImageFilter< TInputImage, TOutputImage >::BuildInterRegions	(	std::vector< long > &	inputRegionStart,
		std::vector< long > &	outputRegionStart,
		std::vector< long > &	inputRegionSizes,
		std::vector< long > &	outputRegionSizes,
		long	inputIndex,
		long	outputIndex,
		long	inputSize,
		long	outputSize,
		int	numRegs,
		int &	regCtr
	)

protected

Generate region 0 (inter-region) information. Based on the indices of the input and the output for this dimension, decide what are the starting points and the lengths of the output region directly corresponding to the input region. Padding will be on either side of this region. The algorithmic complications are necessary to support the streaming interface and multithreading.

◆ BuildPostRegions()

template<typename TInputImage , typename TOutputImage >

int itk::MirrorPadImageFilter< TInputImage, TOutputImage >::BuildPostRegions	(	std::vector< long > &	inputRegionStart,
		std::vector< long > &	outputRegionStart,
		std::vector< long > &	inputRegionSizes,
		std::vector< long > &	outputRegionSizes,
		long	inputIndex,
		long	outputIndex,
		long	inputSize,
		long	outputSize,
		int	numRegs,
		int &	regCtr
	)

protected

Generate region 2 (post-region) information. Based on the indices of the input and the output for this dimension, decide what are the starting points and the lengths of the output region directly succeeding the input region in this dimension. This may require more than one region be defined if the padding is larger than the size of the input image in this dimension. Other algorithmic complications are necessary to support the streaming interface and multithreading.

◆ BuildPreRegions()

template<typename TInputImage , typename TOutputImage >

int itk::MirrorPadImageFilter< TInputImage, TOutputImage >::BuildPreRegions	(	std::vector< long > &	inputRegionStart,
		std::vector< long > &	outputRegionStart,
		std::vector< long > &	inputRegionSizes,
		std::vector< long > &	outputRegionSizes,
		long	inputIndex,
		long	outputIndex,
		long	inputSize,
		long	outputSize,
		int	numRegs,
		int &	regCtr
	)

protected

Generate region 1 (pre-region) information. Based on the indices of the input and the output for this dimension, decide what are the starting points and the lengths of the output region directly preceding the input region in this dimension. This may require more than one region be defined if the padding is larger than the size of the input image in this dimension. Other algorithmic complications are necessary to support the streaming interface and multithreading.

◆ ConvertOutputIndexToInputIndex() [1/2]

template<typename TInputImage , typename TOutputImage >

void itk::MirrorPadImageFilter< TInputImage, TOutputImage >::ConvertOutputIndexToInputIndex	(	OutputImageIndexType &	outputIndex,
		InputImageIndexType &	inputIndex,
		OutputImageRegionType &	outputRegion,
		InputImageRegionType &	inputRegion,
		const int *	oddRegionArray,
		double &	outDecayFactor
	)

protected

Get/Set the base for exponential decay in mirrored region.

◆ ConvertOutputIndexToInputIndex() [2/2]

template<typename TInputImage , typename TOutputImage >

void itk::MirrorPadImageFilter< TInputImage, TOutputImage >::ConvertOutputIndexToInputIndex	(	OutputImageIndexType &	outputIndex,
		InputImageIndexType &	inputIndex,
		OutputImageRegionType &	outputRegion,
		InputImageRegionType &	inputRegion,
		int *	oddRegionArray,
		IndexValueType &	distanceFromEdge
	)

protected

Convert from the output index to the input index taking into consideration mirrored and normal regions.

◆ CreateAnother()

template<typename TInputImage , typename TOutputImage >

virtual::itk::LightObject::Pointer itk::MirrorPadImageFilter< 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::Object.

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >

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

overrideprotectedvirtual

MirrorPadImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a DynamicThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling DynamicThreadedGenerateData(). DynamicThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also: ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ FindRegionsInArea()

template<typename TInputImage , typename TOutputImage >

int itk::MirrorPadImageFilter< TInputImage, TOutputImage >::FindRegionsInArea	(	long	start,
		long	end,
		long	size,
		long	offset
	)

protected

Given the start and end indices of a region, determine how many instances of size fit within the region. The variable offset provides a way to adjust width of the area while forcing alignment to the start or end location.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage >

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

overrideprotectedvirtual

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

See also: ProcessObject::GenerateInputRequestedRegion(); PadImageFilter::GenerateInputRequestedRegion()

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

◆ GenerateNextInputRegion()

template<typename TInputImage , typename TOutputImage >

int itk::MirrorPadImageFilter< TInputImage, TOutputImage >::GenerateNextInputRegion	(	long *	regIndices,
		const long *	regLimit,
		std::vector< long > *	indices,
		std::vector< long > *	sizes,
		InputImageRegionType &	inputRegion
	)

protected

Given an n dimensional list of input region breakpoints in indices and size (where the current region and maximum region for each dimension is encoded in regIndices and regLimit), choose the next input region.

◆ GenerateNextOutputRegion()

template<typename TInputImage , typename TOutputImage >

int itk::MirrorPadImageFilter< TInputImage, TOutputImage >::GenerateNextOutputRegion	(	long *	regIndices,
		const long *	regLimit,
		std::vector< long > *	indices,
		std::vector< long > *	sizes,
		OutputImageRegionType &	outputRegion
	)

protected

Given an n dimensional list of output region breakpoints in indices and size (where the current region and maximum region for each dimension is encoded in regIndices and regLimit), choose the next output region.

◆ GetDecayBase()

template<typename TInputImage , typename TOutputImage >

virtual double itk::MirrorPadImageFilter< TInputImage, TOutputImage >::GetDecayBase ( )

virtual

Get/Set the base for exponential decay in mirrored region.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >

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

virtual

Run-time type information (and related methods).

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

◆ New()

template<typename TInputImage , typename TOutputImage >

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

static

Method for creation through the object factory.

◆ RegionIsOdd()

template<typename TInputImage , typename TOutputImage >

int itk::MirrorPadImageFilter< TInputImage, TOutputImage >::RegionIsOdd	(	long	base,
		long	test,
		long	size
	)

protected

Decide whether test falls within an odd or even number of size regions from base.

◆ SetDecayBase()

template<typename TInputImage , typename TOutputImage >

virtual void itk::MirrorPadImageFilter< TInputImage, TOutputImage >::SetDecayBase ( double _arg )

virtual

Get/Set the base for exponential decay in mirrored region.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage >

constexpr unsigned int itk::MirrorPadImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension

staticconstexpr

ImageDimension enumeration.

Definition at line 94 of file itkMirrorPadImageFilter.h.

◆ m_DecayBase

template<typename TInputImage , typename TOutputImage >

double itk::MirrorPadImageFilter< TInputImage, TOutputImage >::m_DecayBase = 1.0

private

Get/Set the base for exponential decay in mirrored region.

Definition at line 245 of file itkMirrorPadImageFilter.h.

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

itkMirrorPadImageFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

template<typename TInputImage, typename TOutputImage> class itk::MirrorPadImageFilter< TInputImage, TOutputImage >

Member Typedef Documentation

◆ ConstPointer

◆ InputImageIndexType

◆ InputImagePixelType

◆ InputImageRegionType

◆ InputImageSizeType

◆ InputImageType

◆ OutputImageIndexType

◆ OutputImagePixelType

◆ OutputImageRegionType

◆ OutputImageSizeType

◆ OutputImageType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ MirrorPadImageFilter()

◆ ~MirrorPadImageFilter()

Member Function Documentation

◆ BuildInterRegions()

◆ BuildPostRegions()

◆ BuildPreRegions()

◆ ConvertOutputIndexToInputIndex() [1/2]

◆ ConvertOutputIndexToInputIndex() [2/2]

◆ CreateAnother()

◆ DynamicThreadedGenerateData()

◆ FindRegionsInArea()

◆ GenerateInputRequestedRegion()

◆ GenerateNextInputRegion()

◆ GenerateNextOutputRegion()

◆ GetDecayBase()

◆ GetNameOfClass()

◆ New()

◆ RegionIsOdd()

◆ SetDecayBase()

Member Data Documentation

◆ ImageDimension

◆ m_DecayBase

template<typename TInputImage, typename TOutputImage>
class itk::MirrorPadImageFilter< TInputImage, TOutputImage >