OpenCV  2.4.13
Open Source Computer Vision
cv::ORB Class Reference

#include <features2d.hpp>

Inheritance diagram for cv::ORB:
cv::Feature2D cv::FeatureDetector cv::DescriptorExtractor cv::Algorithm cv::Algorithm

Public Types

enum  { kBytes = 32, HARRIS_SCORE =0, FAST_SCORE =1 }
 
- Public Types inherited from cv::Algorithm
typedef Algorithm *(* Constructor) (void)
 
typedef int(Algorithm::* Getter) () const
 
typedef void(Algorithm::* Setter) (int)
 

Public Member Functions

 ORB (int nfeatures=500, float scaleFactor=1.2f, int nlevels=8, int edgeThreshold=31, int firstLevel=0, int WTA_K=2, int scoreType=ORB::HARRIS_SCORE, int patchSize=31)
 
int descriptorSize () const
 
int descriptorType () const
 
void operator() (InputArray image, InputArray mask, vector< KeyPoint > &keypoints) const
 
void operator() (InputArray image, InputArray mask, vector< KeyPoint > &keypoints, OutputArray descriptors, bool useProvidedKeypoints=false) const
 
AlgorithmInfoinfo () const
 
- Public Member Functions inherited from cv::Feature2D
virtual void operator() (InputArray image, InputArray mask, CV_OUT vector< KeyPoint > &keypoints, OutputArray descriptors, bool useProvidedKeypoints=false) const =0
 
void compute (const Mat &image, CV_OUT CV_IN_OUT std::vector< KeyPoint > &keypoints, CV_OUT Mat &descriptors) const
 
- Public Member Functions inherited from cv::FeatureDetector
virtual ~FeatureDetector ()
 
void detect (const Mat &image, CV_OUT vector< KeyPoint > &keypoints, const Mat &mask=Mat()) const
 
void detect (const vector< Mat > &images, vector< vector< KeyPoint > > &keypoints, const vector< Mat > &masks=vector< Mat >()) const
 
virtual bool empty () const
 
- Public Member Functions inherited from cv::Algorithm
 Algorithm ()
 
virtual ~Algorithm ()
 
string name () const
 
template<typename _Tp >
ParamType< _Tp >::member_type get (const string &name) const
 
template<typename _Tp >
ParamType< _Tp >::member_type get (const char *name) const
 
int getInt (const string &name) const
 
double getDouble (const string &name) const
 
bool getBool (const string &name) const
 
string getString (const string &name) const
 
Mat getMat (const string &name) const
 
vector< MatgetMatVector (const string &name) const
 
Ptr< AlgorithmgetAlgorithm (const string &name) const
 
void set (const string &name, int value)
 
void set (const string &name, double value)
 
void set (const string &name, bool value)
 
void set (const string &name, const string &value)
 
void set (const string &name, const Mat &value)
 
void set (const string &name, const vector< Mat > &value)
 
void set (const string &name, const Ptr< Algorithm > &value)
 
template<typename _Tp >
void set (const string &name, const Ptr< _Tp > &value)
 
void setInt (const string &name, int value)
 
void setDouble (const string &name, double value)
 
void setBool (const string &name, bool value)
 
void setString (const string &name, const string &value)
 
void setMat (const string &name, const Mat &value)
 
void setMatVector (const string &name, const vector< Mat > &value)
 
void setAlgorithm (const string &name, const Ptr< Algorithm > &value)
 
template<typename _Tp >
void setAlgorithm (const string &name, const Ptr< _Tp > &value)
 
void set (const char *name, int value)
 
void set (const char *name, double value)
 
void set (const char *name, bool value)
 
void set (const char *name, const string &value)
 
void set (const char *name, const Mat &value)
 
void set (const char *name, const vector< Mat > &value)
 
void set (const char *name, const Ptr< Algorithm > &value)
 
template<typename _Tp >
void set (const char *name, const Ptr< _Tp > &value)
 
void setInt (const char *name, int value)
 
void setDouble (const char *name, double value)
 
void setBool (const char *name, bool value)
 
void setString (const char *name, const string &value)
 
void setMat (const char *name, const Mat &value)
 
void setMatVector (const char *name, const vector< Mat > &value)
 
void setAlgorithm (const char *name, const Ptr< Algorithm > &value)
 
template<typename _Tp >
void setAlgorithm (const char *name, const Ptr< _Tp > &value)
 
string paramHelp (const string &name) const
 
int paramType (const char *name) const
 
int paramType (const string &name) const
 
void getParams (CV_OUT vector< string > &names) const
 
virtual void write (FileStorage &fs) const
 
virtual void read (const FileNode &fn)
 
- Public Member Functions inherited from cv::DescriptorExtractor
virtual ~DescriptorExtractor ()
 
void compute (const Mat &image, CV_OUT CV_IN_OUT vector< KeyPoint > &keypoints, CV_OUT Mat &descriptors) const
 
void compute (const vector< Mat > &images, vector< vector< KeyPoint > > &keypoints, vector< Mat > &descriptors) const
 
virtual bool empty () const
 

Protected Member Functions

void computeImpl (const Mat &image, vector< KeyPoint > &keypoints, Mat &descriptors) const
 
void detectImpl (const Mat &image, vector< KeyPoint > &keypoints, const Mat &mask=Mat()) const
 

Protected Attributes

int nfeatures
 
double scaleFactor
 
int nlevels
 
int edgeThreshold
 
int firstLevel
 
int WTA_K
 
int scoreType
 
int patchSize
 

Additional Inherited Members

- Static Public Member Functions inherited from cv::Feature2D
static Ptr< Feature2Dcreate (const string &name)
 
- Static Public Member Functions inherited from cv::FeatureDetector
static Ptr< FeatureDetectorcreate (const string &detectorType)
 
- Static Public Member Functions inherited from cv::Algorithm
static void getList (CV_OUT vector< string > &algorithms)
 
static Ptr< Algorithm_create (const string &name)
 
template<typename _Tp >
static Ptr< _Tp > create (const string &name)
 
- Static Public Member Functions inherited from cv::DescriptorExtractor
static Ptr< DescriptorExtractorcreate (const string &descriptorExtractorType)
 
- Static Protected Member Functions inherited from cv::FeatureDetector
static void removeInvalidPoints (const Mat &mask, vector< KeyPoint > &keypoints)
 
- Static Protected Member Functions inherited from cv::DescriptorExtractor
static void removeBorderKeypoints (vector< KeyPoint > &keypoints, Size imageSize, int borderSize)
 

Detailed Description

ORB implementation.

Member Enumeration Documentation

anonymous enum
Enumerator
kBytes 
HARRIS_SCORE 
FAST_SCORE 

Constructor & Destructor Documentation

cv::ORB::ORB ( int  nfeatures = 500,
float  scaleFactor = 1.2f,
int  nlevels = 8,
int  edgeThreshold = 31,
int  firstLevel = 0,
int  WTA_K = 2,
int  scoreType = ORB::HARRIS_SCORE,
int  patchSize = 31 
)
explicit

Member Function Documentation

void cv::ORB::computeImpl ( const Mat image,
vector< KeyPoint > &  keypoints,
Mat descriptors 
) const
protectedvirtual
int cv::ORB::descriptorSize ( ) const
virtual
int cv::ORB::descriptorType ( ) const
virtual
void cv::ORB::detectImpl ( const Mat image,
vector< KeyPoint > &  keypoints,
const Mat mask = Mat() 
) const
protectedvirtual

Implements cv::FeatureDetector.

AlgorithmInfo* cv::ORB::info ( ) const
virtual

Reimplemented from cv::Algorithm.

void cv::ORB::operator() ( InputArray  image,
InputArray  mask,
vector< KeyPoint > &  keypoints 
) const
void cv::ORB::operator() ( InputArray  image,
InputArray  mask,
vector< KeyPoint > &  keypoints,
OutputArray  descriptors,
bool  useProvidedKeypoints = false 
) const

Member Data Documentation

int cv::ORB::edgeThreshold
protected
int cv::ORB::firstLevel
protected
int cv::ORB::nfeatures
protected
int cv::ORB::nlevels
protected
int cv::ORB::patchSize
protected
double cv::ORB::scaleFactor
protected
int cv::ORB::scoreType
protected
int cv::ORB::WTA_K
protected

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