cv::Algorithm クラス

これはOpenCVのある程度複雑なすべてのアルゴリズムの基底クラスである。詳細...

#include <opencv2/core.hpp>

Collaboration diagram for cv::Algorithm:

公開メンバ関数
	Algorithm ()
virtual	~Algorithm ()
virtual void	clear ()
	アルゴリズムの状態をクリアする。
virtual bool	empty () const
	Algorithm が空の場合（たとえば開始直後や読み込みに失敗した後）に true を返す。
virtual String	getDefaultName () const
virtual void	read (const FileNode &fn)
	ファイルストレージからアルゴリズムの引数を読み込む。
virtual void	save (const String &filename) const
void	write (const Ptr< FileStorage > &fs, const String &name=String()) const
virtual void	write (FileStorage &fs) const
	アルゴリズムの引数をファイルストレージに保存する。
void	write (FileStorage &fs, const String &name) const

静的公開メンバ関数
template<typename _Tp >
static Ptr< _Tp >	load (const String &filename, const String &objname=String())
	ファイルからアルゴリズムを読み込む。
template<typename _Tp >
static Ptr< _Tp >	loadFromString (const String &strModel, const String &objname=String())
	文字列からアルゴリズムを読み込む。
template<typename _Tp >
static Ptr< _Tp >	read (const FileNode &fn)
	ファイルノードからアルゴリズムを読み込む。

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

詳細説明

これはOpenCVのある程度複雑なすべてのアルゴリズムの基底クラスである。

特に、複数の実装が存在しうるアルゴリズムのクラスに対して用いられる。例としては、ステレオ対応（ブロックマッチング、セミグローバルブロックマッチング、グラフカットなどのアルゴリズムがある）、背景差分（混合ガウスモデル、コードブックベースのアルゴリズムなどで行える）、オプティカルフロー（ブロックマッチング、Lucas-Kanade、Horn-Schunckなど）が挙げられる。

次に、Algorithm インターフェースを介してアプリケーション内で SimpleBlobDetector を使用する例を示す:

 Ptr<Feature2D> sbd = SimpleBlobDetector::create();
 FileStorage fs_read("SimpleBlobDetector_params.xml", FileStorage::READ);
 
 if (fs_read.isOpened()) // if we have file with parameters, read them
    {
        sbd->read(fs_read.root());
        fs_read.release();
    }
 else // else modify the parameters and store them; user can later edit the file to use different parameters
    {
        fs_read.release();
 FileStorage fs_write("SimpleBlobDetector_params.xml", FileStorage::WRITE);
        sbd->write(fs_write);
        fs_write.release();
    }
 
 Mat result, image = imread("../data/detect_blob.png", IMREAD_COLOR);
    vector<KeyPoint> keypoints;
    sbd->detect(image, keypoints, Mat());
 
 drawKeypoints(image, keypoints, result);
 for (vector<KeyPoint>::iterator k = keypoints.begin(); k != keypoints.end(); ++k)
 circle(result, k->pt, (int)k->size, Scalar(0, 0, 255), 2);
 
 imshow("result", result);
 waitKey(0);

構築子と解体子の詳解

Algorithm()

cv::Algorithm::Algorithm

(

)

~Algorithm()

virtual cv::Algorithm::~Algorithm ( )

virtual

メンバ関数詳解

clear()

virtual void cv::Algorithm::clear ( )

inlinevirtual

Python:
	cv.Algorithm.clear(		) ->	None

アルゴリズムの状態をクリアする。

cv::cuda::DescriptorMatcher、 cv::DescriptorMatcher、 cv::FlannBasedMatcher、 cv::line_descriptor::BinaryDescriptorMatcher、 cv::quality::QualityBase、 cv::quality::QualityGMSD、 cv::quality::QualityMSE、 cv::quality::QualityPSNR、 および cv::quality::QualitySSIM で再実装されている。

empty()

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

inlinevirtual

Python:
	cv.Algorithm.empty(		) ->	retval

Algorithm が空である場合（例えば最初の段階、または読み込みに失敗した後など）に true を返す。

cv::BaseCascadeClassifier、 cv::cuda::DescriptorMatcher、 cv::DescriptorMatcher、 cv::face::BasicFaceRecognizer、 cv::face::FaceRecognizer、 cv::Feature2D、 cv::ml::StatModel、 cv::quality::QualityBase、 cv::quality::QualityGMSD、 cv::quality::QualityMSE、 cv::quality::QualityPSNR、 および cv::quality::QualitySSIM で再実装されている。

getDefaultName()

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

virtual

Python:
	cv.Algorithm.getDefaultName(		) ->	retval

アルゴリズムの文字列識別子を返す。この文字列は、オブジェクトをファイルまたは文字列に保存する際に、最上位の xml/yml ノードタグとして使用される。

cv::AffineFeature、 cv::AgastFeatureDetector、 cv::AKAZE、 cv::BRISK、 cv::FastFeatureDetector、 cv::Feature2D、 cv::GFTTDetector、 cv::KAZE、 cv::MSER、 cv::ORB、 cv::SIFT、 cv::SimpleBlobDetector、 cv::xfeatures2d::BEBLID、 cv::xfeatures2d::BoostDesc、 cv::xfeatures2d::BriefDescriptorExtractor、 cv::xfeatures2d::DAISY、 cv::xfeatures2d::FREAK、 cv::xfeatures2d::HarrisLaplaceFeatureDetector、 cv::xfeatures2d::LATCH、 cv::xfeatures2d::LUCID、 cv::xfeatures2d::MSDDetector、 cv::xfeatures2d::StarDetector、 cv::xfeatures2d::SURF、 cv::xfeatures2d::TBMR、 cv::xfeatures2d::TEBLID、 および cv::xfeatures2d::VGG で再実装されている。

load()

template<typename _Tp >

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

inlinestatic

ファイルからアルゴリズムを読み込む。

引数

filename	読み込むファイルの名前。
objname	読み込むノードの名前（省略可能。空の場合、最初のトップレベルノードが使用される）

これは Algorithm の静的テンプレートメソッドである。使い方は次のとおり（SVMの場合）:

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

このメソッドを機能させるには、派生クラスで Algorithm::read(const FileNode& fn) をオーバーライドする必要がある。

この関数の呼び出しグラフ:

loadFromString()

template<typename _Tp >

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

inlinestatic

String からアルゴリズムを読み込む。

引数

strModel	読み込みたいモデルを含む文字列変数。
objname	読み込むノードの名前（省略可能。空の場合、最初のトップレベルノードが使用される）

これは Algorithm の静的テンプレートメソッドである。使い方は次のとおり（SVMの場合）:

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

この関数の呼び出しグラフ:

read() [1/2]

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

inlinevirtual

Python:
	cv.Algorithm.read(	fn	) ->	None

ファイルストレージからアルゴリズムの引数を読み込む。

cv::aruco::ArucoDetector、 cv::DescriptorMatcher、 cv::face::BasicFaceRecognizer、 cv::face::FaceRecognizer、 cv::Feature2D、 cv::FlannBasedMatcher、 cv::legacy::Tracker、 cv::line_descriptor::BinaryDescriptor、 cv::optflow::GPCForest< T >、 cv::optflow::GPCTree、 および cv::saliency::StaticSaliencySpectralResidual で再実装されている。

read() [2/2]

template<typename _Tp >

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

inlinestatic

Python:
	cv.Algorithm.read(	fn	) ->	None

ファイルノードからアルゴリズムを読み込む。

これは Algorithm の静的テンプレートメソッドである。使い方は次のとおり（SVMの場合）:

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

このメソッドを機能させるには、派生クラスで Algorithm::read(const FileNode& fn) をオーバーライドし、さらに引数なし（またはすべて省略可能な引数を持つ）の静的 create() メソッドを用意する必要がある

save()

virtual void cv::Algorithm::save ( const String & filename ) const

virtual

Python:
	cv.Algorithm.save(	filename	) ->	None

アルゴリズムをファイルに保存する。このメソッドを機能させるには、派生クラスで Algorithm::write(FileStorage& fs) を実装する必要がある。

write() [1/3]

void cv::Algorithm::write	(	const Ptr< FileStorage > &	fs,
		const String &	name = String() ) const

Python:
	cv.Algorithm.write(	fs	) ->	None
	cv.Algorithm.write(	fs, name	) ->	None

非推奨Deprecated

write() [2/3]

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

inlinevirtual

Python:
	cv.Algorithm.write(	fs	) ->	None
	cv.Algorithm.write(	fs, name	) ->	None

アルゴリズムの引数をファイルストレージに保存する。

cv::aruco::ArucoDetector、 cv::bioinspired::Retina、 cv::bioinspired::TransientAreasSegmentationModule、 cv::DescriptorMatcher、 cv::face::BasicFaceRecognizer、 cv::face::FaceRecognizer、 cv::Feature2D、 cv::FlannBasedMatcher、 cv::legacy::Tracker、 cv::line_descriptor::BinaryDescriptor、 cv::optflow::GPCForest< T >、 cv::optflow::GPCTree、 および cv::saliency::StaticSaliencySpectralResidual で再実装されている。

write() [3/3]

void cv::Algorithm::write	(	FileStorage &	fs,
		const String &	name ) const

Python:
	cv.Algorithm.write(	fs	) ->	None
	cv.Algorithm.write(	fs, name	) ->	None

これは利便性のために提供されているオーバーロードされたメンバ関数である。上記の関数とは、受け取る引数のみが異なる。

writeFormat()

void cv::Algorithm::writeFormat ( FileStorage & fs ) const

protected

---

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

• opencv2/core.hpp