Class implements both functionalities for detection of lines and computation of their binary descriptor.
More...
#include <opencv2/line_descriptor/descriptor.hpp>
|
| BinaryDescriptor (const BinaryDescriptor::Params ¶meters=BinaryDescriptor::Params()) |
| Constructor.
|
|
| ~BinaryDescriptor () |
|
void | compute (const Mat &image, std::vector< KeyLine > &keylines, Mat &descriptors, bool returnFloatDescr=false) const |
| Requires descriptors computation.
|
|
void | compute (const std::vector< Mat > &images, std::vector< std::vector< KeyLine > > &keylines, std::vector< Mat > &descriptors, bool returnFloatDescr=false) const |
|
int | defaultNorm () const |
|
int | descriptorSize () const |
| Return descriptor size.
|
|
int | descriptorType () const |
| Return data type.
|
|
void | detect (const Mat &image, std::vector< KeyLine > &keypoints, const Mat &mask=Mat()) |
| Requires line detection.
|
|
void | detect (const std::vector< Mat > &images, std::vector< std::vector< KeyLine > > &keylines, const std::vector< Mat > &masks=std::vector< Mat >()) const |
|
int | getNumOfOctaves () |
| Get current number of octaves.
|
|
int | getReductionRatio () |
| Get current reduction ratio (used in Gaussian pyramids)
|
|
int | getWidthOfBand () |
| Get current width of bands.
|
|
virtual void | operator() (InputArray image, InputArray mask, std::vector< KeyLine > &keylines, OutputArray descriptors, bool useProvidedKeyLines=false, bool returnFloatDescr=false) const |
| Define operator '()' to perform detection of KeyLines and computation of descriptors in a row.
|
|
virtual void | read (const cv::FileNode &fn) CV_OVERRIDE |
| Read parameters from a FileNode object and store them.
|
|
void | setNumOfOctaves (int octaves) |
| Set number of octaves.
|
|
void | setReductionRatio (int rRatio) |
| Set reduction ratio (used in Gaussian pyramids)
|
|
void | setWidthOfBand (int width) |
| Set width of bands.
|
|
virtual void | write (cv::FileStorage &fs) const CV_OVERRIDE |
| Store parameters to a FileStorage object.
|
|
| Algorithm () |
|
virtual | ~Algorithm () |
|
virtual void | clear () |
| Clears the algorithm state.
|
|
virtual bool | empty () const |
| Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read.
|
|
virtual String | getDefaultName () const |
|
virtual void | save (const String &filename) const |
|
void | write (const Ptr< FileStorage > &fs, const String &name=String()) const |
|
void | write (FileStorage &fs, const String &name) const |
|
Class implements both functionalities for detection of lines and computation of their binary descriptor.
Class' interface is mainly based on the ones of classical detectors and extractors, such as Feature2d's Feature Detection and Description and Descriptor Matchers. Retrieved information about lines is stored in line_descriptor::KeyLine objects.
◆ BinaryDescriptor()
Constructor.
- Parameters
-
If no argument is provided, constructor sets default values (see comments in the code snippet in previous section). Default values are strongly recommended.
◆ ~BinaryDescriptor()
cv::line_descriptor::BinaryDescriptor::~BinaryDescriptor |
( |
| ) |
|
◆ compute() [1/2]
void cv::line_descriptor::BinaryDescriptor::compute |
( |
const Mat & |
image, |
|
|
std::vector< KeyLine > & |
keylines, |
|
|
Mat & |
descriptors, |
|
|
bool |
returnFloatDescr = false |
|
) |
| const |
Python: |
---|
| cv.line_descriptor.BinaryDescriptor.compute( | image, keylines[, descriptors[, returnFloatDescr]] | ) -> | keylines, descriptors |
Requires descriptors computation.
- Parameters
-
image | input image |
keylines | vector containing lines for which descriptors must be computed |
descriptors | |
returnFloatDescr | flag (when set to true, original non-binary descriptors are returned) |
◆ compute() [2/2]
void cv::line_descriptor::BinaryDescriptor::compute |
( |
const std::vector< Mat > & |
images, |
|
|
std::vector< std::vector< KeyLine > > & |
keylines, |
|
|
std::vector< Mat > & |
descriptors, |
|
|
bool |
returnFloatDescr = false |
|
) |
| const |
Python: |
---|
| cv.line_descriptor.BinaryDescriptor.compute( | image, keylines[, descriptors[, returnFloatDescr]] | ) -> | keylines, descriptors |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
- Parameters
-
images | input images |
keylines | set of vectors containing lines for which descriptors must be computed |
descriptors | |
returnFloatDescr | flag (when set to true, original non-binary descriptors are returned) |
◆ computeImpl()
virtual void cv::line_descriptor::BinaryDescriptor::computeImpl |
( |
const Mat & |
imageSrc, |
|
|
std::vector< KeyLine > & |
keylines, |
|
|
Mat & |
descriptors, |
|
|
bool |
returnFloatDescr, |
|
|
bool |
useDetectionData |
|
) |
| const |
|
protectedvirtual |
implementation of descriptors' computation
◆ createBinaryDescriptor() [1/2]
static Ptr< BinaryDescriptor > cv::line_descriptor::BinaryDescriptor::createBinaryDescriptor |
( |
| ) |
|
|
static |
Python: |
---|
| cv.line_descriptor.BinaryDescriptor.createBinaryDescriptor( | | ) -> | retval |
| cv.line_descriptor.BinaryDescriptor_createBinaryDescriptor( | | ) -> | retval |
Create a BinaryDescriptor object with default parameters (or with the ones provided) and return a smart pointer to it.
◆ createBinaryDescriptor() [2/2]
Python: |
---|
| cv.line_descriptor.BinaryDescriptor.createBinaryDescriptor( | | ) -> | retval |
| cv.line_descriptor.BinaryDescriptor_createBinaryDescriptor( | | ) -> | retval |
◆ defaultNorm()
int cv::line_descriptor::BinaryDescriptor::defaultNorm |
( |
| ) |
const |
◆ descriptorSize()
int cv::line_descriptor::BinaryDescriptor::descriptorSize |
( |
| ) |
const |
◆ descriptorType()
int cv::line_descriptor::BinaryDescriptor::descriptorType |
( |
| ) |
const |
◆ detect() [1/2]
void cv::line_descriptor::BinaryDescriptor::detect |
( |
const Mat & |
image, |
|
|
std::vector< KeyLine > & |
keypoints, |
|
|
const Mat & |
mask = Mat() |
|
) |
| |
Python: |
---|
| cv.line_descriptor.BinaryDescriptor.detect( | image[, mask] | ) -> | keypoints |
Requires line detection.
- Parameters
-
image | input image |
keypoints | vector that will store extracted lines for one or more images |
mask | mask matrix to detect only KeyLines of interest |
◆ detect() [2/2]
void cv::line_descriptor::BinaryDescriptor::detect |
( |
const std::vector< Mat > & |
images, |
|
|
std::vector< std::vector< KeyLine > > & |
keylines, |
|
|
const std::vector< Mat > & |
masks = std::vector< Mat >() |
|
) |
| const |
Python: |
---|
| cv.line_descriptor.BinaryDescriptor.detect( | image[, mask] | ) -> | keypoints |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
- Parameters
-
images | input images |
keylines | set of vectors that will store extracted lines for one or more images |
masks | vector of mask matrices to detect only KeyLines of interest from each input image |
◆ detectImpl()
virtual void cv::line_descriptor::BinaryDescriptor::detectImpl |
( |
const Mat & |
imageSrc, |
|
|
std::vector< KeyLine > & |
keylines, |
|
|
const Mat & |
mask = Mat() |
|
) |
| const |
|
protectedvirtual |
implementation of line detection
◆ getNumOfOctaves()
int cv::line_descriptor::BinaryDescriptor::getNumOfOctaves |
( |
| ) |
|
Python: |
---|
| cv.line_descriptor.BinaryDescriptor.getNumOfOctaves( | | ) -> | retval |
Get current number of octaves.
◆ getReductionRatio()
int cv::line_descriptor::BinaryDescriptor::getReductionRatio |
( |
| ) |
|
Python: |
---|
| cv.line_descriptor.BinaryDescriptor.getReductionRatio( | | ) -> | retval |
Get current reduction ratio (used in Gaussian pyramids)
◆ getWidthOfBand()
int cv::line_descriptor::BinaryDescriptor::getWidthOfBand |
( |
| ) |
|
Python: |
---|
| cv.line_descriptor.BinaryDescriptor.getWidthOfBand( | | ) -> | retval |
Get current width of bands.
◆ operator()()
virtual void cv::line_descriptor::BinaryDescriptor::operator() |
( |
InputArray |
image, |
|
|
InputArray |
mask, |
|
|
std::vector< KeyLine > & |
keylines, |
|
|
OutputArray |
descriptors, |
|
|
bool |
useProvidedKeyLines = false , |
|
|
bool |
returnFloatDescr = false |
|
) |
| const |
|
virtual |
Define operator '()' to perform detection of KeyLines and computation of descriptors in a row.
- Parameters
-
image | input image |
mask | mask matrix to select which lines in KeyLines must be accepted among the ones extracted (used when keylines is not empty) |
keylines | vector that contains input lines (when filled, the detection part will be skipped and input lines will be passed as input to the algorithm computing descriptors) |
descriptors | matrix that will store final descriptors |
useProvidedKeyLines | flag (when set to true, detection phase will be skipped and only computation of descriptors will be executed, using lines provided in keylines) |
returnFloatDescr | flag (when set to true, original non-binary descriptors are returned) |
◆ read()
virtual void cv::line_descriptor::BinaryDescriptor::read |
( |
const cv::FileNode & |
fn | ) |
|
|
virtual |
◆ setNumOfOctaves()
void cv::line_descriptor::BinaryDescriptor::setNumOfOctaves |
( |
int |
octaves | ) |
|
Python: |
---|
| cv.line_descriptor.BinaryDescriptor.setNumOfOctaves( | octaves | ) -> | None |
Set number of octaves.
- Parameters
-
◆ setReductionRatio()
void cv::line_descriptor::BinaryDescriptor::setReductionRatio |
( |
int |
rRatio | ) |
|
Python: |
---|
| cv.line_descriptor.BinaryDescriptor.setReductionRatio( | rRatio | ) -> | None |
Set reduction ratio (used in Gaussian pyramids)
- Parameters
-
◆ setWidthOfBand()
void cv::line_descriptor::BinaryDescriptor::setWidthOfBand |
( |
int |
width | ) |
|
Python: |
---|
| cv.line_descriptor.BinaryDescriptor.setWidthOfBand( | width | ) -> | None |
Set width of bands.
- Parameters
-
◆ write()
virtual void cv::line_descriptor::BinaryDescriptor::write |
( |
cv::FileStorage & |
fs | ) |
const |
|
virtual |
The documentation for this class was generated from the following file: