mrpt::vision::TKeyPoint_templ< PIXEL_COORD_TYPE > Struct Template Reference

Detailed Description

template<typename PIXEL_COORD_TYPE>
struct mrpt::vision::TKeyPoint_templ< PIXEL_COORD_TYPE >

Simple structure for image key points.

Descriptors are stored separately in CFeatureList. This is a template to allow using both integers (TKeyPoint) or floats (TKeyPointf) as pixel coordinates.

See also

TKeyPoint, TKeyPointf

Definition at line 28 of file TKeyPoint.h.

#include <mrpt/vision/TKeyPoint.h>

Inheritance diagram for mrpt::vision::TKeyPoint_templ< PIXEL_COORD_TYPE >:

Public Types
using	pixel_coords_t = PIXEL_COORD_TYPE
	The type of pt. More...
using	pixel_coord_t = typename PIXEL_COORD_TYPE::pixel_coord_t
	The type of pt.x and pt.y. More...

Public Member Functions
template<typename COORD_TYPE >
	TKeyPoint_templ (const COORD_TYPE x, const COORD_TYPE y)
	Constructor that only sets the pt. More...
	TKeyPoint_templ ()=default
	Default constructor, leaves all fields uninitialized. More...
template<typename OTHER_TKeyPoint >
	TKeyPoint_templ (const OTHER_TKeyPoint &o)

Public Attributes
pixel_coords_t	pt
	Coordinates in the image. More...
TFeatureID	ID {static_cast<TFeatureID>(-1)}
	ID of the feature. More...
TFeatureTrackStatus	track_status {status_IDLE}
	Status of the feature tracking process. More...
float	response {0}
	A measure of the "goodness" of the feature (typically, the KLT_response value) More...
uint8_t	octave {0}
	The image octave the image was found in: 0=original image, 1=1/2 image, 2=1/4 image, etc. More...
uint8_t	user_flags {0}
	A field for any other flags needed by the user (this has not a predefined meaning) More...

Member Typedef Documentation

pixel_coord_t

template<typename PIXEL_COORD_TYPE>

using mrpt::vision::TKeyPoint_templ< PIXEL_COORD_TYPE >::pixel_coord_t = typename PIXEL_COORD_TYPE::pixel_coord_t

The type of pt.x and pt.y.

Definition at line 33 of file TKeyPoint.h.

pixel_coords_t

template<typename PIXEL_COORD_TYPE>

using mrpt::vision::TKeyPoint_templ< PIXEL_COORD_TYPE >::pixel_coords_t = PIXEL_COORD_TYPE

The type of pt.

Definition at line 31 of file TKeyPoint.h.

Constructor & Destructor Documentation

TKeyPoint_templ() [1/3]

template<typename PIXEL_COORD_TYPE>

template<typename COORD_TYPE >

mrpt::vision::TKeyPoint_templ< PIXEL_COORD_TYPE >::TKeyPoint_templ ( const COORD_TYPE  x, const COORD_TYPE  y  )

inline

Constructor that only sets the pt.

{x,y} values, leaving all other values to undefined values.

Definition at line 57 of file TKeyPoint.h.

TKeyPoint_templ() [2/3]

template<typename PIXEL_COORD_TYPE>

mrpt::vision::TKeyPoint_templ< PIXEL_COORD_TYPE >::TKeyPoint_templ ( )

inlinedefault

Default constructor, leaves all fields uninitialized.

TKeyPoint_templ() [3/3]

template<typename PIXEL_COORD_TYPE>

template<typename OTHER_TKeyPoint >

mrpt::vision::TKeyPoint_templ< PIXEL_COORD_TYPE >::TKeyPoint_templ ( const OTHER_TKeyPoint &  o )

inlineexplicit

Definition at line 64 of file TKeyPoint.h.

Member Data Documentation

ID

template<typename PIXEL_COORD_TYPE>

TFeatureID mrpt::vision::TKeyPoint_templ< PIXEL_COORD_TYPE >::ID {static_cast<TFeatureID>(-1)}

ID of the feature.

Definition at line 39 of file TKeyPoint.h.

Referenced by mrpt::vision::CFeatureExtraction::extractFeaturesAKAZE(), mrpt::vision::CFeatureExtraction::extractFeaturesFAST(), mrpt::vision::CFeatureExtraction::extractFeaturesKLT(), mrpt::vision::CFeatureExtraction::extractFeaturesLSD(), mrpt::vision::CFeatureExtraction::extractFeaturesORB(), mrpt::vision::CFeatureExtraction::extractFeaturesSIFT(), mrpt::vision::CFeatureExtraction::extractFeaturesSURF(), mrpt::vision::CFeatureList::loadFromTextFile(), and mrpt::vision::detail::trackFeatures_addNewFeats< CFeatureList >().

octave

template<typename PIXEL_COORD_TYPE>

uint8_t mrpt::vision::TKeyPoint_templ< PIXEL_COORD_TYPE >::octave {0}

The image octave the image was found in: 0=original image, 1=1/2 image, 2=1/4 image, etc.

Definition at line 49 of file TKeyPoint.h.

Referenced by mrpt::vision::CFeatureExtraction::extractFeaturesAKAZE(), mrpt::vision::CFeatureExtraction::extractFeaturesFAST(), mrpt::vision::CFeatureExtraction::extractFeaturesLSD(), mrpt::vision::CFeatureExtraction::extractFeaturesORB(), mrpt::vision::CFeatureExtraction::extractFeaturesSIFT(), mrpt::vision::CFeatureExtraction::extractFeaturesSURF(), mrpt::vision::CFeatureList::loadFromTextFile(), and mrpt::vision::detail::trackFeatures_addNewFeats< CFeatureList >().

pt

template<typename PIXEL_COORD_TYPE>

pixel_coords_t mrpt::vision::TKeyPoint_templ< PIXEL_COORD_TYPE >::pt

Coordinates in the image.

Definition at line 36 of file TKeyPoint.h.

Referenced by mrpt::vision::CFeatureExtraction::extractFeaturesAKAZE(), mrpt::vision::CFeatureExtraction::extractFeaturesFAST(), mrpt::vision::CFeatureExtraction::extractFeaturesKLT(), mrpt::vision::CFeatureExtraction::extractFeaturesLSD(), mrpt::vision::CFeatureExtraction::extractFeaturesORB(), mrpt::vision::CFeatureExtraction::extractFeaturesSIFT(), mrpt::vision::CFeatureExtraction::extractFeaturesSURF(), mrpt::vision::CFeatureList::loadFromTextFile(), mrpt::vision::projectMatchedFeature(), mrpt::vision::detail::trackFeatures_addNewFeats< CFeatureList >(), and mrpt::vision::detail::trackFeatures_addNewFeats_simple_list().

response

template<typename PIXEL_COORD_TYPE>

float mrpt::vision::TKeyPoint_templ< PIXEL_COORD_TYPE >::response {0}

A measure of the "goodness" of the feature (typically, the KLT_response value)

Definition at line 46 of file TKeyPoint.h.

Referenced by mrpt::vision::CFeatureExtraction::extractFeaturesLSD(), mrpt::vision::CFeatureExtraction::extractFeaturesSIFT(), mrpt::vision::detail::trackFeatures_addNewFeats< CFeatureList >(), and mrpt::vision::detail::trackFeatures_addNewFeats_simple_list().

track_status

template<typename PIXEL_COORD_TYPE>

TFeatureTrackStatus mrpt::vision::TKeyPoint_templ< PIXEL_COORD_TYPE >::track_status {status_IDLE}

Status of the feature tracking process.

Definition at line 42 of file TKeyPoint.h.

user_flags

template<typename PIXEL_COORD_TYPE>

uint8_t mrpt::vision::TKeyPoint_templ< PIXEL_COORD_TYPE >::user_flags {0}

A field for any other flags needed by the user (this has not a predefined meaning)

Definition at line 52 of file TKeyPoint.h.