#include <itkPasteImageFilter.h>

Detailed Description

template<typename TInputImage, typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>
class itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >

Paste an image (or a constant value) into another image.

PasteImageFilter allows a region in a destination image to be filled with a source image or a constant pixel value. The SetDestinationIndex() method prescribes where in the destination input to start pasting data from the source input. The SetSourceRegion method prescribes the section of the second image to paste into the first. When a constant pixel value is set, the SourceRegion describes the size of the region filled. If the output requested region does not include the SourceRegion after it has been repositioned to DestinationIndex, then the output will just be a copy of the input.

This filter supports running "InPlace" to efficiently reuse the destination image buffer for the output, removing the need to copy the destination pixels to the output.

When the source image has a lower dimension than the destination image then the DestinationSkipAxes parameter specifies which axes in the destination image are set to 1 when copying the region or filling with a constant.

The two inputs and output image will have the same pixel type.

ITK Sphinx Examples:

<a href=
<a href=
<a href=

Definition at line 57 of file itkPasteImageFilter.h.

Inheritance diagram for itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >:

Collaboration diagram for itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DecoratedSourceImagePixelType = SimpleDataObjectDecorator< SourceImagePixelType >

using	InputImageIndexType = typename InputImageType::IndexType

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageSizeType = typename InputImageType::SizeType

using	InputImageType = TInputImage

using	InputSkipAxesArrayType = FixedArray< bool, InputImageType::ImageDimension >

using	OutputImageIndexType = typename OutputImageType::IndexType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageSizeType = typename OutputImageType::SizeType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = PasteImageFilter

using	SourceImageConstPointer = typename SourceImageType::ConstPointer

using	SourceImageIndexType = typename SourceImageType::IndexType

using	SourceImagePixelType = typename SourceImageType::PixelType

using	SourceImagePointer = typename SourceImageType::Pointer

using	SourceImageRegionType = typename SourceImageType::RegionType

using	SourceImageSizeType = typename SourceImageType::SizeType

using	SourceImageType = TSourceImage

using	Superclass = InPlaceImageFilter< TInputImage, TOutputImage >

Public Types inherited from itk::InPlaceImageFilter< TInputImage, TInputImage >
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	Pointer = SmartPointer< Self >

using	Self = InPlaceImageFilter

using	Superclass = ImageToImageFilter< TInputImage, TInputImage >

Public Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
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	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< TInputImage >

Public Types inherited from itk::ImageSource< TInputImage >
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 = TInputImage

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
bool	CanRunInPlace () const override

void	GenerateInputRequestedRegion () override

const char *	GetNameOfClass () const override

void	VerifyInputInformation () const override

void	VerifyPreconditions () const override


virtual void	SetDestinationIndex (InputImageIndexType _arg)

virtual InputImageIndexType	GetDestinationIndex () const


virtual void	SetDestinationSkipAxes (InputSkipAxesArrayType _arg)

virtual InputSkipAxesArrayType	GetDestinationSkipAxes () const


virtual void	SetSourceRegion (SourceImageRegionType _arg)

virtual SourceImageRegionType	GetSourceRegion () const


	itkSetInputMacro (DestinationImage, InputImageType)

	itkGetInputMacro (DestinationImage, InputImageType)


	itkSetInputMacro (SourceImage, SourceImageType)

	itkGetInputMacro (SourceImage, SourceImageType)


virtual void	SetConstantInput (const SimpleDataObjectDecorator< SourceImagePixelType > *_arg)

virtual const SimpleDataObjectDecorator< SourceImagePixelType > *	GetConstantInput () const

Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TInputImage >
virtual bool	CanRunInPlace () const

const char *	GetNameOfClass () const override

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

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

const InputImageType *	GetInput (unsigned int idx) const

const char *	GetNameOfClass () const override

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< TInputImage >
const char *	GetNameOfClass () const override

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

virtual void	EnlargeOutputRequestedRegion (DataObject *)

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 DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

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

const char *	GetNameOfClass () const override

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 Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()

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

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (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	InputImageDimension = InputImageType::ImageDimension

static constexpr unsigned int	OutputImageDimension = OutputImageType::ImageDimension

static constexpr unsigned int	SourceImageDimension = SourceImageType::ImageDimension

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

static constexpr unsigned int	OutputImageDimension

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

static constexpr unsigned int	OutputImageDimension

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

Protected Member Functions
void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

InputImageSizeType	GetPresumedDestinationSize () const

	PasteImageFilter ()

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

	~PasteImageFilter () override=default

Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TInputImage >
virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()=default

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

void	ReleaseInputs () override

	~InPlaceImageFilter () override=default

void	AllocateOutputs () override

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

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

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

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

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

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

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

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

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

virtual void	GenerateInputRequestedRegion ()

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

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

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

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	SetThreaderUpdateProgress (bool arg)

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

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

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

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	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Protected Attributes
InputImageIndexType	m_DestinationIndex {}

InputSkipAxesArrayType	m_DestinationSkipAxes {}

SourceImageRegionType	m_SourceRegion {}

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 = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

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

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 TSourceImage = TInputImage, typename TOutputImage = TInputImage>

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

Definition at line 66 of file itkPasteImageFilter.h.

◆ DecoratedSourceImagePixelType

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

using itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::DecoratedSourceImagePixelType = SimpleDataObjectDecorator<SourceImagePixelType>

Definition at line 101 of file itkPasteImageFilter.h.

◆ InputImageIndexType

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

using itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::InputImageIndexType = typename InputImageType::IndexType

Definition at line 97 of file itkPasteImageFilter.h.

◆ InputImagePixelType

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

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

Definition at line 91 of file itkPasteImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

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

Definition at line 83 of file itkPasteImageFilter.h.

◆ InputImageSizeType

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

using itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::InputImageSizeType = typename InputImageType::SizeType

Definition at line 98 of file itkPasteImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

using itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::InputImageType = TInputImage

Typedef to describe the output and input image region types.

Definition at line 79 of file itkPasteImageFilter.h.

◆ InputSkipAxesArrayType

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

using itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::InputSkipAxesArrayType = FixedArray<bool, InputImageType::ImageDimension>

Definition at line 103 of file itkPasteImageFilter.h.

◆ OutputImageIndexType

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

using itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::OutputImageIndexType = typename OutputImageType::IndexType

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

Definition at line 95 of file itkPasteImageFilter.h.

◆ OutputImagePixelType

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

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

Typedef to describe the type of pixel.

Definition at line 90 of file itkPasteImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

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

Definition at line 82 of file itkPasteImageFilter.h.

◆ OutputImageSizeType

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

using itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::OutputImageSizeType = typename OutputImageType::SizeType

Definition at line 96 of file itkPasteImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

using itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 80 of file itkPasteImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

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

Definition at line 65 of file itkPasteImageFilter.h.

◆ Self

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

using itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::Self = PasteImageFilter

Standard class type aliases.

Definition at line 63 of file itkPasteImageFilter.h.

◆ SourceImageConstPointer

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

using itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SourceImageConstPointer = typename SourceImageType::ConstPointer

Definition at line 87 of file itkPasteImageFilter.h.

◆ SourceImageIndexType

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

using itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SourceImageIndexType = typename SourceImageType::IndexType

Definition at line 99 of file itkPasteImageFilter.h.

◆ SourceImagePixelType

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

using itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SourceImagePixelType = typename SourceImageType::PixelType

Definition at line 92 of file itkPasteImageFilter.h.

◆ SourceImagePointer

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

using itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SourceImagePointer = typename SourceImageType::Pointer

Definition at line 86 of file itkPasteImageFilter.h.

◆ SourceImageRegionType

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

using itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SourceImageRegionType = typename SourceImageType::RegionType

Definition at line 84 of file itkPasteImageFilter.h.

◆ SourceImageSizeType

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

using itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SourceImageSizeType = typename SourceImageType::SizeType

Definition at line 100 of file itkPasteImageFilter.h.

◆ SourceImageType

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

using itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SourceImageType = TSourceImage

Definition at line 81 of file itkPasteImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

using itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::Superclass = InPlaceImageFilter<TInputImage, TOutputImage>

Definition at line 64 of file itkPasteImageFilter.h.

Constructor & Destructor Documentation

◆ PasteImageFilter()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::PasteImageFilter ( )

protected

◆ ~PasteImageFilter()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::~PasteImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ CanRunInPlace()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

bool itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::CanRunInPlace ( ) const

overridevirtual

Can the filter run in place? To do so, the filter's first input and output must have the same dimension and pixel type. This method can be used in conjunction with the InPlace ivar to determine whether a particular use of the filter is really running in place. Some filters may be able to optimize their operation if the InPlace is true and CanRunInPlace is true. CanRunInPlace may also be overridden by InPlaceImageFilter subclasses to fine tune its behavior.

Reimplemented from itk::InPlaceImageFilter< TInputImage, TInputImage >.

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

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

overrideprotectedvirtual

NPasteImageFilter 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< TInputImage >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

void itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::GenerateInputRequestedRegion ( )

overridevirtual

PasteImageFilter needs to set the input requested regions for its inputs. The first input's requested region will be set to match the output requested region. The second input's requested region will be set to the value of the m_SourceRegion ivar. Note that if the output requested region is a portion of the image that is outside the DestinationIndex + size of the source region, then the first input is copied to the output.

See also: ProcessObject::GenerateInputRequestedRegion()

Reimplemented from itk::ProcessObject.

◆ GetConstantInput()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

virtual const SimpleDataObjectDecorator< SourceImagePixelType > * itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::GetConstantInput ( ) const

virtual

Set/Get a constant value to fill the destination region.

This input is an alternative input to the SourceImage.

◆ GetDestinationIndex()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

virtual InputImageIndexType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::GetDestinationIndex ( ) const

virtual

Set/Get the destination index (where in the first input the second input will be pasted.

◆ GetDestinationSkipAxes()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

virtual InputSkipAxesArrayType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::GetDestinationSkipAxes ( ) const

virtual

Set/Get the array describing which axes in the destination image to skip

The axes with true values are set to 1, to fill the difference between the dimension of the input and source image.
The number of true values in DestinationSkipAxes plus the DestinationImageDimension must equal the
InputImageDimension.

By default this array contains SourceImageDimension false values followed by true values for the remainder.

◆ GetNameOfClass()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

◆ GetPresumedDestinationSize()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

InputImageSizeType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::GetPresumedDestinationSize ( ) const

protected

◆ GetSourceRegion()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

virtual SourceImageRegionType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::GetSourceRegion ( ) const

virtual

Set/Get the source region (what part of the second input will be pasted.

◆ itkGetInputMacro() [1/2]

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::itkGetInputMacro	(	DestinationImage	,
		InputImageType
	)

Set/Get the "destination" image. This is the image that will be obscured by the paste operation.

◆ itkGetInputMacro() [2/2]

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::itkGetInputMacro	(	SourceImage	,
		SourceImageType
	)

Set/Get the "source" image. This is the image that will be pasted over the destination image.

◆ itkSetInputMacro() [1/2]

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::itkSetInputMacro	(	DestinationImage	,
		InputImageType
	)

Set/Get the "destination" image. This is the image that will be obscured by the paste operation.

◆ itkSetInputMacro() [2/2]

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::itkSetInputMacro	(	SourceImage	,
		SourceImageType
	)

Set/Get the "source" image. This is the image that will be pasted over the destination image.

◆ New()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

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

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

void itk::PasteImageFilter< TInputImage, TSourceImage, 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::ProcessObject.

◆ SetConstantInput()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

virtual void itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SetConstantInput ( const SimpleDataObjectDecorator< SourceImagePixelType > * _arg )

virtual

Set/Get a constant value to fill the destination region.

This input is an alternative input to the SourceImage.

◆ SetDestinationIndex()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

virtual void itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SetDestinationIndex ( InputImageIndexType _arg )

virtual

Set/Get the destination index (where in the first input the second input will be pasted.

◆ SetDestinationSkipAxes()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

virtual void itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SetDestinationSkipAxes ( InputSkipAxesArrayType _arg )

virtual

Set/Get the array describing which axes in the destination image to skip

The axes with true values are set to 1, to fill the difference between the dimension of the input and source image.
The number of true values in DestinationSkipAxes plus the DestinationImageDimension must equal the
InputImageDimension.

By default this array contains SourceImageDimension false values followed by true values for the remainder.

◆ SetSourceRegion()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

virtual void itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SetSourceRegion ( SourceImageRegionType _arg )

virtual

Set/Get the source region (what part of the second input will be pasted.

◆ VerifyInputInformation()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

void itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::VerifyInputInformation ( ) const

inlineoverridevirtual

Override VerifyInputInformation() since this filter's inputs do not need to occupy the same physical space.

See also: ProcessObject::VerifyInputInformation

Reimplemented from itk::ProcessObject.

Definition at line 176 of file itkPasteImageFilter.h.

◆ VerifyPreconditions()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

void itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::VerifyPreconditions ( ) const

overridevirtual

Verifies that the process object has been configured correctly, that all required inputs are set, and needed parameters are set appropriately. If not valid an exceptions will be thrown.

This method is called before UpdateOutputInformation() is propagated to the inputs.

The ProcessObject's implementation verifies that the m_NumberOfRequiredInputs are set and not null.

Reimplemented from itk::ProcessObject.

Member Data Documentation

◆ InputImageDimension

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

constexpr unsigned int itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::InputImageDimension = InputImageType::ImageDimension

staticconstexpr

ImageDimension enumeration

Definition at line 107 of file itkPasteImageFilter.h.

◆ m_DestinationIndex

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

InputImageIndexType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::m_DestinationIndex {}

protected

Definition at line 210 of file itkPasteImageFilter.h.

◆ m_DestinationSkipAxes

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

InputSkipAxesArrayType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::m_DestinationSkipAxes {}

protected

Definition at line 211 of file itkPasteImageFilter.h.

◆ m_SourceRegion

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

SourceImageRegionType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::m_SourceRegion {}

protected

Definition at line 208 of file itkPasteImageFilter.h.

◆ OutputImageDimension

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

constexpr unsigned int itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::OutputImageDimension = OutputImageType::ImageDimension

staticconstexpr

Definition at line 108 of file itkPasteImageFilter.h.

◆ SourceImageDimension

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>

constexpr unsigned int itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SourceImageDimension = SourceImageType::ImageDimension

staticconstexpr

Definition at line 109 of file itkPasteImageFilter.h.

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

itkPasteImageFilter.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

◆ DecoratedSourceImagePixelType

◆ InputImageIndexType

◆ InputImagePixelType

◆ InputImageRegionType

◆ InputImageSizeType

◆ InputImageType

◆ InputSkipAxesArrayType

◆ OutputImageIndexType

◆ OutputImagePixelType

◆ OutputImageRegionType

◆ OutputImageSizeType

◆ OutputImageType

◆ Pointer

◆ Self

◆ SourceImageConstPointer

◆ SourceImageIndexType

◆ SourceImagePixelType

◆ SourceImagePointer

◆ SourceImageRegionType

◆ SourceImageSizeType

◆ SourceImageType

◆ Superclass

Constructor & Destructor Documentation

◆ PasteImageFilter()

◆ ~PasteImageFilter()

Member Function Documentation

◆ CanRunInPlace()

◆ DynamicThreadedGenerateData()

◆ GenerateInputRequestedRegion()

◆ GetConstantInput()

◆ GetDestinationIndex()

◆ GetDestinationSkipAxes()

◆ GetNameOfClass()

◆ GetPresumedDestinationSize()

◆ GetSourceRegion()

◆ itkGetInputMacro() [1/2]

◆ itkGetInputMacro() [2/2]

◆ itkSetInputMacro() [1/2]

◆ itkSetInputMacro() [2/2]

◆ New()

◆ PrintSelf()

◆ SetConstantInput()

◆ SetDestinationIndex()

◆ SetDestinationSkipAxes()

◆ SetSourceRegion()

◆ VerifyInputInformation()

◆ VerifyPreconditions()

Member Data Documentation

◆ InputImageDimension

◆ m_DestinationIndex

◆ m_DestinationSkipAxes

◆ m_SourceRegion

◆ OutputImageDimension

◆ SourceImageDimension