View Source Evision.Flann.Index (Evision v0.1.18)
Link to this section Summary
Types
Type that represents an Evision.Flann.Index
struct.
Functions
getAlgorithm
getDistance
Index
Index
knnSearch
knnSearch
radiusSearch
radiusSearch
release
save
Link to this section Types
@type t() :: %Evision.Flann.Index{ref: reference()}
Type that represents an Evision.Flann.Index
struct.
ref.
reference()
The underlying erlang resource variable.
Link to this section Functions
@spec build(t(), Evision.Mat.maybe_mat_in(), map()) :: :ok | {:error, String.t()}
build
Positional Arguments
- self:
Evision.Flann.Index.t()
- features:
Evision.Mat
- params:
IndexParams
Keyword Arguments
- distType:
cvflann_flann_distance_t
.
Python prototype (for reference only):
build(features, params[, distType]) -> None
@spec build(t(), Evision.Mat.maybe_mat_in(), map(), [{atom(), term()}, ...] | nil) :: :ok | {:error, String.t()}
build
Positional Arguments
- self:
Evision.Flann.Index.t()
- features:
Evision.Mat
- params:
IndexParams
Keyword Arguments
- distType:
cvflann_flann_distance_t
.
Python prototype (for reference only):
build(features, params[, distType]) -> None
getAlgorithm
Positional Arguments
- self:
Evision.Flann.Index.t()
Return
- retval:
cvflann::flann_algorithm_t
Python prototype (for reference only):
getAlgorithm() -> retval
getDistance
Positional Arguments
- self:
Evision.Flann.Index.t()
Return
- retval:
cvflann::flann_distance_t
Python prototype (for reference only):
getDistance() -> retval
Index
Return
- self:
Evision.Flann.Index
Python prototype (for reference only):
Index() -> <flann_Index object>
@spec index(Evision.Mat.maybe_mat_in(), map()) :: t() | {:error, String.t()}
Index
Positional Arguments
- features:
Evision.Mat
- params:
IndexParams
Keyword Arguments
- distType:
cvflann_flann_distance_t
.
Return
- self:
Evision.Flann.Index
Python prototype (for reference only):
Index(features, params[, distType]) -> <flann_Index object>
@spec index(Evision.Mat.maybe_mat_in(), map(), [{atom(), term()}, ...] | nil) :: t() | {:error, String.t()}
Index
Positional Arguments
- features:
Evision.Mat
- params:
IndexParams
Keyword Arguments
- distType:
cvflann_flann_distance_t
.
Return
- self:
Evision.Flann.Index
Python prototype (for reference only):
Index(features, params[, distType]) -> <flann_Index object>
@spec knnSearch(t(), Evision.Mat.maybe_mat_in(), integer()) :: {Evision.Mat.t(), Evision.Mat.t()} | {:error, String.t()}
knnSearch
Positional Arguments
- self:
Evision.Flann.Index.t()
- query:
Evision.Mat
- knn:
int
Keyword Arguments
- params:
SearchParams
.
Return
- indices:
Evision.Mat
. - dists:
Evision.Mat
.
Python prototype (for reference only):
knnSearch(query, knn[, indices[, dists[, params]]]) -> indices, dists
@spec knnSearch( t(), Evision.Mat.maybe_mat_in(), integer(), [{atom(), term()}, ...] | nil ) :: {Evision.Mat.t(), Evision.Mat.t()} | {:error, String.t()}
knnSearch
Positional Arguments
- self:
Evision.Flann.Index.t()
- query:
Evision.Mat
- knn:
int
Keyword Arguments
- params:
SearchParams
.
Return
- indices:
Evision.Mat
. - dists:
Evision.Mat
.
Python prototype (for reference only):
knnSearch(query, knn[, indices[, dists[, params]]]) -> indices, dists
@spec load(t(), Evision.Mat.maybe_mat_in(), binary()) :: boolean() | {:error, String.t()}
load
Positional Arguments
- self:
Evision.Flann.Index.t()
- features:
Evision.Mat
- filename:
String
Return
- retval:
bool
Python prototype (for reference only):
load(features, filename) -> retval
@spec radiusSearch(t(), Evision.Mat.maybe_mat_in(), number(), integer()) :: {integer(), Evision.Mat.t(), Evision.Mat.t()} | {:error, String.t()}
radiusSearch
Positional Arguments
- self:
Evision.Flann.Index.t()
- query:
Evision.Mat
- radius:
double
- maxResults:
int
Keyword Arguments
- params:
SearchParams
.
Return
- retval:
int
- indices:
Evision.Mat
. - dists:
Evision.Mat
.
Python prototype (for reference only):
radiusSearch(query, radius, maxResults[, indices[, dists[, params]]]) -> retval, indices, dists
@spec radiusSearch( t(), Evision.Mat.maybe_mat_in(), number(), integer(), [{atom(), term()}, ...] | nil ) :: {integer(), Evision.Mat.t(), Evision.Mat.t()} | {:error, String.t()}
radiusSearch
Positional Arguments
- self:
Evision.Flann.Index.t()
- query:
Evision.Mat
- radius:
double
- maxResults:
int
Keyword Arguments
- params:
SearchParams
.
Return
- retval:
int
- indices:
Evision.Mat
. - dists:
Evision.Mat
.
Python prototype (for reference only):
radiusSearch(query, radius, maxResults[, indices[, dists[, params]]]) -> retval, indices, dists
release
Positional Arguments
- self:
Evision.Flann.Index.t()
Python prototype (for reference only):
release() -> None
save
Positional Arguments
- self:
Evision.Flann.Index.t()
- filename:
String
Python prototype (for reference only):
save(filename) -> None