DBoW2 Namespace Reference

Classes
class	BowVector
	Vector of words to represent images. More...
class	FClass
	Generic class to encapsulate functions to manage descriptors. More...
class	FeatureVector
	Vector of nodes with indexes of local features. More...
class	FORB
	Functions to manipulate ORB descriptors. More...
class	GeneralScoring
	Base class of scoring functions. More...
class	TemplatedVocabulary
	Generic Vocabulary. More...

Typedefs
typedef unsigned int	NodeId
	Id of nodes in the vocabulary treee. More...
typedef unsigned int	WordId
	Id of words. More...
typedef double	WordValue
	Value of a word. More...

Enumerations
enum	LNorm { L1, L2 }
	L-norms for normalization. More...
enum	ScoringType {   L1_NORM, L2_NORM, CHI_SQUARE, KL,   BHATTACHARYYA, DOT_PRODUCT }
	Scoring type. More...
enum	WeightingType { TF_IDF, TF, IDF, BINARY }
	Weighting type. More...

Functions
class	__SCORING_CLASS (L1Scoring, true, L1)
	L1 Scoring object. More...
class	__SCORING_CLASS (L2Scoring, true, L2)
	L2 Scoring object. More...
class	__SCORING_CLASS (DotProductScoring, false, L1)
	Dot product Scoring object. More...
class	__SCORING_CLASS (BhattacharyyaScoring, true, L1)
	Bhattacharyya Scoring object. More...
class	__SCORING_CLASS (ChiSquareScoring, true, L1)
	Chi square Scoring object. More...
class	__SCORING_CLASS (KLScoring, true, L1)
	KL divergence Scoring object. More...
std::ostream &	operator<< (std::ostream &out, const FeatureVector &v)
std::ostream &	operator<< (std::ostream &out, const BowVector &v)
template<class TDescriptor , class F >
std::ostream &	operator<< (std::ostream &os, const TemplatedVocabulary< TDescriptor, F > &voc)

Detailed Description

File: BowVector.cpp Date: March 2011 Author: Dorian Galvez-Lopez Description: bag of words vector License: see the LICENSE.txt file

File: BowVector.h Date: March 2011 Author: Dorian Galvez-Lopez Description: bag of words vector License: see the LICENSE.txt file

File: FClass.h Date: November 2011 Author: Dorian Galvez-Lopez Description: generic FClass to instantiate templated classes License: see the LICENSE.txt file

File: FeatureVector.cpp Date: November 2011 Author: Dorian Galvez-Lopez Description: feature vector License: see the LICENSE.txt file

File: FeatureVector.h Date: November 2011 Author: Dorian Galvez-Lopez Description: feature vector License: see the LICENSE.txt file

File: FORB.h Date: June 2012 Author: Dorian Galvez-Lopez Description: functions for ORB descriptors License: see the LICENSE.txt file

File: ScoringObject.h Date: November 2011 Author: Dorian Galvez-Lopez Description: functions to compute bow scores License: see the LICENSE.txt file

Typedef Documentation

typedef unsigned int DBoW2::NodeId

Id of nodes in the vocabulary treee.

Definition at line 26 of file BowVector.h.

typedef unsigned int DBoW2::WordId

Id of words.

Definition at line 20 of file BowVector.h.

typedef double DBoW2::WordValue

Value of a word.

Definition at line 23 of file BowVector.h.

Enumeration Type Documentation

enum DBoW2::LNorm

L-norms for normalization.

Enumerator
L1
L2

Definition at line 29 of file BowVector.h.

enum DBoW2::ScoringType

Scoring type.

Enumerator
L1_NORM
L2_NORM
CHI_SQUARE
KL
BHATTACHARYYA
DOT_PRODUCT

Definition at line 45 of file BowVector.h.

enum DBoW2::WeightingType

Weighting type.

Enumerator
TF_IDF
TF
IDF
BINARY

Definition at line 36 of file BowVector.h.

Function Documentation

class DBoW2::__SCORING_CLASS	(	L1Scoring	,
		true	,
		L1
	)

L1 Scoring object.

class DBoW2::__SCORING_CLASS	(	L2Scoring	,
		true	,
		L2
	)

L2 Scoring object.

class DBoW2::__SCORING_CLASS	(	DotProductScoring	,
		false	,
		L1
	)

Dot product Scoring object.

class DBoW2::__SCORING_CLASS	(	BhattacharyyaScoring	,
		true	,
		L1
	)

Bhattacharyya Scoring object.

class DBoW2::__SCORING_CLASS	(	ChiSquareScoring	,
		true	,
		L1
	)

Chi square Scoring object.

class DBoW2::__SCORING_CLASS	(	KLScoring	,
		true	,
		L1
	)

KL divergence Scoring object.

std::ostream& DBoW2::operator<<	(	std::ostream &	out,
		const FeatureVector &	v
	)

Sends a string versions of the feature vector through the stream

Parameters

out	stream
v	feature vector

Definition at line 49 of file FeatureVector.cpp.

std::ostream& DBoW2::operator<<	(	std::ostream &	out,
		const BowVector &	v
	)

Prints the content of the bow vector

Parameters

out	stream
v

Definition at line 88 of file BowVector.cpp.

template<class TDescriptor , class F >

std::ostream& DBoW2::operator<<	(	std::ostream &	os,
		const TemplatedVocabulary< TDescriptor, F > &	voc
	)

Writes printable information of the vocabulary

Parameters

os	stream to write to
voc

Definition at line 1761 of file TemplatedVocabulary.h.