View Source Evision.HistogramCostExtractor (Evision v0.2.9)

Summary

Types

t()

Type that represents an HistogramCostExtractor struct.

Functions

Clears the algorithm state

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

Reads algorithm parameters from a file storage

Stores algorithm parameters in a file storage

Types

@type t() :: %Evision.HistogramCostExtractor{ref: reference()}

Type that represents an HistogramCostExtractor struct.

  • ref. reference()

    The underlying erlang resource variable.

Functions

Link to this function

buildCostMatrix(named_args)

View Source
@spec buildCostMatrix(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

buildCostMatrix(self, descriptors1, descriptors2)

View Source
@spec buildCostMatrix(t(), Evision.Mat.maybe_mat_in(), Evision.Mat.maybe_mat_in()) ::
  Evision.Mat.t() | {:error, String.t()}

buildCostMatrix

Positional Arguments
Return
  • costMatrix: Evision.Mat.t().

Python prototype (for reference only):

buildCostMatrix(descriptors1, descriptors2[, costMatrix]) -> costMatrix
Link to this function

buildCostMatrix(self, descriptors1, descriptors2, opts)

View Source
@spec buildCostMatrix(
  t(),
  Evision.Mat.maybe_mat_in(),
  Evision.Mat.maybe_mat_in(),
  [{atom(), term()}, ...] | nil
) :: Evision.Mat.t() | {:error, String.t()}

buildCostMatrix

Positional Arguments
Return
  • costMatrix: Evision.Mat.t().

Python prototype (for reference only):

buildCostMatrix(descriptors1, descriptors2[, costMatrix]) -> costMatrix
@spec clear(Keyword.t()) :: any() | {:error, String.t()}
@spec clear(t()) :: t() | {:error, String.t()}

Clears the algorithm state

Positional Arguments
  • self: Evision.HistogramCostExtractor.t()

Python prototype (for reference only):

clear() -> None
@spec empty(Keyword.t()) :: any() | {:error, String.t()}
@spec empty(t()) :: boolean() | {:error, String.t()}

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

Positional Arguments
  • self: Evision.HistogramCostExtractor.t()
Return
  • retval: bool

Python prototype (for reference only):

empty() -> retval
Link to this function

getDefaultCost(named_args)

View Source
@spec getDefaultCost(Keyword.t()) :: any() | {:error, String.t()}
@spec getDefaultCost(t()) :: number() | {:error, String.t()}

getDefaultCost

Positional Arguments
  • self: Evision.HistogramCostExtractor.t()
Return
  • retval: float

Python prototype (for reference only):

getDefaultCost() -> retval
Link to this function

getDefaultName(named_args)

View Source
@spec getDefaultName(Keyword.t()) :: any() | {:error, String.t()}
@spec getDefaultName(t()) :: binary() | {:error, String.t()}

getDefaultName

Positional Arguments
  • self: Evision.HistogramCostExtractor.t()
Return

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.

Python prototype (for reference only):

getDefaultName() -> retval
@spec getNDummies(Keyword.t()) :: any() | {:error, String.t()}
@spec getNDummies(t()) :: integer() | {:error, String.t()}

getNDummies

Positional Arguments
  • self: Evision.HistogramCostExtractor.t()
Return
  • retval: integer()

Python prototype (for reference only):

getNDummies() -> retval
@spec read(Keyword.t()) :: any() | {:error, String.t()}
@spec read(t(), Evision.FileNode.t()) :: t() | {:error, String.t()}

Reads algorithm parameters from a file storage

Positional Arguments

Python prototype (for reference only):

read(fn) -> None
@spec save(Keyword.t()) :: any() | {:error, String.t()}
@spec save(t(), binary()) :: t() | {:error, String.t()}

save

Positional Arguments
  • self: Evision.HistogramCostExtractor.t()
  • filename: String

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

Python prototype (for reference only):

save(filename) -> None
Link to this function

setDefaultCost(named_args)

View Source
@spec setDefaultCost(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setDefaultCost(self, defaultCost)

View Source
@spec setDefaultCost(t(), number()) :: t() | {:error, String.t()}

setDefaultCost

Positional Arguments
  • self: Evision.HistogramCostExtractor.t()
  • defaultCost: float

Python prototype (for reference only):

setDefaultCost(defaultCost) -> None
@spec setNDummies(Keyword.t()) :: any() | {:error, String.t()}
Link to this function

setNDummies(self, nDummies)

View Source
@spec setNDummies(t(), integer()) :: t() | {:error, String.t()}

setNDummies

Positional Arguments
  • self: Evision.HistogramCostExtractor.t()
  • nDummies: integer()

Python prototype (for reference only):

setNDummies(nDummies) -> None
@spec write(Keyword.t()) :: any() | {:error, String.t()}
@spec write(t(), Evision.FileStorage.t()) :: t() | {:error, String.t()}

Stores algorithm parameters in a file storage

Positional Arguments

Python prototype (for reference only):

write(fs) -> None
@spec write(t(), Evision.FileStorage.t(), binary()) :: t() | {:error, String.t()}

write

Positional Arguments

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None