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

#include <itkImageDuplicator.h>

+ Inheritance diagram for itk::ImageDuplicator< TInputImage >:
+ Collaboration diagram for itk::ImageDuplicator< TInputImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ImageConstPointer = typename TInputImage::ConstPointer
 
using ImagePointer = typename TInputImage::Pointer
 
using ImageType = TInputImage
 
using IndexType = typename TInputImage::IndexType
 
using PixelType = typename TInputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using Self = ImageDuplicator
 
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
 
virtual void SetInputImage (const ImageType *_arg)
 
- 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
 
LightObject::Pointer CreateAnother () const override
 
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::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 ImageDimension = ImageType::ImageDimension
 
ImageConstPointer m_InputImage
 
ImagePointer m_DuplicateImage
 
ModifiedTimeType m_InternalImageTime
 
virtual const ImageTypeGetOutput () const
 
virtual ImageTypeGetOutput ()
 
void Update ()
 
 ImageDuplicator ()
 
 ~ImageDuplicator () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
void PrintSelf (std::ostream &os, Indent indent) const 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 ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TInputImage>
class itk::ImageDuplicator< TInputImage >

A helper class which creates an image which is perfect copy of the input image.

This class is NOT a filter. Although it has an API similar to a filter, this class is not intended to be used in a pipeline. Instead, the typical use will be like it is illustrated in the following code:

medianFilter->Update();
ImageType::Pointer image = medianFilter->GetOutput();
using DuplicatorType = itk::ImageDuplicator< ImageType >;
DuplicatorType::Pointer duplicator = DuplicatorType::New();
duplicator->SetInputImage(image);
duplicator->Update();
ImageType::Pointer clonedImage = duplicator->GetOutput();

Note that the Update() method must be called explicitly in the filter that provides the input to the ImageDuplicator object. This is needed because the ImageDuplicator is not a pipeline filter.

ITK Sphinx Examples:
Examples
Examples/Filtering/SecondDerivativeRecursiveGaussianImageFilter.cxx, SphinxExamples/src/Core/Common/DuplicateAnImage/Code.cxx, and SphinxExamples/src/Core/Common/FilterAndParallelizeImageRegion/Code.cxx.

Definition at line 54 of file itkImageDuplicator.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage >
using itk::ImageDuplicator< TInputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 63 of file itkImageDuplicator.h.

◆ ImageConstPointer

template<typename TInputImage >
using itk::ImageDuplicator< TInputImage >::ImageConstPointer = typename TInputImage::ConstPointer

Definition at line 74 of file itkImageDuplicator.h.

◆ ImagePointer

template<typename TInputImage >
using itk::ImageDuplicator< TInputImage >::ImagePointer = typename TInputImage::Pointer

Definition at line 73 of file itkImageDuplicator.h.

◆ ImageType

template<typename TInputImage >
using itk::ImageDuplicator< TInputImage >::ImageType = TInputImage

Type definitions for the input image.

Definition at line 72 of file itkImageDuplicator.h.

◆ IndexType

template<typename TInputImage >
using itk::ImageDuplicator< TInputImage >::IndexType = typename TInputImage::IndexType

Definition at line 76 of file itkImageDuplicator.h.

◆ PixelType

template<typename TInputImage >
using itk::ImageDuplicator< TInputImage >::PixelType = typename TInputImage::PixelType

Definition at line 75 of file itkImageDuplicator.h.

◆ Pointer

template<typename TInputImage >
using itk::ImageDuplicator< TInputImage >::Pointer = SmartPointer<Self>

Definition at line 62 of file itkImageDuplicator.h.

◆ Self

template<typename TInputImage >
using itk::ImageDuplicator< TInputImage >::Self = ImageDuplicator

Standard class type aliases.

Definition at line 60 of file itkImageDuplicator.h.

◆ Superclass

template<typename TInputImage >
using itk::ImageDuplicator< TInputImage >::Superclass = Object

Definition at line 61 of file itkImageDuplicator.h.

Constructor & Destructor Documentation

◆ ImageDuplicator()

template<typename TInputImage >
itk::ImageDuplicator< TInputImage >::ImageDuplicator ( )
protected

Provide an interface to match that of other ProcessObjects for this source generation object by returning a non-const pointer for the generated Object.

◆ ~ImageDuplicator()

template<typename TInputImage >
itk::ImageDuplicator< TInputImage >::~ImageDuplicator ( )
overrideprotecteddefault

Provide an interface to match that of other ProcessObjects for this source generation object by returning a non-const pointer for the generated Object.

Member Function Documentation

◆ CreateAnother()

template<typename TInputImage >
virtual::itk::LightObject::Pointer itk::ImageDuplicator< TInputImage >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

◆ GetNameOfClass()

template<typename TInputImage >
virtual const char* itk::ImageDuplicator< TInputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

◆ GetOutput() [1/2]

template<typename TInputImage >
virtual ImageType* itk::ImageDuplicator< TInputImage >::GetOutput ( )
inlinevirtual

Provide an interface to match that of other ProcessObjects for this source generation object by returning a non-const pointer for the generated Object.

Definition at line 99 of file itkImageDuplicator.h.

◆ GetOutput() [2/2]

template<typename TInputImage >
virtual const ImageType* itk::ImageDuplicator< TInputImage >::GetOutput ( ) const
inlinevirtual

Provide an interface to match that of other ProcessObjects for this source generation object by returning a non-const pointer for the generated Object.

Definition at line 94 of file itkImageDuplicator.h.

◆ New()

template<typename TInputImage >
static Pointer itk::ImageDuplicator< TInputImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage >
void itk::ImageDuplicator< TInputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Provide an interface to match that of other ProcessObjects for this source generation object by returning a non-const pointer for the generated Object.

Reimplemented from itk::LightObject.

◆ SetInputImage()

template<typename TInputImage >
virtual void itk::ImageDuplicator< TInputImage >::SetInputImage ( const ImageType _arg)
virtual

◆ Update()

template<typename TInputImage >
void itk::ImageDuplicator< TInputImage >::Update ( )

Compute of the input image.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage >
constexpr unsigned int itk::ImageDuplicator< TInputImage >::ImageDimension = ImageType::ImageDimension
staticconstexpr

Definition at line 78 of file itkImageDuplicator.h.

◆ m_DuplicateImage

template<typename TInputImage >
ImagePointer itk::ImageDuplicator< TInputImage >::m_DuplicateImage
private

Provide an interface to match that of other ProcessObjects for this source generation object by returning a non-const pointer for the generated Object.

Definition at line 126 of file itkImageDuplicator.h.

◆ m_InputImage

template<typename TInputImage >
ImageConstPointer itk::ImageDuplicator< TInputImage >::m_InputImage
private

Provide an interface to match that of other ProcessObjects for this source generation object by returning a non-const pointer for the generated Object.

Definition at line 125 of file itkImageDuplicator.h.

◆ m_InternalImageTime

template<typename TInputImage >
ModifiedTimeType itk::ImageDuplicator< TInputImage >::m_InternalImageTime
private

Provide an interface to match that of other ProcessObjects for this source generation object by returning a non-const pointer for the generated Object.

Definition at line 127 of file itkImageDuplicator.h.


The documentation for this class was generated from the following file:
itk::ImageDuplicator
A helper class which creates an image which is perfect copy of the input image.
Definition: itkImageDuplicator.h:54