This is a base class for all more or less complex algorithms in OpenCV. More...
#include <opencv2/core.hpp>
Public Member Functions | |
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 | read (const FileNode &fn) |
Reads algorithm parameters from a file storage. | |
virtual void | save (const String &filename) const |
void | write (const Ptr< FileStorage > &fs, const String &name=String()) const |
virtual void | write (FileStorage &fs) const |
Stores algorithm parameters in a file storage. | |
void | write (FileStorage &fs, const String &name) const |
Static Public Member Functions | |
template<typename _Tp > | |
static Ptr< _Tp > | load (const String &filename, const String &objname=String()) |
Loads algorithm from the file. | |
template<typename _Tp > | |
static Ptr< _Tp > | loadFromString (const String &strModel, const String &objname=String()) |
Loads algorithm from a String. | |
template<typename _Tp > | |
static Ptr< _Tp > | read (const FileNode &fn) |
Reads algorithm from the file node. | |
Protected Member Functions | |
void | writeFormat (FileStorage &fs) const |
Detailed Description
This is a base class for all more or less complex algorithms in OpenCV.
especially for classes of algorithms, for which there can be multiple implementations. The examples are stereo correspondence (for which there are algorithms like block matching, semi-global block matching, graph-cut etc.), background subtraction (which can be done using mixture-of-gaussians models, codebook-based algorithm etc.), optical flow (block matching, Lucas-Kanade, Horn-Schunck etc.).
Here is example of SimpleBlobDetector use in your application via Algorithm interface:
Constructor & Destructor Documentation
◆ Algorithm()
cv::Algorithm::Algorithm | ( | ) |
◆ ~Algorithm()
|
virtual |
Member Function Documentation
◆ clear()
|
inlinevirtual |
Clears the algorithm state.
Reimplemented in cv::DescriptorMatcher, cv::FlannBasedMatcher, cv::line_descriptor::BinaryDescriptorMatcher, cv::quality::QualityBase, cv::quality::QualityGMSD, cv::quality::QualityMSE, cv::quality::QualityPSNR, cv::quality::QualitySSIM, and cv::cuda::DescriptorMatcher.
◆ empty()
|
inlinevirtual |
Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read.
Reimplemented in cv::cuda::DescriptorMatcher, cv::Feature2D, cv::DescriptorMatcher, cv::ml::StatModel, cv::face::BasicFaceRecognizer, cv::quality::QualityBase, cv::quality::QualityGMSD, cv::quality::QualityMSE, cv::quality::QualityPSNR, cv::quality::QualitySSIM, cv::BaseCascadeClassifier, and cv::face::FaceRecognizer.
◆ getDefaultName()
|
virtual |
Returns the algorithm string identifier. This string is used as top level xml/yml node tag when the object is saved to a file or string.
Reimplemented in cv::Feature2D, cv::AffineFeature, cv::SIFT, cv::BRISK, cv::ORB, cv::MSER, cv::FastFeatureDetector, cv::AgastFeatureDetector, cv::GFTTDetector, cv::SimpleBlobDetector, cv::KAZE, cv::AKAZE, cv::xfeatures2d::FREAK, cv::xfeatures2d::StarDetector, cv::xfeatures2d::BriefDescriptorExtractor, cv::xfeatures2d::LUCID, cv::xfeatures2d::LATCH, cv::xfeatures2d::BEBLID, cv::xfeatures2d::TEBLID, cv::xfeatures2d::DAISY, cv::xfeatures2d::MSDDetector, cv::xfeatures2d::VGG, cv::xfeatures2d::BoostDesc, cv::xfeatures2d::HarrisLaplaceFeatureDetector, and cv::xfeatures2d::SURF.
◆ load()
|
inlinestatic |
Loads algorithm from the file.
- Parameters
-
filename Name of the file to read. objname The optional name of the node to read (if empty, the first top-level node will be used)
This is static template method of Algorithm. It's usage is following (in the case of SVM):
In order to make this method work, the derived class must overwrite Algorithm::read(const FileNode& fn).
◆ loadFromString()
|
inlinestatic |
Loads algorithm from a String.
- Parameters
-
strModel The string variable containing the model you want to load. objname The optional name of the node to read (if empty, the first top-level node will be used)
This is static template method of Algorithm. It's usage is following (in the case of SVM):
◆ read() [1/2]
|
inlinevirtual |
Reads algorithm parameters from a file storage.
Reimplemented in cv::line_descriptor::BinaryDescriptor, cv::Feature2D, cv::DescriptorMatcher, cv::FlannBasedMatcher, cv::face::BasicFaceRecognizer, cv::optflow::GPCTree, cv::optflow::GPCForest< T >, cv::saliency::StaticSaliencySpectralResidual, cv::face::FaceRecognizer, cv::face::BasicFaceRecognizer, cv::legacy::Tracker, and cv::aruco::ArucoDetector.
◆ read() [2/2]
Reads algorithm from the file node.
This is static template method of Algorithm. It's usage is following (in the case of SVM):
In order to make this method work, the derived class must overwrite Algorithm::read(const FileNode& fn) and also have static create() method without parameters (or with all the optional parameters)
◆ save()
|
virtual |
Saves the algorithm to a file. In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).
◆ write() [1/3]
void cv::Algorithm::write | ( | const Ptr< FileStorage > & | fs, |
const String & | name = String() |
||
) | const |
◆ write() [2/3]
|
inlinevirtual |
Stores algorithm parameters in a file storage.
Reimplemented in cv::line_descriptor::BinaryDescriptor, cv::bioinspired::TransientAreasSegmentationModule, cv::Feature2D, cv::DescriptorMatcher, cv::FlannBasedMatcher, cv::face::BasicFaceRecognizer, cv::optflow::GPCTree, cv::optflow::GPCForest< T >, cv::saliency::StaticSaliencySpectralResidual, cv::bioinspired::Retina, cv::face::FaceRecognizer, cv::face::BasicFaceRecognizer, cv::legacy::Tracker, and cv::aruco::ArucoDetector.
◆ write() [3/3]
void cv::Algorithm::write | ( | FileStorage & | fs, |
const String & | name | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
◆ writeFormat()
|
protected |
The documentation for this class was generated from the following file:
- opencv2/core.hpp