Commit 8e53eb5c authored by Maria Dimashova's avatar Maria Dimashova

minor changes of feature2d documentation

parent b251136e
...@@ -1236,7 +1236,7 @@ protected: ...@@ -1236,7 +1236,7 @@ protected:
Detect keypoints in an image. Detect keypoints in an image.
\cvdefCpp{ \cvdefCpp{
void detect( const Mat\& image, vector<KeyPoint>\& keypoints, const Mat\& mask=Mat() ) const; void FeatureDetector::detect( const Mat\& image, vector<KeyPoint>\& keypoints, const Mat\& mask=Mat() ) const;
} }
\begin{description} \begin{description}
...@@ -1249,7 +1249,7 @@ void detect( const Mat\& image, vector<KeyPoint>\& keypoints, const Mat\& mask=M ...@@ -1249,7 +1249,7 @@ void detect( const Mat\& image, vector<KeyPoint>\& keypoints, const Mat\& mask=M
Read feature detector from file node. Read feature detector from file node.
\cvdefCpp{ \cvdefCpp{
void read( const FileNode\& fn ); void FeatureDetector::read( const FileNode\& fn );
} }
\begin{description} \begin{description}
...@@ -1260,7 +1260,7 @@ void read( const FileNode\& fn ); ...@@ -1260,7 +1260,7 @@ void read( const FileNode\& fn );
Write feature detector to file storage. Write feature detector to file storage.
\cvdefCpp{ \cvdefCpp{
void write( FileStorage\& fs ) const; void FeatureDetector::write( FileStorage\& fs ) const;
} }
\begin{description} \begin{description}
...@@ -1409,7 +1409,7 @@ descriptors as a \cvCppCross{Mat}, where each row is one keypoint descriptor. ...@@ -1409,7 +1409,7 @@ descriptors as a \cvCppCross{Mat}, where each row is one keypoint descriptor.
Compute the descriptors for a set of keypoints in an image. Must be implemented by the subclass. Compute the descriptors for a set of keypoints in an image. Must be implemented by the subclass.
\cvdefCpp{ \cvdefCpp{
void compute( const Mat\& image, vector<KeyPoint>\& keypoints, Mat\& descriptors ) const; void DescriptorExtractor::compute( const Mat\& image, vector<KeyPoint>\& keypoints, Mat\& descriptors ) const;
} }
\begin{description} \begin{description}
...@@ -1422,7 +1422,7 @@ void compute( const Mat\& image, vector<KeyPoint>\& keypoints, Mat\& descriptors ...@@ -1422,7 +1422,7 @@ void compute( const Mat\& image, vector<KeyPoint>\& keypoints, Mat\& descriptors
Read descriptor extractor from file node. Read descriptor extractor from file node.
\cvdefCpp{ \cvdefCpp{
void read( const FileNode\& fn ); void DescriptorExtractor::read( const FileNode\& fn );
} }
\begin{description} \begin{description}
...@@ -1433,7 +1433,7 @@ void read( const FileNode\& fn ); ...@@ -1433,7 +1433,7 @@ void read( const FileNode\& fn );
Write descriptor extractor to file storage. Write descriptor extractor to file storage.
\cvdefCpp{ \cvdefCpp{
void write( FileStorage\& fs ) const; void DescriptorExtractor::write( FileStorage\& fs ) const;
} }
\begin{description} \begin{description}
...@@ -1454,7 +1454,9 @@ public: ...@@ -1454,7 +1454,9 @@ public:
int nOctaveLayers=SIFT::CommonParams::DEFAULT_NOCTAVE_LAYERS, int nOctaveLayers=SIFT::CommonParams::DEFAULT_NOCTAVE_LAYERS,
int firstOctave=SIFT::CommonParams::DEFAULT_FIRST_OCTAVE, int firstOctave=SIFT::CommonParams::DEFAULT_FIRST_OCTAVE,
int angleMode=SIFT::CommonParams::FIRST_ANGLE ); int angleMode=SIFT::CommonParams::FIRST_ANGLE );
virtual void compute( const Mat& image, vector<KeyPoint>& keypoints, Mat& descriptors) const; virtual void compute( const Mat& image, vector<KeyPoint>& keypoints, Mat& descriptors) const;
virtual void read (const FileNode &fn); virtual void read (const FileNode &fn);
virtual void write (FileStorage &fs) const; virtual void write (FileStorage &fs) const;
protected: protected:
...@@ -1471,7 +1473,9 @@ class SurfDescriptorExtractor : public DescriptorExtractor ...@@ -1471,7 +1473,9 @@ class SurfDescriptorExtractor : public DescriptorExtractor
public: public:
SurfDescriptorExtractor( int nOctaves=4, SurfDescriptorExtractor( int nOctaves=4,
int nOctaveLayers=2, bool extended=false ); int nOctaveLayers=2, bool extended=false );
virtual void compute( const Mat& image, vector<KeyPoint>& keypoints, Mat& descriptors) const; virtual void compute( const Mat& image, vector<KeyPoint>& keypoints, Mat& descriptors) const;
virtual void read (const FileNode &fn); virtual void read (const FileNode &fn);
virtual void write (FileStorage &fs) const; virtual void write (FileStorage &fs) const;
...@@ -1503,7 +1507,7 @@ protected: ...@@ -1503,7 +1507,7 @@ protected:
Add descriptors to the training set. Add descriptors to the training set.
\cvdefCpp{ \cvdefCpp{
void add( const Mat\& descriptors ); void DescriptorMatcher::add( const Mat\& descriptors );
} }
\begin{description} \begin{description}
...@@ -1516,10 +1520,10 @@ of this method the mask is used to describe which descriptors can be matched. ...@@ -1516,10 +1520,10 @@ of this method the mask is used to describe which descriptors can be matched.
\texttt{descriptors\_1[i]} can be matched with \texttt{descriptors\_2[j]} only if \texttt{mask.at<char>(i,j)} is non-zero. \texttt{descriptors\_1[i]} can be matched with \texttt{descriptors\_2[j]} only if \texttt{mask.at<char>(i,j)} is non-zero.
\cvdefCpp{ \cvdefCpp{
void match( const Mat\& query, vector<int>\& matches ) const; void DescriptorMatcher::match( const Mat\& query, vector<int>\& matches ) const;
} }
\cvdefCpp{ \cvdefCpp{
void match( const Mat\& query, const Mat\& mask, void DescriptorMatcher::match( const Mat\& query, const Mat\& mask,
vector<int>\& matches ) const; vector<int>\& matches ) const;
} }
...@@ -1533,7 +1537,7 @@ void match( const Mat\& query, const Mat\& mask, ...@@ -1533,7 +1537,7 @@ void match( const Mat\& query, const Mat\& mask,
Clear training keypoints. Clear training keypoints.
\cvdefCpp{ \cvdefCpp{
void clear(); void DescriptorMatcher::clear();
} }
\cvclass{BruteForceMatcher} \cvclass{BruteForceMatcher}
...@@ -1546,6 +1550,7 @@ class BruteForceMatcher : public DescriptorMatcher ...@@ -1546,6 +1550,7 @@ class BruteForceMatcher : public DescriptorMatcher
{ {
public: public:
BruteForceMatcher( Distance d = Distance() ) : distance(d) {} BruteForceMatcher( Distance d = Distance() ) : distance(d) {}
protected: protected:
... ...
} }
...@@ -1654,7 +1659,7 @@ Adds keypoints to the training set (descriptors are supposed to be calculated he ...@@ -1654,7 +1659,7 @@ Adds keypoints to the training set (descriptors are supposed to be calculated he
Keypoints can be passed using \cvCppCross{KeyPointCollection} (with with corresponding images) or as a vector of \cvCppCross{KeyPoint} from a single image. Keypoints can be passed using \cvCppCross{KeyPointCollection} (with with corresponding images) or as a vector of \cvCppCross{KeyPoint} from a single image.
\cvdefCpp{ \cvdefCpp{
void add( KeyPointCollection\& keypoints ); void GenericDescriptorMatch::add( KeyPointCollection\& keypoints );
} }
\begin{description} \begin{description}
...@@ -1663,7 +1668,7 @@ void add( KeyPointCollection\& keypoints ); ...@@ -1663,7 +1668,7 @@ void add( KeyPointCollection\& keypoints );
\cvdefCpp{ \cvdefCpp{
void add( const Mat\& image, vector<KeyPoint>\& points ); void GenericDescriptorMatch::add( const Mat\& image, vector<KeyPoint>\& points );
} }
\begin{description} \begin{description}
...@@ -1675,7 +1680,7 @@ void add( const Mat\& image, vector<KeyPoint>\& points ); ...@@ -1675,7 +1680,7 @@ void add( const Mat\& image, vector<KeyPoint>\& points );
Classifies test keypoints. Classifies test keypoints.
\cvdefCpp{ \cvdefCpp{
void classify( const Mat\& image, vector<KeyPoint>\& points ); void GenericDescriptorMatch::classify( const Mat\& image, vector<KeyPoint>\& points );
} }
\begin{description} \begin{description}
...@@ -1687,7 +1692,7 @@ void classify( const Mat\& image, vector<KeyPoint>\& points ); ...@@ -1687,7 +1692,7 @@ void classify( const Mat\& image, vector<KeyPoint>\& points );
Matches test keypoints to the training set. Matches test keypoints to the training set.
\cvdefCpp{ \cvdefCpp{
void match( const Mat\& image, vector<KeyPoint>\& points, vector<int>\& indices ); void GenericDescriptorMatch::match( const Mat\& image, vector<KeyPoint>\& points, vector<int>\& indices );
} }
\begin{description} \begin{description}
...@@ -1700,21 +1705,21 @@ void match( const Mat\& image, vector<KeyPoint>\& points, vector<int>\& indices ...@@ -1700,21 +1705,21 @@ void match( const Mat\& image, vector<KeyPoint>\& points, vector<int>\& indices
Clears keypoints storing in collection Clears keypoints storing in collection
\cvdefCpp{ \cvdefCpp{
void clear(); void GenericDescriptorMatch::clear();
} }
\cvCppFunc{GenericDescriptorMatch::read} \cvCppFunc{GenericDescriptorMatch::read}
Reads match object from a file node Reads match object from a file node
\cvdefCpp{ \cvdefCpp{
void read( const FileNode\& fn ); void GenericDescriptorMatch::read( const FileNode\& fn );
} }
\cvCppFunc{GenericDescriptorMatch::write} \cvCppFunc{GenericDescriptorMatch::write}
Writes match object to a file storage Writes match object to a file storage
\cvdefCpp{ \cvdefCpp{
virtual void write( FileStorage\& fs ) const; void GenericDescriptorMatch::write( FileStorage\& fs ) const;
} }
\cvclass{VectorDescriptorMatch} \cvclass{VectorDescriptorMatch}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment