jafar::fdetect_v2::DetectionResult< InterestFeatureT > Class Template Reference

This function stores the results of the interest feature detection. More...

---

Detailed Description

template<typename InterestFeatureT>
class jafar::fdetect_v2::DetectionResult< InterestFeatureT >

This function stores the results of the interest feature detection.

Each time this class is copied, data is shared, no deep copy is made, and once the last instance of this class is deleted, all interest features of the detection run are deleted. Therefor, there is no point to use this class with pointers, just copy instance.

Definition at line 118 of file DetectionResult.hpp.

#include <DetectionResult.hpp>

List of all members.

Public Types
typedef std::vector < InterestFeatureT * >	vInterestFeatures
	vector of templated
typedef std::vector < InterestFeatureT * > ::iterator	iterator
typedef std::vector < InterestFeatureT * > ::const_iterator	const_iterator
typedef std::vector < InterestFeatureT * > ::reverse_iterator	reverse_iterator
typedef std::vector < InterestFeatureT * > ::const_reverse_iterator	const_reverse_iterator
Public Member Functions
	DetectionResult ()
	Initialize an empty detection result2.
	DetectionResult (const DetectionResult &dr)
	Copy this detection result.
	~DetectionResult ()
	default destructor
unsigned int	countInterestFeatures () const
unsigned int	size () const
InterestFeatureT *	operator[] (int p)
const InterestFeatureT *	operator[] (int p) const
iterator	begin ()
const_iterator	begin () const
reverse_iterator	rbegin ()
const_reverse_iterator	rbegin () const
iterator	end ()
const_iterator	end () const
void	push_back (InterestFeatureT *ife)
	This function add a new interest feature to the result.
iterator	erase (iterator it)
	erase a feature described by an iterator to it.
iterator	erase (iterator first, iterator last)
	erase the features in range [, ).
iterator	erase (InterestFeatureT *ife)
	erase a feature.
template<class InputIterator >
void	insert (InputIterator first, InputIterator last)
	STL like inserter.
void	clean_indices ()
	after erasing or inserting at a given position it can be useful to redraw indices
void	clear ()
	clear the whole detection result i.e.
void	clone (DetectionResult &dr)
	make a real copy of the detection result in dr
vInterestFeatures &	get () const
DetectionResult	filter (double threshold=3.0)
Public Attributes
unsigned int	id
	DetectionResult id.
Private Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
Private Attributes
boost::shared_ptr < vInterestFeatures >	m_shared
Friends
class	boost::serialization::access
	!! nizar 20100912 : serialization stuff
std::ostream &	operator<< (std::ostream &s, const fdetect_v2::DetectionResult< InterestFeatureT > &p_)
	print out the detection result and shows the sharing amount

---

Constructor & Destructor Documentation

template<typename InterestFeatureT>

jafar::fdetect_v2::DetectionResult< InterestFeatureT >::DetectionResult

(

const DetectionResult< InterestFeatureT > &

dr

)

[inline]

Copy this detection result.

No vInterestFeatures is created, the reference of the original is incremented.

Definition at line 137 of file DetectionResult.hpp.

---

Member Function Documentation

template<typename InterestFeatureT>

iterator jafar::fdetect_v2::DetectionResult< InterestFeatureT >::begin

(

)

[inline]

Returns:

an iterator on the first interest feature

Definition at line 173 of file DetectionResult.hpp.

Referenced by jafar::fdetect_v2::DetectionResult< DESCRIPTOR >::clone(), jafar::fdetect_v2::DescriptorFactory< DESCRIPTOR >::createDescriptor(), jafar::fdetect_v2::DetectionResult< DESCRIPTOR >::filter(), jafar::gfm_v2::EngineTracking< DESCRIPTOR >::initTracking(), jafar::gfm_v2::AllTimeTracker< DESCRIPTOR >::nextImage(), and jafar::gfm_v2::EngineTracking< DESCRIPTOR >::nextImage().

template<typename InterestFeatureT>

const_iterator jafar::fdetect_v2::DetectionResult< InterestFeatureT >::begin

(

)

const [inline]

Returns:

a constant iterator on the first interest feature

Definition at line 180 of file DetectionResult.hpp.

template<typename InterestFeatureT>

void jafar::fdetect_v2::DetectionResult< InterestFeatureT >::clear

(

)

[inline]

clear the whole detection result i.e.

clear the associated array of interest features

Definition at line 271 of file DetectionResult.hpp.

Referenced by jafar::fdetect_v2::DetectionResult< DESCRIPTOR >::clone(), and jafar::gfm_v2::AllTimeTracker< DESCRIPTOR >::nextImage().

template<typename InterestFeatureT>

unsigned int jafar::fdetect_v2::DetectionResult< InterestFeatureT >::countInterestFeatures

(

)

const [inline]

Returns:

the number of interest features for this result

Definition at line 146 of file DetectionResult.hpp.

template<typename InterestFeatureT>

iterator jafar::fdetect_v2::DetectionResult< InterestFeatureT >::end

(

)

[inline]

Returns:

an iterator on the end of the vector of interest feature

Definition at line 201 of file DetectionResult.hpp.

Referenced by jafar::fdetect_v2::DetectionResult< DESCRIPTOR >::clone(), jafar::fdetect_v2::DescriptorFactory< DESCRIPTOR >::createDescriptor(), jafar::fdetect_v2::DetectionResult< DESCRIPTOR >::filter(), jafar::gfm_v2::EngineTracking< DESCRIPTOR >::initTracking(), jafar::gfm_v2::AllTimeTracker< DESCRIPTOR >::nextImage(), and jafar::gfm_v2::EngineTracking< DESCRIPTOR >::nextImage().

template<typename InterestFeatureT>

const_iterator jafar::fdetect_v2::DetectionResult< InterestFeatureT >::end

(

)

const [inline]

Returns:

a constant iterator on the end of the vector of interest feature

Definition at line 208 of file DetectionResult.hpp.

template<typename InterestFeatureT>

iterator jafar::fdetect_v2::DetectionResult< InterestFeatureT >::erase

(

iterator

it

)

[inline]

erase a feature described by an iterator to it.

Returns:

iterator to the new location of the element that followed the erased element

Definition at line 229 of file DetectionResult.hpp.

template<typename InterestFeatureT>

iterator jafar::fdetect_v2::DetectionResult< InterestFeatureT >::erase	(	iterator	first,
		iterator	last
	)		[inline]

erase the features in range [, ).

Returns:

iterator pointing to the new location of the element that followed the last element erased

Definition at line 238 of file DetectionResult.hpp.

template<typename InterestFeatureT>

iterator jafar::fdetect_v2::DetectionResult< InterestFeatureT >::erase

(

InterestFeatureT *

ife

)

[inline]

erase a feature.

Returns:

iterator to the next element.

Definition at line 246 of file DetectionResult.hpp.

template<typename InterestFeatureT>

DetectionResult jafar::fdetect_v2::DetectionResult< InterestFeatureT >::filter

(

double

threshold = 3.0

)

[inline]

Returns:

a detection result from this which features quality are higher than or equal to

Definition at line 297 of file DetectionResult.hpp.

template<typename InterestFeatureT>

vInterestFeatures& jafar::fdetect_v2::DetectionResult< InterestFeatureT >::get

(

)

const [inline]

Returns:

the vector of interest features pointers

Definition at line 289 of file DetectionResult.hpp.

template<typename InterestFeatureT>

InterestFeatureT* jafar::fdetect_v2::DetectionResult< InterestFeatureT >::operator[]

(

int

p

)

[inline]

Parameters:

p	index of the interest feature

Returns:

the interest feature at index p

Definition at line 158 of file DetectionResult.hpp.

template<typename InterestFeatureT>

const InterestFeatureT* jafar::fdetect_v2::DetectionResult< InterestFeatureT >::operator[]

(

int

p

)

const [inline]

Parameters:

p	index of the interest feature

Returns:

a constant pointer to the interest feature at index p

Definition at line 166 of file DetectionResult.hpp.

template<typename InterestFeatureT>

void jafar::fdetect_v2::DetectionResult< InterestFeatureT >::push_back

(

InterestFeatureT *

ife

)

[inline]

This function add a new interest feature to the result.

The index of the interest feature is set to the position in the vector. Note that DetectionResult takes the responsability to delete that interest feature.

Parameters:

InterestFeature

a pointer to the interest feature

Definition at line 219 of file DetectionResult.hpp.

Referenced by jafar::fdetect_v2::DetectionResult< DESCRIPTOR >::clone(), jafar::fdetect_v2::DetectionResult< DESCRIPTOR >::filter(), and jafar::gfm_v2::AllTimeTracker< DESCRIPTOR >::nextImage().

template<typename InterestFeatureT>

reverse_iterator jafar::fdetect_v2::DetectionResult< InterestFeatureT >::rbegin

(

)

[inline]

Returns:

a reverese iterator on the last interest feature

Definition at line 187 of file DetectionResult.hpp.

template<typename InterestFeatureT>

const_reverse_iterator jafar::fdetect_v2::DetectionResult< InterestFeatureT >::rbegin

(

)

const [inline]

Returns:

a constant reverse iterator on the last interest feature

Definition at line 194 of file DetectionResult.hpp.

---

Friends And Related Function Documentation

template<typename InterestFeatureT>

std::ostream& operator<<	(	std::ostream &	s,
		const fdetect_v2::DetectionResult< InterestFeatureT > &	p_
	)		[friend]

print out the detection result and shows the sharing amount

Note:

: this is also accounted

Definition at line 309 of file DetectionResult.hpp.

---

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

• modules/fdetect/include/fdetect/DetectionResult.hpp