Ocean
Ocean::Tracking::Offline::OfflinePose Class Reference

This class encapsulates the tracking pose data. More...

Public Member Functions

 OfflinePose ()=default
 Creates a default pose object. More...
 
 OfflinePose (const unsigned int id, const HomogenousMatrix4 &transformation, const Scalar quality=-1.0)
 Creates a new pose object. More...
 
const HomogenousMatrix4transformation () const
 Returns the transformation of this pose. More...
 
Scalar quality () const
 Returns the abstract quality parameter of this pose. More...
 
unsigned int id () const
 Returns the id of this frame. More...
 
void setTransformation (const HomogenousMatrix4 &transformation)
 Sets or changes the transformation of this pose object. More...
 
void setQuality (const Scalar quality)
 Sets or changes the abstract quality parameters of this pose object. More...
 
void setId (const unsigned int id)
 Sets or changes the id of this pose object. More...
 
bool isValid () const
 Returns whether this pose holds a valid transformation. More...
 
 operator bool () const
 Returns whether this object holds a valid id and a valid pose. More...
 
bool operator< (const OfflinePose &object) const
 Compares two objects and returns whether this object has a higher quality parameter than the second one. More...
 

Static Public Member Functions

static ShiftVector< HomogenousMatrix4offlinePoses2transformations (const OfflinePoses &offlinePoses)
 Extracts the transformations from a set of offline pose objects. More...
 

Protected Attributes

unsigned int id_ = (unsigned int)(-1)
 Pose id. More...
 
HomogenousMatrix4 transformation_ = HomogenousMatrix4(false)
 The transformation of this pose. More...
 
Scalar quality_ = Scalar(-1)
 Pose quality. More...
 

Detailed Description

This class encapsulates the tracking pose data.

The pose is combined with a unique id and an abstract quality parameters.

Constructor & Destructor Documentation

◆ OfflinePose() [1/2]

Ocean::Tracking::Offline::OfflinePose::OfflinePose ( )
default

Creates a default pose object.

◆ OfflinePose() [2/2]

Ocean::Tracking::Offline::OfflinePose::OfflinePose ( const unsigned int  id,
const HomogenousMatrix4 transformation,
const Scalar  quality = -1.0 
)
inline

Creates a new pose object.

Parameters
idThe id of the pose
transformationThe transformation of this pose
qualityAbstract quality parameter of the pose

Member Function Documentation

◆ id()

unsigned int Ocean::Tracking::Offline::OfflinePose::id ( ) const
inline

Returns the id of this frame.

Returns
Frame id

◆ isValid()

bool Ocean::Tracking::Offline::OfflinePose::isValid ( ) const
inline

Returns whether this pose holds a valid transformation.

Returns
True, if so

◆ offlinePoses2transformations()

ShiftVector< HomogenousMatrix4 > Ocean::Tracking::Offline::OfflinePose::offlinePoses2transformations ( const OfflinePoses offlinePoses)
inlinestatic

Extracts the transformations from a set of offline pose objects.

Parameters
offlinePosesOffline pose object from that the transformations will be extracted

◆ operator bool()

Ocean::Tracking::Offline::OfflinePose::operator bool ( ) const
inlineexplicit

Returns whether this object holds a valid id and a valid pose.

Returns
True, if so

◆ operator<()

bool Ocean::Tracking::Offline::OfflinePose::operator< ( const OfflinePose object) const
inline

Compares two objects and returns whether this object has a higher quality parameter than the second one.

Parameters
objectSecond pose object
Returns
True, if so

◆ quality()

Scalar Ocean::Tracking::Offline::OfflinePose::quality ( ) const
inline

Returns the abstract quality parameter of this pose.

This parameter might have individual meanings for individual tracker implementations.

Returns
Pose quality

◆ setId()

void Ocean::Tracking::Offline::OfflinePose::setId ( const unsigned int  id)
inline

Sets or changes the id of this pose object.

Parameters
idId to be set

◆ setQuality()

void Ocean::Tracking::Offline::OfflinePose::setQuality ( const Scalar  quality)
inline

Sets or changes the abstract quality parameters of this pose object.

Parameters
qualityThe quality to be set

◆ setTransformation()

void Ocean::Tracking::Offline::OfflinePose::setTransformation ( const HomogenousMatrix4 transformation)
inline

Sets or changes the transformation of this pose object.

Parameters
transformationThe transformation to be set

◆ transformation()

const HomogenousMatrix4 & Ocean::Tracking::Offline::OfflinePose::transformation ( ) const
inline

Returns the transformation of this pose.

Returns
Frame pose

Field Documentation

◆ id_

unsigned int Ocean::Tracking::Offline::OfflinePose::id_ = (unsigned int)(-1)
protected

Pose id.

◆ quality_

Scalar Ocean::Tracking::Offline::OfflinePose::quality_ = Scalar(-1)
protected

Pose quality.

◆ transformation_

HomogenousMatrix4 Ocean::Tracking::Offline::OfflinePose::transformation_ = HomogenousMatrix4(false)
protected

The transformation of this pose.


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