ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage > Class Template Reference

#include <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 InputImageIndexType = typename InputImageType::IndexType
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename Superclass::InputImagePointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageSizeType = typename InputImageType::SizeType
 
using InputImageType = TInputImage
 
using OutputImageIndexType = typename OutputImageType::IndexType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename Superclass::OutputImagePointer
 
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, 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 OutputImagePointer = typename Superclass::OutputImagePointer
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using OutputImageType = typename Superclass::OutputImageType
 
using Pointer = SmartPointer< Self >
 
using Self = InPlaceImageFilter
 
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::InPlaceImageFilter< TInputImage, TOutputImage >
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace () const
 
virtual void InPlaceOn ()
 
virtual void InPlaceOff ()
 
virtual bool CanRunInPlace () const
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *image)
 
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 >
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
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 flag)
 
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 ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () 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
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public 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 flag)
 
- 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, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::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
 
SourceImageRegionType m_SourceRegion
 
InputImageIndexType m_DestinationIndex
 
virtual void SetDestinationIndex (InputImageIndexType _arg)
 
virtual InputImageIndexType GetDestinationIndex () const
 
virtual void SetSourceRegion (SourceImageRegionType _arg)
 
virtual SourceImageRegionType GetSourceRegion () const
 
virtual void SetDestinationImage (const InputImageType *input)
 
virtual const InputImageTypeGetDestinationImage () const
 
virtual void SetSourceImage (const SourceImageType *input)
 
virtual const SourceImageTypeGetSourceImage () const
 
void GenerateInputRequestedRegion () override
 
void VerifyInputInformation () ITKv5_CONST override
 
 PasteImageFilter ()
 
 ~PasteImageFilter () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) 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::InPlaceImageFilter< TInputImage, TOutputImage >
 InPlaceImageFilter ()=default
 
 ~InPlaceImageFilter () override=default
 
void AllocateOutputs () override
 
void ReleaseInputs () override
 
virtual bool GetRunningInPlace () const
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override=default
 
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 &outputRegionForThread, ThreadIdType threadId)
 
virtual void BeforeThreadedGenerateData ()
 
virtual void AfterThreadedGenerateData ()
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () 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
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () 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)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () 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 GenerateOutputInformation ()
 
virtual void PropagateResetPipeline ()
 
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 &time)
 
- 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 ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
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 TSourceImage = TInputImage, typename TOutputImage = TInputImage>
class itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >

Paste an image into another image.

PasteImageFilter allows you to take a section of one image and paste into another image. The SetDestinationIndex() method prescribes where in the first input to start pasting data from the second input. The SetSourceRegion method prescribes the section of the second image to paste into the first. 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.

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

ITK Sphinx Examples:
Examples
Examples/IO/ImageReadExtractFilterInsertWrite.cxx, SphinxExamples/src/Filtering/ImageGrid/PasteImageIntoAnotherOne/Code.cxx, SphinxExamples/src/Filtering/ImageGrid/ProcessA2DSliceOfA3DImage/Code.cxx, and SphinxExamples/src/Filtering/ImageGrid/RunImageFilterOnRegionOfImage/Code.cxx.

Definition at line 49 of file itkPasteImageFilter.h.

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 58 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 89 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 83 of file itkPasteImageFilter.h.

◆ InputImagePointer

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>
using itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::InputImagePointer = typename Superclass::InputImagePointer

Typedefs from Superclass

Definition at line 67 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 75 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 90 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 71 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 87 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 82 of file itkPasteImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>
using itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::OutputImagePointer = typename Superclass::OutputImagePointer

Definition at line 68 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 74 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 88 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 72 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 57 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 55 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 79 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 91 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 84 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 78 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 76 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 92 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 73 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 56 of file itkPasteImageFilter.h.

Constructor & Destructor Documentation

◆ PasteImageFilter()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>
itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::PasteImageFilter ( )
protected

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

◆ ~PasteImageFilter()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>
itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::~PasteImageFilter ( )
overrideprotecteddefault

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

Member Function Documentation

◆ CreateAnother()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>
virtual::itk::LightObject::Pointer itk::PasteImageFilter< TInputImage, TSourceImage, 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 TSourceImage = TInputImage, typename TOutputImage = TInputImage>
void itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType outputRegionForThread)
overrideprotectedvirtual

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

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

◆ GetDestinationImage()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>
virtual const InputImageType* itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::GetDestinationImage ( ) const
virtual

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

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

◆ GetNameOfClass()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>
virtual const char* itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

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

◆ GetSourceImage()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>
virtual const SourceImageType* itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::GetSourceImage ( ) const
virtual

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

◆ GetSourceRegion()

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

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

◆ 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

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

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

◆ SetDestinationImage()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>
virtual void itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SetDestinationImage ( const InputImageType input)
virtual

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

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

◆ SetSourceImage()

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>
virtual void itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SetSourceImage ( const SourceImageType input)
virtual

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

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

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

See also
ProcessObject::VerifyInputInformation

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

Definition at line 142 of file itkPasteImageFilter.h.

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 95 of file itkPasteImageFilter.h.

◆ m_DestinationIndex

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>
InputImageIndexType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::m_DestinationIndex
protected

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

Definition at line 166 of file itkPasteImageFilter.h.

◆ m_SourceRegion

template<typename TInputImage , typename TSourceImage = TInputImage, typename TOutputImage = TInputImage>
SourceImageRegionType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::m_SourceRegion
protected

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

Definition at line 164 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 96 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 97 of file itkPasteImageFilter.h.


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