IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
ipsdk::imaproc::attr::RegistrationMotionTransform3d Class Reference

Transformation associated to a 3d motion. More...

#include <RegistrationMotionTransform3d.h>

Inheritance diagram for ipsdk::imaproc::attr::RegistrationMotionTransform3d:
ipsdk::BaseDataItemNode ipsdk::BaseDataItem ipsdk::BaseToolTip ipsdk::BaseSerializationObject ipsdk::BaseDynamicObject

Public Types

typedef ipsdk::math::transform::GeometricTransform3dPtr GeometricTransformPtr
 shared pointer to transformation type associated to object
 

Public Member Functions

const std::string & getObjectName () const
 method allowing to retrieve object name
 
const std::string & getToolTip () const
 method allowing to retrieve object tooltip
 
const boost::filesystem::path getHeaderPath () const
 retrieve relative header path associated to data item node
 
const std::string getLibraryName () const
 retrieve library name associated data item node
 
const ipsdk::ItemNamesgetItemIds () const
 retrieve item associated to a given id More...
 
 ~RegistrationMotionTransform3d ()
 public destructor
 
 operator GeometricTransformPtr () const
 convertion to geometric transform object More...
 
void setIdentity ()
 method allowing to initialize transformation parameters to identity
 
Methods associated to sub node MotionModel
template<>
const ipsdk::DataItemLeaf< ipsdk::imaproc::attr::eRegistrationMotionModel3d > & getNode () const
 access to sub node MotionModel
 
template<>
ipsdk::DataItemLeaf< ipsdk::imaproc::attr::eRegistrationMotionModel3d > & get ()
 access to sub node MotionModel
 
template<>
const ipsdk::imaproc::attr::eRegistrationMotionModel3dgetValue () const
 access to value for sub node MotionModel
 
template<>
void setValue (const ipsdk::imaproc::attr::eRegistrationMotionModel3d &value)
 access to value for sub node MotionModel
 
Methods associated to sub node Params
template<>
const ipsdk::DataItemLeafColl< ipsdk::ipReal64 > & getNode () const
 access to sub node Params
 
template<>
ipsdk::DataItemLeafColl< ipsdk::ipReal64 > & get ()
 access to sub node Params
 
template<>
const std::vector< ipsdk::ipReal64 > & getLeafColl () const
 access to value collection for sub node Params
 
template<>
std::vector< ipsdk::ipReal64 > & getLeafColl ()
 access to value collection for sub node Params
 
template<>
bool isEmpty () const
 check wether collection is empty for sub node Params
 
template<>
ipsdk::ipUInt32 getSize () const
 retrieve collection size for sub node Params
 
template<>
void push_back (const ipsdk::ipReal64 &value)
 push back a new element into collection for sub node Params
 
template<>
void clear ()
 remove all items from collection for sub node Params
 
- Public Member Functions inherited from ipsdk::BaseDataItemNode
eDataItemType getDataItemType () const
 
bool existsItem (const std::string &itemId) const
 
const BaseDataItemgetItem (const std::string &itemId) const
 
const std::string & getItemName (const std::string &itemId) const
 
const std::string & getItemToolTip (const std::string &itemId) const
 
- Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string & getClassName () const
 
virtual BaseDynamicObjectcreateNew () const=0
 
virtual DynamicObjectPtr createShared () const=0
 
virtual bool hasCopySupport () const=0
 
virtual BaseDynamicObjectduplicate () const=0
 
virtual DynamicObjectPtr duplicateShared () const=0
 

Static Public Member Functions

static const std::string & getObjectNameStr ()
 method allowing to retrieve object name
 
static const std::string & getToolTipStr ()
 method allowing to retrieve object tooltip
 
static const boost::filesystem::path getHeaderPathStr ()
 retrieve relative header path associated to data item node
 
static const std::string getLibraryNameStr ()
 retrieve library name associated data item node
 
static boost::shared_ptr< RegistrationMotionTransform3dcreateNode ()
 node creation function
 
- Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32 getVersion ()
 
- Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string & getTypeName ()
 

Static Public Attributes

static const ipsdk::ipUInt32 g_nbChildNodes
 number of child nodes associated to object
 
- Static Public Attributes inherited from ipsdk::BaseDataItemNode
static const bool g_bIsColl
 
static const bool g_bNode
 
static const bool g_bLeaf
 
static const eDataItemType::domain g_itemType
 

Protected Member Functions

 RegistrationMotionTransform3d ()
 protected constructor
 
- Protected Member Functions inherited from ipsdk::BaseDataItemNode
virtual ItemInfoPtr getItemInfo (const std::string &itemId) const=0
 
- Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult write (BaseOArchive &ar) const
 
virtual BoolResult read (BaseIArchive &ar)
 
- Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void initCtorCopy (const BaseDynamicObject &object)
 
virtual void copy (const BaseDynamicObject &object)
 

Additional Inherited Members

- Protected Types inherited from ipsdk::BaseDataItemNode
typedef boost::shared_ptr< ItemInfoItemInfoPtr
 

Detailed Description

Transformation associated to a 3d motion.

Author
E.Noirfalise
Date
2016/10/27

Node associated library :

IPSDKIPLAttributes

SubNodes description

Name ToolTip Associated Class Default Value
MotionModel motion model type associated to transformation ipsdk::DataItemEnumLeaf<ipsdk::imaproc::attr::eRegistrationMotionModel3d> ipsdk::imaproc::attr::eRegistrationMotionModel3d::eRMM3d_Rigid
Params transformation parameters ipsdk::DataItemLeafColl<ipsdk::ipReal64>

Member Function Documentation

◆ getItemIds()

const ipsdk::ItemNames& ipsdk::imaproc::attr::RegistrationMotionTransform3d::getItemIds ( ) const
virtual

retrieve item associated to a given id

Exceptions
ipsdk::IPSDKBaseDataExceptionif existsItem(itemName) == false

Implements ipsdk::BaseDataItemNode.

◆ operator GeometricTransformPtr()

ipsdk::imaproc::attr::RegistrationMotionTransform3d::operator GeometricTransformPtr ( ) const

convertion to geometric transform object

Exceptions
ipsdk::imaproc::attr::IPSDKIPLAttributesExceptionif isParamsSizeValid() == false

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