Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | Public Member Functions | Public Attributes | Protected Attributes
mrpt::vision::CMatchedFeatureList Class Reference

Detailed Description

A list of features.

Definition at line 361 of file CFeature.h.

#include <mrpt/vision/CFeature.h>

Inheritance diagram for mrpt::vision::CMatchedFeatureList:
Inheritance graph

Public Member Functions

TFeatureType get_type () const
 The type of the first feature in the list. More...
 
void saveToTextFile (const std::string &fileName)
 Save list of matched features to a text file. More...
 
void getBothFeatureLists (CFeatureList &list1, CFeatureList &list2)
 Returns the matching features as two separate CFeatureLists. More...
 
CFeaturePtr getByID (const TFeatureID &ID, const TListIdx &idx)
 Returns a smart pointer to the feature with the provided ID or a empty one if not found. More...
 
void getMaxID (const TListIdx &idx, TFeatureID &firstListID, TFeatureID &secondListID)
 Returns the maximum ID of the features in the list. More...
 
void updateMaxID (const TListIdx &idx)
 Updates the value of the maximum ID of the features in the matched list, i.e. More...
 
void setLeftMaxID (const TFeatureID &leftID)
 Explicitly set the max IDs values to certain values. More...
 
void setRightMaxID (const TFeatureID &rightID)
 
void setMaxIDs (const TFeatureID &leftID, const TFeatureID &rightID)
 
 CMatchedFeatureList ()
 Constructor. More...
 
virtual ~CMatchedFeatureList ()
 Virtual destructor. More...
 

Public Attributes

elements
 STL member. More...
 

Protected Attributes

TFeatureID m_leftMaxID
 
TFeatureID m_rightMaxID
 

Constructor & Destructor Documentation

◆ CMatchedFeatureList()

mrpt::vision::CMatchedFeatureList::CMatchedFeatureList ( )

Constructor.

◆ ~CMatchedFeatureList()

virtual mrpt::vision::CMatchedFeatureList::~CMatchedFeatureList ( )
virtual

Virtual destructor.

Member Function Documentation

◆ get_type()

TFeatureType mrpt::vision::CMatchedFeatureList::get_type ( ) const
inline

The type of the first feature in the list.

Definition at line 365 of file CFeature.h.

References begin(), empty(), mrpt::vision::featNotDefined, and get_type().

Referenced by get_type().

◆ getBothFeatureLists()

void mrpt::vision::CMatchedFeatureList::getBothFeatureLists ( CFeatureList list1,
CFeatureList list2 
)

Returns the matching features as two separate CFeatureLists.

◆ getByID()

CFeaturePtr mrpt::vision::CMatchedFeatureList::getByID ( const TFeatureID ID,
const TListIdx idx 
)

Returns a smart pointer to the feature with the provided ID or a empty one if not found.

References mrpt::vision::CFeaturePtr.

◆ getMaxID()

void mrpt::vision::CMatchedFeatureList::getMaxID ( const TListIdx idx,
TFeatureID firstListID,
TFeatureID secondListID 
)

Returns the maximum ID of the features in the list.

If the max ID has been already set up, this method just returns it. Otherwise, this method finds, stores and returns it.

◆ saveToTextFile()

void mrpt::vision::CMatchedFeatureList::saveToTextFile ( const std::string &  fileName)

Save list of matched features to a text file.

◆ setLeftMaxID()

void mrpt::vision::CMatchedFeatureList::setLeftMaxID ( const TFeatureID leftID)
inline

Explicitly set the max IDs values to certain values.

Definition at line 384 of file CFeature.h.

◆ setMaxIDs()

void mrpt::vision::CMatchedFeatureList::setMaxIDs ( const TFeatureID leftID,
const TFeatureID rightID 
)
inline

Definition at line 386 of file CFeature.h.

◆ setRightMaxID()

void mrpt::vision::CMatchedFeatureList::setRightMaxID ( const TFeatureID rightID)
inline

Definition at line 385 of file CFeature.h.

◆ updateMaxID()

void mrpt::vision::CMatchedFeatureList::updateMaxID ( const TListIdx idx)

Updates the value of the maximum ID of the features in the matched list, i.e.

it explicitly searches for the max ID and updates the member variables.

Member Data Documentation

◆ elements

T std::deque< T >::elements
inherited

STL member.

◆ m_leftMaxID

TFeatureID mrpt::vision::CMatchedFeatureList::m_leftMaxID
protected

Definition at line 398 of file CFeature.h.

◆ m_rightMaxID

TFeatureID mrpt::vision::CMatchedFeatureList::m_rightMaxID
protected

Definition at line 398 of file CFeature.h.




Page generated by Doxygen 1.9.5 for MRPT 1.4.0 SVN: at Tue Dec 27 00:54:45 UTC 2022