View Source Evision.Saliency.Saliency (Evision v0.2.2-rc2)
Summary
Functions
Clears the algorithm state
computeSaliency
computeSaliency
Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read
getDefaultName
Reads algorithm parameters from a file storage
save
Stores algorithm parameters in a file storage
write
Types
@type t() :: %Evision.Saliency.Saliency{ref: reference()}
Type that represents an Saliency.Saliency
struct.
ref.
reference()
The underlying erlang resource variable.
Functions
@spec clear(Evision.Saliency.t()) :: Evision.Saliency.t() | {:error, String.t()}
Clears the algorithm state
Positional Arguments
- self:
Evision.Saliency.Saliency.t()
Python prototype (for reference only):
clear() -> None
@spec computeSaliency(Evision.Saliency.t(), Evision.Mat.maybe_mat_in()) :: Evision.Mat.t() | false | {:error, String.t()}
computeSaliency
Positional Arguments
- self:
Evision.Saliency.Saliency.t()
- image:
Evision.Mat.t()
Return
- retval:
bool
- saliencyMap:
Evision.Mat.t()
.
\brief Compute the saliency \param image The image. \param saliencyMap The computed saliency map. \return true if the saliency map is computed, false otherwise
Python prototype (for reference only):
computeSaliency(image[, saliencyMap]) -> retval, saliencyMap
@spec computeSaliency( Evision.Saliency.t(), Evision.Mat.maybe_mat_in(), [{atom(), term()}, ...] | nil ) :: Evision.Mat.t() | false | {:error, String.t()}
computeSaliency
Positional Arguments
- self:
Evision.Saliency.Saliency.t()
- image:
Evision.Mat.t()
Return
- retval:
bool
- saliencyMap:
Evision.Mat.t()
.
\brief Compute the saliency \param image The image. \param saliencyMap The computed saliency map. \return true if the saliency map is computed, false otherwise
Python prototype (for reference only):
computeSaliency(image[, saliencyMap]) -> retval, saliencyMap
@spec empty(Evision.Saliency.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.Saliency.Saliency.t()
Return
- retval:
bool
Python prototype (for reference only):
empty() -> retval
@spec getDefaultName(Evision.Saliency.t()) :: binary() | {:error, String.t()}
getDefaultName
Positional Arguments
- self:
Evision.Saliency.Saliency.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 read(Evision.Saliency.t(), Evision.FileNode.t()) :: Evision.Saliency.t() | {:error, String.t()}
Reads algorithm parameters from a file storage
Positional Arguments
- self:
Evision.Saliency.Saliency.t()
- fn_:
Evision.FileNode.t()
Python prototype (for reference only):
read(fn_) -> None
@spec save(Evision.Saliency.t(), binary()) :: Evision.Saliency.t() | {:error, String.t()}
save
Positional Arguments
- self:
Evision.Saliency.Saliency.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
@spec write(Evision.Saliency.t(), Evision.FileStorage.t()) :: Evision.Saliency.t() | {:error, String.t()}
Stores algorithm parameters in a file storage
Positional Arguments
- self:
Evision.Saliency.Saliency.t()
- fs:
Evision.FileStorage.t()
Python prototype (for reference only):
write(fs) -> None
@spec write(Evision.Saliency.t(), Evision.FileStorage.t(), binary()) :: Evision.Saliency.t() | {:error, String.t()}
write
Positional Arguments
- self:
Evision.Saliency.Saliency.t()
- fs:
Evision.FileStorage.t()
- name:
String
Has overloading in C++
Python prototype (for reference only):
write(fs, name) -> None