mrpt::vision::CMatchedFeatureList Class Reference

Detailed Description

A list of features.

Definition at line 494 of file CFeature.h.

#include <mrpt/vision/CFeature.h>

Inheritance diagram for mrpt::vision::CMatchedFeatureList:

Public Member Functions
TKeyPointMethod	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...
const CFeature *	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 ()=default
virtual	~CMatchedFeatureList ()=default

Public Attributes
T	elements
	STL member. More...

Protected Attributes
TFeatureID	m_leftMaxID {0}
TFeatureID	m_rightMaxID {0}

Constructor & Destructor Documentation

CMatchedFeatureList()

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

default

~CMatchedFeatureList()

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

virtualdefault

Member Function Documentation

get_type()

TKeyPointMethod mrpt::vision::CMatchedFeatureList::get_type ( ) const

inline

The type of the first feature in the list.

Definition at line 498 of file CFeature.h.

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

Here is the call graph for this function:

getBothFeatureLists()

void CMatchedFeatureList::getBothFeatureLists	(	CFeatureList &	list1,
		CFeatureList &	list2
	)

Returns the matching features as two separate CFeatureLists.

Definition at line 1222 of file CFeature.cpp.

References mrpt::containers::begin(), mrpt::containers::end(), MRPT_END, MRPT_START, mrpt::vision::CFeatureList::resize(), and mrpt::math::size().

Here is the call graph for this function:

getByID()

const CFeature * 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.

Definition at line 1171 of file CFeature.cpp.

References mrpt::containers::begin(), mrpt::containers::end(), and mrpt::vision::firstList.

Here is the call graph for this function:

getMaxID()

void 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.

Definition at line 1206 of file CFeature.cpp.

References ASSERT_, mrpt::vision::bothLists, mrpt::containers::empty(), mrpt::vision::firstList, MRPT_END, MRPT_START, and mrpt::vision::secondList.

Referenced by mrpt::vision::matchFeatures().

Here is the call graph for this function:

Here is the caller graph for this function:

saveToTextFile()

void CMatchedFeatureList::saveToTextFile

(

const std::string &

fileName

)

Save list of matched features to a text file.

Definition at line 1149 of file CFeature.cpp.

References mrpt::system::os::fclose(), mrpt::system::os::fopen(), and mrpt::system::os::fprintf().

Here is the call graph for this function:

setLeftMaxID()

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

inline

Explicitly set the max IDs values to certain values.

Definition at line 525 of file CFeature.h.

References m_leftMaxID.

Referenced by mrpt::vision::matchFeatures(), and setMaxIDs().

Here is the caller graph for this function:

setMaxIDs()

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

inline

Definition at line 530 of file CFeature.h.

References setLeftMaxID(), and setRightMaxID().

Here is the call graph for this function:

setRightMaxID()

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

inline

Definition at line 526 of file CFeature.h.

References m_rightMaxID.

Referenced by mrpt::vision::matchFeatures(), and setMaxIDs().

Here is the caller graph for this function:

updateMaxID()

void 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.

Definition at line 1186 of file CFeature.cpp.

References mrpt::containers::begin(), mrpt::vision::bothLists, mrpt::containers::end(), mrpt::vision::firstList, mrpt::keep_max(), MRPT_END, MRPT_START, and mrpt::vision::secondList.

Here is the call graph for this function:

Member Data Documentation

elements

T std::deque< T >::elements

inherited

STL member.

m_leftMaxID

TFeatureID mrpt::vision::CMatchedFeatureList::m_leftMaxID {0}

protected

Definition at line 540 of file CFeature.h.

Referenced by setLeftMaxID().

m_rightMaxID

TFeatureID mrpt::vision::CMatchedFeatureList::m_rightMaxID {0}

protected

Definition at line 540 of file CFeature.h.

Referenced by setRightMaxID().