cv::Algorithm クラス

This is a base class for all more or less complex algorithms in OpenCV [詳解]

#include <core.hpp>

cv::AlignExposures, cv::BackgroundSubtractor, cv::BaseCascadeClassifier, cv::CLAHE, cv::CalibrateCRF, cv::DenseOpticalFlow, cv::DescriptorMatcher, cv::Feature2D [virtual], cv::GeneralizedHough, cv::HistogramCostExtractor, cv::LMSolver, cv::LineSegmentDetector, cv::MergeExposures, cv::MinProblemSolver, cv::ShapeDistanceExtractor, cv::ShapeTransformer, cv::SparseOpticalFlow, cv::StereoMatcher, cv::Tonemap, cv::bioinspired::Retina, cv::bioinspired::RetinaFastToneMapping, cv::bioinspired::TransientAreasSegmentationModule, cv::ccalib::CustomPattern, cv::dnn::Layer, cv::face::BIF, cv::face::FaceRecognizer, cv::face::Facemark [virtual], cv::face::MACE, cv::hfs::HfsSegment, cv::img_hash::ImgHashBase, cv::legacy::tracking::MultiTracker, cv::legacy::tracking::Tracker [virtual], cv::line_descriptor::BinaryDescriptor, cv::line_descriptor::BinaryDescriptorMatcher, cv::line_descriptor::LSDDetector, cv::mcc::CCheckerDetector, cv::optflow::GPCForest< T >, cv::optflow::GPCTree, cv::phase_unwrapping::PhaseUnwrapping [virtual], cv::quality::QualityBase [virtual], cv::rapid::Tracker, cv::rgbd::DepthCleaner, cv::rgbd::Odometry, cv::rgbd::RgbdNormals, cv::rgbd::RgbdPlane, cv::saliency::Saliency [virtual], cv::stereo::StereoMatcher, cv::structured_light::StructuredLightPattern [virtual], cv::superres::DenseOpticalFlowExt, cv::superres::SuperResolution, cv::text::ERFilter, cv::xfeatures2d::PCTSignatures, cv::xfeatures2d::PCTSignaturesSQFD, cv::ximgproc::ContourFitting, cv::ximgproc::EdgeBoxes, cv::ximgproc::EdgeDrawing, cv::ximgproc::FastLineDetector, cv::ximgproc::RidgeDetectionFilter, cv::ximgproc::segmentation::GraphSegmentation, cv::ximgproc::segmentation::SelectiveSearchSegmentation, cv::ximgproc::segmentation::SelectiveSearchSegmentationStrategy, cv::xphoto::WhiteBalancer (計62項目)に継承されています。

公開メンバ関数
virtual CV_WRAP void	clear ()
	Clears the algorithm state [詳解]
virtual void	write (FileStorage &fs) const
	Stores algorithm parameters in a file storage [詳解]
CV_WRAP void	write (const Ptr< FileStorage > &fs, const String &name=String()) const
	simplified API for language bindings これはオーバーロードされたメンバ関数です。利便性のために用意されています。元の関数との違いは引き数のみです。
virtual CV_WRAP void	read (const FileNode &fn)
	Reads algorithm parameters from a file storage [詳解]
virtual CV_WRAP bool	empty () const
	Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read [詳解]
virtual CV_WRAP void	save (const String &filename) const
virtual CV_WRAP String	getDefaultName () const

静的公開メンバ関数
template<typename _Tp >
static Ptr< _Tp >	read (const FileNode &fn)
	Reads algorithm from the file node [詳解]
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 [詳解]

限定公開メンバ関数
void	writeFormat (FileStorage &fs) const

詳解

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:

関数詳解

clear()

virtual CV_WRAP void cv::Algorithm::clear ( )

inlinevirtual

Clears the algorithm state

cv::DescriptorMatcher, cv::line_descriptor::BinaryDescriptorMatcher, cv::quality::QualityBase, cv::quality::QualityGMSD, cv::quality::QualityMSE, cv::quality::QualityPSNR, cv::quality::QualitySSIMで再実装されています。

empty()

virtual CV_WRAP bool cv::Algorithm::empty ( ) const

inlinevirtual

Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read

cv::face::BasicFaceRecognizer, cv::Feature2D, cv::DescriptorMatcher, cv::quality::QualityBase, cv::quality::QualityGMSD, cv::quality::QualityMSE, cv::quality::QualityPSNR, cv::quality::QualitySSIM, cv::face::FaceRecognizer, cv::BaseCascadeClassifierで再実装されています。

getDefaultName()

virtual CV_WRAP String cv::Algorithm::getDefaultName ( ) const

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.

cv::Feature2D, cv::AffineFeature, cv::SIFT, cv::BRISK, cv::ORB, cv::MSER, cv::FastFeatureDetector, cv::AgastFeatureDetector, cv::GFTTDetector, cv::SimpleBlobDetector, cv::KAZE, cv::AKAZEで再実装されています。

load()

template<typename _Tp >

static Ptr< _Tp > cv::Algorithm::load ( const String &  filename, const String &  objname = String()  )

inlinestatic

Loads algorithm from the file

引数

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):

Ptr<SVM> svm = Algorithm::load<SVM>("my_svm_model.xml");

In order to make this method work, the derived class must overwrite Algorithm::read(const FileNode& fn).

loadFromString()

template<typename _Tp >

static Ptr< _Tp > cv::Algorithm::loadFromString ( const String &  strModel, const String &  objname = String()  )

inlinestatic

Loads algorithm from a String

引数

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):

Ptr<SVM> svm = Algorithm::loadFromString<SVM>(myStringModel);

read() [1/2]

virtual CV_WRAP void cv::Algorithm::read ( const FileNode &  fn )

inlinevirtual

Reads algorithm parameters from a file storage

cv::line_descriptor::BinaryDescriptor, cv::Feature2D, cv::DescriptorMatcher, cv::face::BasicFaceRecognizer, cv::optflow::GPCTree, cv::optflow::GPCForest< T >, cv::saliency::StaticSaliencySpectralResidual, cv::face::FaceRecognizer, cv::face::BasicFaceRecognizer, cv::legacy::tracking::Trackerで再実装されています。

read() [2/2]

template<typename _Tp >

static Ptr< _Tp > cv::Algorithm::read ( const FileNode &  fn )

inlinestatic

Reads algorithm from the file node

This is static template method of Algorithm. It's usage is following (in the case of SVM):

cv::FileStorage fsRead("example.xml", FileStorage::READ);
Ptr<SVM> svm = Algorithm::read<SVM>(fsRead.root());

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 CV_WRAP void cv::Algorithm::save ( const String &  filename ) const

virtual

Saves the algorithm to a file. In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).

write()

virtual void cv::Algorithm::write ( FileStorage &  fs ) const

inlinevirtual

Stores algorithm parameters in a file storage

cv::line_descriptor::BinaryDescriptor, cv::bioinspired::TransientAreasSegmentationModule, cv::Feature2D, cv::DescriptorMatcher, cv::face::BasicFaceRecognizer, cv::optflow::GPCTree, cv::optflow::GPCForest< T >, cv::saliency::StaticSaliencySpectralResidual, cv::bioinspired::Retina, cv::face::FaceRecognizer, cv::face::BasicFaceRecognizer, cv::legacy::tracking::Trackerで再実装されています。

---

このクラス詳解は次のファイルから抽出されました:

• core.hpp