DBoW2 Namespace Reference

Includes all the data structures to manage vocabularies and image databases. More...

Classes

class  BowVector
 Vector of words to represent images. More...
class  FBrief
 Functions to manipulate BRIEF descriptors. More...
class  FClass
 Generic class to encapsulate functions to manage descriptors. More...
class  FeatureVector
 Vector of nodes with indexes of local features. More...
class  FSurf64
 Functions to manipulate SURF64 descriptors. More...
class  Result
 Single result of a query. More...
class  QueryResults
 Multiple results from a query. More...
class  GeneralScoring
 Base class of scoring functions. More...
class  TemplatedDatabase
 Generic Database. More...
struct  tBCData
class  TemplatedVocabulary
 Generic Vocabulary. More...

Typedefs

typedef unsigned int WordId
 Id of words.
typedef double WordValue
 Value of a word.
typedef unsigned int NodeId
 Id of nodes in the vocabulary treee.
typedef unsigned int EntryId
 Id of entries of the database.

Enumerations

enum  LNorm { L1, L2 }
 

L-norms for normalization.


enum  WeightingType { TF_IDF, TF, IDF, BINARY }
 

Weighting type.


enum  ScoringType {
  L1_NORM, L2_NORM, CHI_SQUARE, KL,
  BHATTACHARYYA, DOT_PRODUCT
}
 

Scoring type.


Functions

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

Detailed Description

Includes all the data structures to manage vocabularies and image databases.

File: BowVector.cpp Date: March 2011 Author: Dorian Galvez-Lopez Description: bag of words vector

This file is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 license. This file can be freely used and users can use, download and edit this file provided that credit is attributed to the original author. No users are permitted to use this file for commercial purposes unless explicit permission is given by the original author. Derivative works must be licensed using the same or similar license. Check http://creativecommons.org/licenses/by-nc-sa/3.0/ to obtain further details.

File: BowVector.h Date: March 2011 Author: Dorian Galvez-Lopez Description: bag of words vector

This file is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 license. This file can be freely used and users can use, download and edit this file provided that credit is attributed to the original author. No users are permitted to use this file for commercial purposes unless explicit permission is given by the original author. Derivative works must be licensed using the same or similar license. Check http://creativecommons.org/licenses/by-nc-sa/3.0/ to obtain further details.

File: FBrief.h Date: November 2011 Author: Dorian Galvez-Lopez Description: functions for BRIEF descriptors

This file is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 license. This file can be freely used and users can use, download and edit this file provided that credit is attributed to the original author. No users are permitted to use this file for commercial purposes unless explicit permission is given by the original author. Derivative works must be licensed using the same or similar license. Check http://creativecommons.org/licenses/by-nc-sa/3.0/ to obtain further details.

File: FClass.h Date: November 2011 Author: Dorian Galvez-Lopez Description: generic FClass to instantiate templated classes

This file is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 license. This file can be freely used and users can use, download and edit this file provided that credit is attributed to the original author. No users are permitted to use this file for commercial purposes unless explicit permission is given by the original author. Derivative works must be licensed using the same or similar license. Check http://creativecommons.org/licenses/by-nc-sa/3.0/ to obtain further details.

File: FeatureVector.cpp Date: November 2011 Author: Dorian Galvez-Lopez Description: feature vector

This file is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 license. This file can be freely used and users can use, download and edit this file provided that credit is attributed to the original author. No users are permitted to use this file for commercial purposes unless explicit permission is given by the original author. Derivative works must be licensed using the same or similar license. Check http://creativecommons.org/licenses/by-nc-sa/3.0/ to obtain further details.

File: FeatureVector.h Date: November 2011 Author: Dorian Galvez-Lopez Description: feature vector

This file is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 license. This file can be freely used and users can use, download and edit this file provided that credit is attributed to the original author. No users are permitted to use this file for commercial purposes unless explicit permission is given by the original author. Derivative works must be licensed using the same or similar license. Check http://creativecommons.org/licenses/by-nc-sa/3.0/ to obtain further details.

File: FSurf64.h Date: November 2011 Author: Dorian Galvez-Lopez Description: functions for Surf64 descriptors

This file is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 license. This file can be freely used and users can use, download and edit this file provided that credit is attributed to the original author. No users are permitted to use this file for commercial purposes unless explicit permission is given by the original author. Derivative works must be licensed using the same or similar license. Check http://creativecommons.org/licenses/by-nc-sa/3.0/ to obtain further details.

File: QueryResults.h Date: March, November 2011 Author: Dorian Galvez-Lopez Description: structure to store results of database queries

This file is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 license. This file can be freely used and users can use, download and edit this file provided that credit is attributed to the original author. No users are permitted to use this file for commercial purposes unless explicit permission is given by the original author. Derivative works must be licensed using the same or similar license. Check http://creativecommons.org/licenses/by-nc-sa/3.0/ to obtain further details.

File: ScoringObject.h Date: November 2011 Author: Dorian Galvez-Lopez Description: functions to compute bow scores

This file is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 license. This file can be freely used and users can use, download and edit this file provided that credit is attributed to the original author. No users are permitted to use this file for commercial purposes unless explicit permission is given by the original author. Derivative works must be licensed using the same or similar license. Check http://creativecommons.org/licenses/by-nc-sa/3.0/ to obtain further details.


Function Documentation

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

L1 Scoring object.

\ Computes score between two vectors \

Parameters:
v \
w \
Returns:
score between v and w \ \ Says if a vector must be normalized according to the scoring function \
Parameters:
norm (out) if true, norm to use
Returns:
true iff vectors must be normalized \
template<class TDescriptor , class F >
std::ostream& DBoW2::operator<< ( std::ostream &  os,
const TemplatedVocabulary< TDescriptor, F > &  voc 
) [inline]

Writes printable information of the vocabulary

Parameters:
os stream to write to
voc 
template<class TDescriptor , class F >
std::ostream& DBoW2::operator<< ( std::ostream &  os,
const TemplatedDatabase< TDescriptor, F > &  db 
) [inline]

Writes printable information of the database

Parameters:
os stream to write to
db 
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
std::ostream& DBoW2::operator<< ( std::ostream &  out,
const BowVector &  v 
)

Prints the content of the bow vector

Parameters:
out stream
v 
 All Classes Namespaces Functions Variables Typedefs Enumerations Friends
Generated on Thu Feb 7 19:47:43 2013 by  doxygen 1.6.3