OKVIS ROS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
okvis::KeypointIdentifier Struct Reference

Unique identifier for a keypoint. More...

#include <FrameTypedefs.hpp>

Public Member Functions

 KeypointIdentifier (uint64_t fi=0, size_t ci=0, size_t ki=0)
 Constructor. More...
 
uint64_t getFrameId ()
 Get multiframe ID. More...
 
void setFrameId (uint64_t fid)
 Set multiframe ID. More...
 
bool isBinaryEqual (const KeypointIdentifier &rhs) const
 Are two identifiers identical? More...
 
bool operator== (const KeypointIdentifier &rhs) const
 Equal to operator. More...
 
bool operator< (const KeypointIdentifier &rhs) const
 Less than operator. Compares first multiframe ID, then camera index, then keypoint index. More...
 

Public Attributes

uint64_t frameId
 Multiframe ID. More...
 
size_t cameraIndex
 Camera index. More...
 
size_t keypointIndex
 Index of the keypoint. More...
 

Detailed Description

Unique identifier for a keypoint.

A keypoint is identified as the keypoint with index keypointIndex in the frame with index cameraIndex of multiframe with ID frameID.

Constructor & Destructor Documentation

okvis::KeypointIdentifier::KeypointIdentifier ( uint64_t  fi = 0,
size_t  ci = 0,
size_t  ki = 0 
)
inline

Constructor.

Parameters
fiMultiframe ID.
ciCamera index.
kiKeypoint index.

Member Function Documentation

uint64_t okvis::KeypointIdentifier::getFrameId ( )
inline

Get multiframe ID.

bool okvis::KeypointIdentifier::isBinaryEqual ( const KeypointIdentifier rhs) const
inline

Are two identifiers identical?

bool okvis::KeypointIdentifier::operator< ( const KeypointIdentifier rhs) const
inline

Less than operator. Compares first multiframe ID, then camera index, then keypoint index.

bool okvis::KeypointIdentifier::operator== ( const KeypointIdentifier rhs) const
inline

Equal to operator.

void okvis::KeypointIdentifier::setFrameId ( uint64_t  fid)
inline

Set multiframe ID.

Member Data Documentation

size_t okvis::KeypointIdentifier::cameraIndex

Camera index.

uint64_t okvis::KeypointIdentifier::frameId

Multiframe ID.

size_t okvis::KeypointIdentifier::keypointIndex

Index of the keypoint.


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