ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Private Member Functions | Static Private Attributes | List of all members
itk::TransformFactoryBase Class Reference

#include <itkTransformFactoryBase.h>

Detailed Description

Create instances of Transforms.

Definition at line 40 of file itkTransformFactoryBase.h.

+ Inheritance diagram for itk::TransformFactoryBase:
+ Collaboration diagram for itk::TransformFactoryBase:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = TransformFactoryBase
 
using Superclass = ObjectFactoryBase
 
- Public Types inherited from itk::ObjectFactoryBase
using ConstPointer = SmartPointer< const Self >
 
using InsertionPositionEnum = ObjectFactoryEnums::InsertionPosition
 
using Pointer = SmartPointer< Self >
 
using Self = ObjectFactoryBase
 
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

const char * GetDescription () const override
 
const char * GetITKSourceVersion () const override
 
const char * GetNameOfClass () const override
 
void RegisterTransform (const char *classOverride, const char *overrideClassName, const char *description, bool enableFlag, CreateObjectFunctionBase *createFunction)
 
- Public Member Functions inherited from itk::ObjectFactoryBase
virtual void Disable (const char *className)
 
virtual std::list< std::string > GetClassOverrideDescriptions ()
 
virtual std::list< std::string > GetClassOverrideNames ()
 
virtual std::list< std::string > GetClassOverrideWithNames ()
 
virtual bool GetEnableFlag (const char *className, const char *subclassName)
 
virtual std::list< bool > GetEnableFlags ()
 
const char * GetLibraryPath ()
 
virtual void SetEnableFlag (bool flag, const char *className, const char *subclassName)
 
- 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
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static TransformFactoryBaseGetFactory ()
 
static Pointer New ()
 
static void RegisterDefaultTransforms ()
 
- Static Public Member Functions inherited from itk::ObjectFactoryBase
static std::list< LightObject::PointerCreateAllInstance (const char *itkclassname)
 
static LightObject::Pointer CreateInstance (const char *itkclassname)
 
static std::list< ObjectFactoryBase * > GetRegisteredFactories ()
 
static void Initialize ()
 
static void RegisterFactoryInternal (ObjectFactoryBase *)
 
template<typename TFactory >
static void RegisterInternalFactoryOnce ()
 
static void ReHash ()
 
static void UnRegisterAllFactories ()
 
static void UnRegisterFactory (ObjectFactoryBase *)
 
static bool RegisterFactory (ObjectFactoryBase *, InsertionPositionEnum where=InsertionPositionEnum::INSERT_AT_BACK, vcl_size_t position=0)
 
static void SetStrictVersionChecking (bool)
 
static void StrictVersionCheckingOn ()
 
static void StrictVersionCheckingOff ()
 
static bool GetStrictVersionChecking ()
 
- 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 ()
 

Protected Member Functions

 TransformFactoryBase ()
 
 ~TransformFactoryBase () override
 
- Protected Member Functions inherited from itk::ObjectFactoryBase
virtual std::list< LightObject::PointerCreateAllObject (const char *itkclassname)
 
virtual LightObject::Pointer CreateObject (const char *itkclassname)
 
 ObjectFactoryBase ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void RegisterOverride (const char *classOverride, const char *subclass, const char *description, bool enableFlag, CreateObjectFunctionBase *createFunction)
 
 ~ObjectFactoryBase () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
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 PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Static Private Member Functions

template<typename TParameterType >
static void RegisterTransformFactory ()
 
static void RegisterTransformFactoryDoubleParameters ()
 
static void RegisterTransformFactoryFloatParameters ()
 

Static Private Attributes

static TransformFactoryBasem_Factory
 

Additional Inherited Members

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

Member Typedef Documentation

◆ ConstPointer

Definition at line 49 of file itkTransformFactoryBase.h.

◆ Pointer

Definition at line 48 of file itkTransformFactoryBase.h.

◆ Self

Standard class type aliases.

Definition at line 46 of file itkTransformFactoryBase.h.

◆ Superclass

Definition at line 47 of file itkTransformFactoryBase.h.

Constructor & Destructor Documentation

◆ TransformFactoryBase()

itk::TransformFactoryBase::TransformFactoryBase ( )
protected

◆ ~TransformFactoryBase()

itk::TransformFactoryBase::~TransformFactoryBase ( )
overrideprotected

Member Function Documentation

◆ GetDescription()

const char* itk::TransformFactoryBase::GetDescription ( ) const
overridevirtual

Return a descriptive string describing the factory.

Implements itk::ObjectFactoryBase.

◆ GetFactory()

static TransformFactoryBase* itk::TransformFactoryBase::GetFactory ( )
static

Get the factory

Referenced by itk::TransformFactory< T >::RegisterTransform().

◆ GetITKSourceVersion()

const char* itk::TransformFactoryBase::GetITKSourceVersion ( ) const
overridevirtual

Class methods used to interface with the registered factories.

Implements itk::ObjectFactoryBase.

◆ GetNameOfClass()

const char* itk::TransformFactoryBase::GetNameOfClass ( ) const
overridevirtual

◆ New()

static Pointer itk::TransformFactoryBase::New ( )
static

Method for class instantiation.

◆ RegisterDefaultTransforms()

static void itk::TransformFactoryBase::RegisterDefaultTransforms ( )
static

◆ RegisterTransform()

void itk::TransformFactoryBase::RegisterTransform ( const char *  classOverride,
const char *  overrideClassName,
const char *  description,
bool  enableFlag,
CreateObjectFunctionBase createFunction 
)
inline

Register transform given its type.

Type of a transform can be obtained using itk::Transform::GetTransformTypeAsString()

Within ITK, classOverride, overrideClassName and description are all set to the transform type.

Note
If a transform has already been registered, this function is a no-op. To help debugging issue related to registration, it is possible to enable runtime warnings when compiling in Debug mode by setting both the Debug flag of this class and GetGlobalWarningDisplay to true.

Definition at line 87 of file itkTransformFactoryBase.h.

References itk::ObjectFactoryBase::CreateInstance(), itk::ObjectFactoryBase::RegisterOverride(), and test().

◆ RegisterTransformFactory()

template<typename TParameterType >
static void itk::TransformFactoryBase::RegisterTransformFactory ( )
staticprivate

◆ RegisterTransformFactoryDoubleParameters()

static void itk::TransformFactoryBase::RegisterTransformFactoryDoubleParameters ( )
staticprivate

◆ RegisterTransformFactoryFloatParameters()

static void itk::TransformFactoryBase::RegisterTransformFactoryFloatParameters ( )
staticprivate

Member Data Documentation

◆ m_Factory

TransformFactoryBase* itk::TransformFactoryBase::m_Factory
staticprivate

Definition at line 126 of file itkTransformFactoryBase.h.


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