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

@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

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

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(Keyword.t()) :: any() | {:error, String.t()}

@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(Keyword.t()) :: any() | {:error, String.t()}

@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()
• func: Evision.FileNode

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

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
• name: String

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None