SolAR::datastructure::Keypoint Class Reference

A 2D Keypoint.. More...

#include <Keypoint.h>

Inheritance diagram for SolAR::datastructure::Keypoint:

Collaboration diagram for SolAR::datastructure::Keypoint:

Public Member Functions
	Keypoint ()=default
	Keypoint constructor.
	Keypoint (unsigned int id, float x, float y, float r, float g, float b, float size, float angle=-1.0f, float response=0.0f, int octave=0, int class_id=-1)
	Keypoint constructor.
	~Keypoint ()
	~Keypoint
void	init (unsigned int id, float x, float y, float r, float g, float b, float size, float angle=-1.0f, float response=0.0f, int octave=0, int class_id=-1)
	This method initializes an Keypoint object. More...
float	getId () const
	This method returns the id of the keypoint in its frame. More...
float	getAngle () const
	This method returns the angle of an Keypoint. More...
float	getSize () const
	This method returns the size of an Keypoint. More...
float	getResponse () const
	GetResponse. More...
int	getOctave () const
	This method returns the octave of an Keypoint. More...
int	getClassId () const
	This method returns the classid of an Keypoint. More...
const Vector3f &	getRGB () const
	These methods returns the color components of the CloudPoint. More...
const float &	getR () const
	These methods returns the color components of the CloudPoint. More...
const float &	getG () const
const float &	getB () const
float	getDepth () const
	This method returns the depth value of an Keypoint in the camera coordinate system. More...
void	setDepth (float depth)
	This method allows to set the depth value of an Keypoint in the camera coordinate system. More...
template<typename Archive >
void	serialize (Archive &ar, ATTRIBUTE(maybe_unused) const unsigned int version)
Public Member Functions inherited from SolAR::datastructure::Point2Df
	Point2Df (float x=0, float y=0)
float	getX () const
float	getY () const
void	setX (float x)
void	setY (float y)
Point2Df	operator+ (const Point2Df &a) const
Point2Df	operator- (const Point2Df &a) const

Friends
class	boost::serialization::access

Detailed Description

A 2D Keypoint..

This class provides Keypoint definition.

Member Function Documentation

getAngle()

float SolAR::datastructure::Keypoint::getAngle ( ) const

inline

This method returns the angle of an Keypoint.

Returns

angle

getClassId()

int SolAR::datastructure::Keypoint::getClassId ( ) const

inline

This method returns the classid of an Keypoint.

Returns

classid

getDepth()

float SolAR::datastructure::Keypoint::getDepth ( ) const

inline

This method returns the depth value of an Keypoint in the camera coordinate system.

Returns

depth value

getId()

float SolAR::datastructure::Keypoint::getId ( ) const

inline

This method returns the id of the keypoint in its frame.

Returns

id

getOctave()

int SolAR::datastructure::Keypoint::getOctave ( ) const

inline

This method returns the octave of an Keypoint.

Returns

octave

getR()

const float & SolAR::datastructure::Keypoint::getR ( ) const

inline

These methods returns the color components of the CloudPoint.

Returns

the color component of the CloudPoint (Red, Green or Blue)

getResponse()

float SolAR::datastructure::Keypoint::getResponse ( ) const

inline

GetResponse.

Returns

getRGB()

const Vector3f & SolAR::datastructure::Keypoint::getRGB ( ) const

inline

These methods returns the color components of the CloudPoint.

Returns

the RGB color of the CloudPoint

getSize()

float SolAR::datastructure::Keypoint::getSize ( ) const

inline

This method returns the size of an Keypoint.

Returns

size

init()

void SolAR::datastructure::Keypoint::init	(	unsigned int	id,
		float	x,
		float	y,
		float	r,
		float	g,
		float	b,
		float	size,
		float	angle = -1.0f,
		float	response = 0.0f,
		int	octave = 0,
		int	class_id = -1
	)

This method initializes an Keypoint object.

Parameters

[in]	x	x-coordinate of the keypoint
[in]	y	y-coordinate of the keypoint
[in]	r	r-channel color value of the keypoint.
[in]	g	g-channel color value of the keypoint.
[in]	b	b-channel color value of the keypoint.
[in]	size	diameter of the meaningful keypoint neighborhood
[in]	angle	orientation of the keypoint
[in]	response	the response by which the most strong keypoints have been selected. Can be used for the further sorting or subsampling
[in]	octave	octave (pyramid layer) from which the keypoint has been extracted
[in]	class_id	object class (if the keypoints need to be clustered by an object they belong to)

setDepth()

void SolAR::datastructure::Keypoint::setDepth ( float  depth )

inline

This method allows to set the depth value of an Keypoint in the camera coordinate system.

Parameters

[in]

depth

Depth value

---

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

• interfaces/datastructure/Keypoint.h
• src/datastructure/Keypoint.cpp