cv::ANNIndex クラス

#include <opencv2/features.hpp>

Collaboration diagram for cv::ANNIndex:

公開型
enum	Distance {   DIST_EUCLIDEAN ,   DIST_MANHATTAN ,   DIST_ANGULAR ,   DIST_HAMMING ,   DIST_DOTPRODUCT }
	2つの特徴ベクトル間の距離を計算するために使用する尺度(メトリック)。続きを読む...

公開メンバ関数
virtual	~ANNIndex ()=default
virtual void	addItems (InputArray features)=0
	特徴ベクトルをインデックスに追加する。
virtual void	build (int trees=-1)=0
	インデックスを構築する。
virtual int	getItemNumber ()=0
	インデックス内の特徴ベクトルの数を返す。
virtual int	getTreeNumber ()=0
	インデックス内の木の本数を返す。
virtual void	knnSearch (InputArray query, OutputArray indices, OutputArray dists, int knn, int search_k=-1)=0
	インデックスを用いて、与えられたクエリベクトルに対するK近傍探索を行う。
virtual void	load (const String &filename, bool prefault=false)=0
	ディスクからインデックスを読み込む(mmap する)。
virtual void	save (const String &filename, bool prefault=false)=0
	インデックスをディスクに保存して読み込む。保存後は、これ以上ベクトルを追加できない。
virtual bool	setOnDiskBuild (const String &filename)=0
	RAM ではなく指定したファイル内にインデックスを構築する準備を行う(アイテムを追加する前に実行する。構築後の保存は不要)
virtual void	setSeed (int seed)=0
	与えられたシードで乱数生成器を初期化する。アイテムを追加する前に呼び出す場合にのみ必要。build() または load() を呼び出した後は効果がない。

静的公開メンバ関数
static Ptr< ANNIndex >	create (int dim, ANNIndex::Distance distType=ANNIndex::DIST_EUCLIDEAN)
	与えられた引数で annoy インデックスクラスのインスタンスを生成する。

列挙型メンバ詳解

Distance

enum cv::ANNIndex::Distance

2つの特徴ベクトル間の距離を計算するために使用する尺度(メトリック)。

列挙値
DIST_EUCLIDEAN
DIST_MANHATTAN
DIST_ANGULAR
DIST_HAMMING
DIST_DOTPRODUCT

構築子と解体子の詳解

~ANNIndex()

virtual cv::ANNIndex::~ANNIndex ( )

virtualdefault

メンバ関数詳解

addItems()

virtual void cv::ANNIndex::addItems ( InputArray features )

pure virtual

Python:
	cv.ANNIndex.addItems(	features	) ->	None

特徴ベクトルをインデックスに追加する。

引数

features

インデックスに登録する特徴ベクトルを格納した行列。行列のサイズは num_features x feature_dimension。

build()

virtual void cv::ANNIndex::build ( int trees = -1 )

pure virtual

Python:
	cv.ANNIndex.build(	[, trees]	) ->	None

インデックスを構築する。

引数

trees

インデックス内の木の本数。指定しない場合、特徴ベクトルが消費するメモリの最大2倍までに収まるように本数が自動的に決定される。

create()

static Ptr< ANNIndex > cv::ANNIndex::create ( int dim, ANNIndex::Distance distType = ANNIndex::DIST_EUCLIDEAN )

static

Python:
	cv.ANNIndex.create(	dim[, distType]	) ->	retval
	cv.ANNIndex_create(	dim[, distType]	) ->	retval

与えられた引数で annoy インデックスクラスのインスタンスを生成する。

引数

dim	特徴ベクトルの次元。
distType	2つの特徴ベクトル間の距離を計算するための尺度(メトリック)。DIST_EUCLIDEAN、DIST_MANHATTAN、DIST_ANGULAR、DIST_HAMMING、または DIST_DOTPRODUCT を指定できる。

getItemNumber()

virtual int cv::ANNIndex::getItemNumber ( )

pure virtual

Python:
	cv.ANNIndex.getItemNumber(		) ->	retval

インデックス内の特徴ベクトルの数を返す。

getTreeNumber()

virtual int cv::ANNIndex::getTreeNumber ( )

pure virtual

Python:
	cv.ANNIndex.getTreeNumber(		) ->	retval

インデックス内の木の本数を返す。

knnSearch()

virtual void cv::ANNIndex::knnSearch ( InputArray query, OutputArray indices, OutputArray dists, int knn, int search_k = -1 )

pure virtual

Python:
	cv.ANNIndex.knnSearch(	query, knn[, indices[, dists[, search_k]]]	) ->	indices, dists

インデックスを用いて、与えられたクエリベクトルに対するK近傍探索を行う。

引数

query	クエリベクトル。
indices	見つかったK近傍のインデックスを格納する行列。省略可能。
dists	見つかったK近傍までの距離を格納する行列。省略可能。
knn	探索する最近傍の個数。
search_k	検査するノードの最大数。指定しない場合のデフォルトは trees x knn。

load()

virtual void cv::ANNIndex::load ( const String & filename, bool prefault = false )

pure virtual

Python:
	cv.ANNIndex.load(	filename[, prefault]	) ->	None

ディスクからインデックスを読み込む(mmap する)。

引数

filename	読み込むインデックスのファイル名。
prefault	prefault を true に設定すると、ファイル全体を事前にメモリへ読み込む(MAP_POPULATE を伴う mmap を使用)。デフォルトは false。

save()

virtual void cv::ANNIndex::save ( const String & filename, bool prefault = false )

pure virtual

Python:
	cv.ANNIndex.save(	filename[, prefault]	) ->	None

インデックスをディスクに保存して読み込む。保存後は、これ以上ベクトルを追加できない。

引数

filename	保存するインデックスのファイル名。
prefault	prefault を true に設定すると、ファイル全体を事前にメモリへ読み込む(MAP_POPULATE を伴う mmap を使用)。デフォルトは false。

setOnDiskBuild()

virtual bool cv::ANNIndex::setOnDiskBuild ( const String & filename )

pure virtual

Python:
	cv.ANNIndex.setOnDiskBuild(	filename	) ->	retval

RAM ではなく指定したファイル内にインデックスを構築する準備を行う(アイテムを追加する前に実行する。構築後の保存は不要)

引数

filename

構築するインデックスのファイル名。

setSeed()

virtual void cv::ANNIndex::setSeed ( int seed )

pure virtual

Python:
	cv.ANNIndex.setSeed(	seed	) ->	None

与えられたシードで乱数生成器を初期化する。アイテムを追加する前に呼び出す場合にのみ必要。build() または load() を呼び出した後は効果がない。

引数

seed	乱数生成器に与えるシード。その値は uint32_t の範囲内でなければならない。

---

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

• opencv2/features.hpp