ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private 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 >:

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();
* typedef itk::ImageDuplicator< ImageType > DuplicatorType;
* DuplicatorType::Pointer duplicator = DuplicatorType::New();
* duplicator->SetInputImage(image);
* duplicator->Update();
* ImageType::Pointer clonedImage = duplicator->GetModifiableOutput();
*

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.

Wiki Examples:
Examples:
Examples/Filtering/SecondDerivativeRecursiveGaussianImageFilter.cxx, SphinxExamples/src/Core/Common/DuplicateAnImage/Code.cxx, and WikiExamples/SimpleOperations/ImageDuplicator.cxx.

Definition at line 54 of file itkImageDuplicator.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef TInputImage::ConstPointer ImageConstPointer
 
typedef TInputImage::Pointer ImagePointer
 
typedef TInputImage ImageType
 
typedef TInputImage::IndexType IndexType
 
typedef TInputImage::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef ImageDuplicator Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual ImageTypeGetModifiableOutput ()
 
virtual const char * GetNameOfClass () const
 
virtual const ImageTypeGetOutput () const
 
virtual void SetInputImage (const ImageType *_arg)
 
void Update ()
 
- 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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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 const unsigned int ImageDimension = ImageType::ImageDimension
 

Protected Member Functions

 ImageDuplicator ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~ImageDuplicator ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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 ()
 

Private Attributes

ImageConstPointer m_InputImage
 
ModifiedTimeType m_InternalImageTime
 
ImagePointer m_Output
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

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

Definition at line 61 of file itkImageDuplicator.h.

template<typename TInputImage >
typedef TInputImage::ConstPointer itk::ImageDuplicator< TInputImage >::ImageConstPointer

Definition at line 72 of file itkImageDuplicator.h.

template<typename TInputImage >
typedef TInputImage::Pointer itk::ImageDuplicator< TInputImage >::ImagePointer

Definition at line 71 of file itkImageDuplicator.h.

template<typename TInputImage >
typedef TInputImage itk::ImageDuplicator< TInputImage >::ImageType

Type definitions for the input image.

Definition at line 67 of file itkImageDuplicator.h.

template<typename TInputImage >
typedef TInputImage::IndexType itk::ImageDuplicator< TInputImage >::IndexType

Definition at line 74 of file itkImageDuplicator.h.

template<typename TInputImage >
typedef TInputImage::PixelType itk::ImageDuplicator< TInputImage >::PixelType

Definition at line 73 of file itkImageDuplicator.h.

template<typename TInputImage >
typedef SmartPointer< Self > itk::ImageDuplicator< TInputImage >::Pointer

Definition at line 60 of file itkImageDuplicator.h.

template<typename TInputImage >
typedef ImageDuplicator itk::ImageDuplicator< TInputImage >::Self

Standard class typedefs.

Definition at line 58 of file itkImageDuplicator.h.

template<typename TInputImage >
typedef Object itk::ImageDuplicator< TInputImage >::Superclass

Definition at line 59 of file itkImageDuplicator.h.

Constructor & Destructor Documentation

template<typename TInputImage >
itk::ImageDuplicator< TInputImage >::ImageDuplicator ( )
protected
template<typename TInputImage >
virtual itk::ImageDuplicator< TInputImage >::~ImageDuplicator ( )
inlineprotectedvirtual

Definition at line 88 of file itkImageDuplicator.h.

Member Function Documentation

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

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

Get/Set the input image.

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

Run-time type information (and related methods).

Reimplemented from itk::Object.

template<typename TInputImage >
virtual const ImageType* itk::ImageDuplicator< TInputImage >::GetOutput ( ) const
virtual
template<typename TInputImage >
static Pointer itk::ImageDuplicator< TInputImage >::New ( )
static

Method for creation through the object factory.

template<typename TInputImage >
virtual void itk::ImageDuplicator< TInputImage >::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::Object.

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

Compute of the input image.

Member Data Documentation

template<typename TInputImage >
const unsigned int itk::ImageDuplicator< TInputImage >::ImageDimension = ImageType::ImageDimension
static

Definition at line 76 of file itkImageDuplicator.h.

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

Definition at line 92 of file itkImageDuplicator.h.

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

Definition at line 96 of file itkImageDuplicator.h.

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

Definition at line 95 of file itkImageDuplicator.h.


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