View Source Evision.HistogramCostExtractor (Evision v0.2.9)
Summary
Functions
buildCostMatrix
buildCostMatrix
Clears the algorithm state
Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read
getDefaultCost
getDefaultName
getNDummies
Reads algorithm parameters from a file storage
save
setDefaultCost
setNDummies
Stores algorithm parameters in a file storage
write
Types
@type t() :: %Evision.HistogramCostExtractor{ref: reference()}
Type that represents an HistogramCostExtractor
struct.
ref.
reference()
The underlying erlang resource variable.
Functions
@spec buildCostMatrix(t(), Evision.Mat.maybe_mat_in(), Evision.Mat.maybe_mat_in()) :: Evision.Mat.t() | {:error, String.t()}
buildCostMatrix
Positional Arguments
- self:
Evision.HistogramCostExtractor.t()
- descriptors1:
Evision.Mat
- descriptors2:
Evision.Mat
Return
- costMatrix:
Evision.Mat.t()
.
Python prototype (for reference only):
buildCostMatrix(descriptors1, descriptors2[, costMatrix]) -> costMatrix
@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
- self:
Evision.HistogramCostExtractor.t()
- descriptors1:
Evision.Mat
- descriptors2:
Evision.Mat
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
@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
@spec getDefaultName(Keyword.t()) :: any() | {:error, String.t()}
@spec getDefaultName(t()) :: binary() | {:error, String.t()}
getDefaultName
Positional Arguments
- self:
Evision.HistogramCostExtractor.t()
Return
- retval:
String
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(t(), Evision.FileNode.t()) :: t() | {:error, String.t()}
Reads algorithm parameters from a file storage
Positional Arguments
- self:
Evision.HistogramCostExtractor.t()
- func:
Evision.FileNode
Python prototype (for reference only):
read(fn) -> None
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
setDefaultCost
Positional Arguments
- self:
Evision.HistogramCostExtractor.t()
- defaultCost:
float
Python prototype (for reference only):
setDefaultCost(defaultCost) -> None
setNDummies
Positional Arguments
- self:
Evision.HistogramCostExtractor.t()
- nDummies:
integer()
Python prototype (for reference only):
setNDummies(nDummies) -> None
@spec write(t(), Evision.FileStorage.t()) :: t() | {:error, String.t()}
Stores algorithm parameters in a file storage
Positional Arguments
- self:
Evision.HistogramCostExtractor.t()
- fs:
Evision.FileStorage
Python prototype (for reference only):
write(fs) -> None
@spec write(t(), Evision.FileStorage.t(), binary()) :: t() | {:error, String.t()}
write
Positional Arguments
- self:
Evision.HistogramCostExtractor.t()
- fs:
Evision.FileStorage
- name:
String
Has overloading in C++
Python prototype (for reference only):
write(fs, name) -> None