@spec build(t(), Evision.Mat.maybe_mat_in(), map()) :: t() | {: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(), [{:distType, term()}] | nil) ::
  t() | {: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 getAlgorithm(Keyword.t()) :: any() | {:error, String.t()}

@spec getAlgorithm(t()) :: integer() | {:error, String.t()}

getAlgorithm

Positional Arguments

• self: Evision.Flann.Index.t()

Return

• retval: cvflann::flann_algorithm_t

Python prototype (for reference only):

getAlgorithm() -> retval

@spec getDistance(Keyword.t()) :: any() | {:error, String.t()}

@spec getDistance(t()) :: integer() | {:error, String.t()}

getDistance

Positional Arguments

• self: Evision.Flann.Index.t()

Return

• retval: cvflann::flann_distance_t

Python prototype (for reference only):

getDistance() -> retval

@spec index() :: t() | {:error, String.t()}

Index

Return

• self: Evision.Flann.Index.t()

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.t()

Python prototype (for reference only):

Index(features, params[, distType]) -> <flann_Index object>

@spec index(Evision.Mat.maybe_mat_in(), map(), [{:distType, 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.t()

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

Keyword Arguments

• params: SearchParams.

Return

• indices: Evision.Mat.t().
• dists: Evision.Mat.t().

Python prototype (for reference only):

knnSearch(query, knn[, indices[, dists[, params]]]) -> indices, dists

@spec knnSearch(t(), Evision.Mat.maybe_mat_in(), integer(), [{:params, term()}] | nil) ::
  {Evision.Mat.t(), Evision.Mat.t()} | {:error, String.t()}

knnSearch

Positional Arguments

• self: Evision.Flann.Index.t()
• query: Evision.Mat
• knn: integer()

Keyword Arguments

• params: SearchParams.

Return

• indices: Evision.Mat.t().
• dists: Evision.Mat.t().

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

Keyword Arguments

• params: SearchParams.

Return

• retval: integer()
• indices: Evision.Mat.t().
• dists: Evision.Mat.t().

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(),
  [{:params, 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: integer()

Keyword Arguments

• params: SearchParams.

Return

• retval: integer()
• indices: Evision.Mat.t().
• dists: Evision.Mat.t().

Python prototype (for reference only):

radiusSearch(query, radius, maxResults[, indices[, dists[, params]]]) -> retval, indices, dists

@spec release(Keyword.t()) :: any() | {:error, String.t()}

@spec release(t()) :: t() | {:error, String.t()}

release

Positional Arguments

• self: Evision.Flann.Index.t()

Python prototype (for reference only):

release() -> None

@spec save(t(), binary()) :: t() | {:error, String.t()}

save

Positional Arguments

• self: Evision.Flann.Index.t()
• filename: String

Python prototype (for reference only):

save(filename) -> None