ICF 3.0.5.47
Technical documentation of ICF Libraries
icalib::CAffineCalibration2d Class Reference

Definition of an affine transformation for 2D-spaces. More...

#include <CAffineCalibration2d.h>

Inheritance diagram for icalib::CAffineCalibration2d:
Collaboration diagram for icalib::CAffineCalibration2d:

Public Types

typedef i2d::CAffineTransformation2d BaseClass
 
- Public Types inherited from i2d::ITransformation2d
enum  ExactnessMode { EM_NONE , EM_EXACT , EM_VISUAL , EM_ANY }
 
enum  TransformationFlags {
  TF_FORWARD = 1 << 0 , TF_INVERTED = 1 << 1 , TF_INJECTIVE = 1 << 2 , TF_SURJECTIVE = 1 << 3 ,
  TF_PRESERVE_NULL = 1 << 4 , TF_PRESERVE_DISTANCE = 1 << 5 , TF_PRESERVE_ANGLE = 1 << 6 , TF_AFFINE = 1 << 7 ,
  TF_CONTINUES = 1 << 8
}
 Flags indication type of this transformation and supported operations. More...
 
- Public Types inherited from imath::TIMathFunction< CVector2d, CVector2d >
typedef CVector2d ArgumentType
 
typedef CVector2d ResultType
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ICF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING ,
  CF_DELEGATED , CF_NO_UNDO
}
 Data model change notification flags. More...
 
enum  SupportedOperations {
  SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 ,
  SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 , SO_CHANGE_LOCK = 1 << 5
}
 Flags for supported operations. More...
 
enum  CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
 Control how relationship betweeen objects are interpreted. More...
 
- Public Types inherited from i2d::ICalibration2d
enum  ChangeFlags { CF_CALIBRATION_CHANGED = 0x8d89e2 , CF_AREA_CHANGED , CF_UNITS_CHANGED }
 
enum  TransformationFlags { TF_SUPPORT_COMBINE = 1 << 10 }
 Extension of i2d::ITransformation2d::TransformationFlags. More...
 

Public Member Functions

 CAffineCalibration2d ()
 
 CAffineCalibration2d (const i2d::CAffine2d &transformation)
 
void SetArgumentArea (const i2d::CRectangle *areaPtr)
 
void SetResultArea (const i2d::CRectangle *areaPtr)
 
void SetArgumentUnitInfo (const imath::IUnitInfo *unitInfoPtr)
 
void SetResultUnitInfo (const imath::IUnitInfo *unitInfoPtr)
 
const i2d::CRectangleGetArgumentArea () const override
 Get optional area where arguments are defined properly.
 
const i2d::CRectangleGetResultArea () const override
 Get optional area where results are defined properly.
 
const imath::IUnitInfoGetArgumentUnitInfo () const override
 Get unit description of calibration input (transformation function argument).
 
const imath::IUnitInfoGetResultUnitInfo () const override
 Get unit description of calibration output (transformation function result).
 
std::unique_ptr< i2d::ICalibration2dCreateCombinedCalibration (const i2d::ITransformation2d &transformation) const override
 Create new calibration being combination of this calibration and the second one.
 
int GetSupportedOperations () const override
 Get set of flags for supported operations.
 
bool CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
 Copy this object from another one.
 
std::unique_ptr< istd::IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const override
 Make a copy of this object.
 
bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS) override
 Reset data to its default state.
 
- Public Member Functions inherited from i2d::CAffineTransformation2d
 CAffineTransformation2d ()
 
 CAffineTransformation2d (const i2d::CAffine2d &transformation)
 
const i2d::CAffine2dGetTransformation () const
 Get used transformation object.
 
i2d::CAffine2dGetTransformationRef ()
 Get reference to internal transformation object.
 
void SetTransformation (const i2d::CAffine2d &transformation)
 Set the transformation object.
 
void Reset ()
 Set to identity transformation.
 
void Reset (const CVector2d &translation)
 Set this transformation to translation.
 
void Reset (const CVector2d &translation, double angle, double scale=1.0, bool isPosDef=true)
 Set this transformation to translation, rotation and scaling.
 
void Reset (const CVector2d &translation, double angle, const CVector2d &scale, bool isPosDef=true)
 Set this transformation to translation, rotation and both axis scaling.
 
int GetTransformationFlags () const override
 Get flags of describing type of this transformation.
 
bool GetDistance (const CVector2d &origPos1, const CVector2d &origPos2, double &result, ExactnessMode mode=EM_NONE) const override
 Compute a shortness distance in transformed coordinations.
 
bool GetPositionAt (const CVector2d &origPosition, CVector2d &result, ExactnessMode mode=EM_NONE) const override
 Get position after transformation.
 
bool GetInvPositionAt (const CVector2d &transfPosition, CVector2d &result, ExactnessMode mode=EM_NONE) const override
 Get position after transformation.
 
bool GetLocalTransform (const CVector2d &origPosition, CAffine2d &result, ExactnessMode mode=EM_NONE) const override
 Get local transformation (from original to transformed coordinate system) at some original position.
 
bool GetLocalInvTransform (const CVector2d &transfPosition, CAffine2d &result, ExactnessMode mode=EM_NONE) const override
 Get local transformation (from transformed to original coordinate system) at some transformed position.
 
bool GetInvValueAt (const CVector2d &argument, CVector2d &result) const override
 
CVector2d GetInvValueAt (const CVector2d &argument) const override
 
bool GetValueAt (const CVector2d &argument, CVector2d &result) const override
 
CVector2d GetValueAt (const CVector2d &argument) const override
 
bool Serialize (iser::IArchive &archive) override
 Load or store state of this object as a archive stream.
 
bool CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
 Copy this object from another one.
 
std::unique_ptr< istd::IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const override
 Make a copy of this object.
 
- Public Member Functions inherited from i2d::ITransformation2d
- Public Member Functions inherited from imath::TISurjectFunction< CVector2d, CVector2d >
virtual bool GetInvValueAt (const CVector2d &argument, CVector2d &result) const=0
 Get inverted function value.
 
virtual CVector2d GetInvValueAt (const CVector2d &argument) const=0
 Get inverted function value.
 
- Public Member Functions inherited from imath::TIMathFunction< CVector2d, CVector2d >
virtual bool GetValueAt (const CVector2d &argument, CVector2d &result) const=0
 Get function value for specified argument value.
 
virtual CVector2d GetValueAt (const CVector2d &argument) const=0
 Get function value for specified argument value.
 
- Public Member Functions inherited from iser::ISerializable
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data.
 
- Public Member Functions inherited from istd::IChangeable
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object.
 
virtual QMutex * GetChangesLock () const
 Get mutex beeing locked during changes, if available.
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction.
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction.
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes.
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes.
 
- Public Member Functions inherited from i2d::ICalibration2d

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set.
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event.
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event.
 
- Protected Attributes inherited from i2d::CAffineTransformation2d
CAffine2d m_transformation
 

Detailed Description

Definition of an affine transformation for 2D-spaces.

Definition at line 22 of file CAffineCalibration2d.h.

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CAffineCalibration2d() [1/2]

icalib::CAffineCalibration2d::CAffineCalibration2d ( )

◆ CAffineCalibration2d() [2/2]

icalib::CAffineCalibration2d::CAffineCalibration2d ( const i2d::CAffine2d & transformation)
explicit

Member Function Documentation

◆ CloneMe()

std::unique_ptr< istd::IChangeable > icalib::CAffineCalibration2d::CloneMe ( CompatibilityMode mode = CM_WITHOUT_REFS) const
overridevirtual

Make a copy of this object.

You may check, if this functionality is supported over GetSupportedOperations().

Returns
new instance or nullptr, if this operation is not supported.

Reimplemented from istd::IChangeable.

◆ CopyFrom()

bool icalib::CAffineCalibration2d::CopyFrom ( const istd::IChangeable & object,
CompatibilityMode mode = CM_WITHOUT_REFS )
overridevirtual

Copy this object from another one.

Default implementation in istd::IChangeable does nothing. You may check, if this functionality is supported over GetSupportedOperations().

Reimplemented from istd::IChangeable.

◆ CreateCombinedCalibration()

std::unique_ptr< i2d::ICalibration2d > icalib::CAffineCalibration2d::CreateCombinedCalibration ( const i2d::ITransformation2d & transformation) const
overridevirtual

Create new calibration being combination of this calibration and the second one.

Please note, that created object is owned by the caller and the caller must remove them.

Returns
new calibration object (owned by the caller) or nullptr if creation was impossible.

Implements i2d::ICalibration2d.

◆ GetArgumentArea()

const i2d::CRectangle * icalib::CAffineCalibration2d::GetArgumentArea ( ) const
overridevirtual

Get optional area where arguments are defined properly.

Returns
pointer to restriction area object or nullptr if there is no defined restrictions.

Implements i2d::ICalibration2d.

◆ GetArgumentUnitInfo()

const imath::IUnitInfo * icalib::CAffineCalibration2d::GetArgumentUnitInfo ( ) const
overridevirtual

Get unit description of calibration input (transformation function argument).

Returns
unit description of function argument or nullptr, if this information is unsupported.

Implements i2d::ICalibration2d.

◆ GetResultArea()

const i2d::CRectangle * icalib::CAffineCalibration2d::GetResultArea ( ) const
overridevirtual

Get optional area where results are defined properly.

Returns
pointer to restriction area object or nullptr if there is no defined restrictions.

Implements i2d::ICalibration2d.

◆ GetResultUnitInfo()

const imath::IUnitInfo * icalib::CAffineCalibration2d::GetResultUnitInfo ( ) const
overridevirtual

Get unit description of calibration output (transformation function result).

Returns
unit description of function result or nullptr, if this information is unsupported.

Implements i2d::ICalibration2d.

◆ GetSupportedOperations()

int icalib::CAffineCalibration2d::GetSupportedOperations ( ) const
overridevirtual

Get set of flags for supported operations.

See also
SupportedOperations

Reimplemented from istd::IChangeable.

◆ ResetData()

bool icalib::CAffineCalibration2d::ResetData ( CompatibilityMode mode = CM_WITHOUT_REFS)
overridevirtual

Reset data to its default state.

Default implementation in istd::IChangeable does nothing. You may check, if this functionality is supported over GetSupportedOperations().

Returns
true if the operation was successful, and false otherwise.

Reimplemented from istd::IChangeable.

◆ SetArgumentArea()

void icalib::CAffineCalibration2d::SetArgumentArea ( const i2d::CRectangle * areaPtr)

◆ SetArgumentUnitInfo()

void icalib::CAffineCalibration2d::SetArgumentUnitInfo ( const imath::IUnitInfo * unitInfoPtr)

◆ SetResultArea()

void icalib::CAffineCalibration2d::SetResultArea ( const i2d::CRectangle * areaPtr)

◆ SetResultUnitInfo()

void icalib::CAffineCalibration2d::SetResultUnitInfo ( const imath::IUnitInfo * unitInfoPtr)

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

© Witold Gantzke and Kirill Lepskiy