View Source Evision.Quality.QualityBase (Evision v0.1.28)

Link to this section Summary

Types

t()

Type that represents an Quality.QualityBase struct.

Functions

Implements Algorithm::clear()

Compute quality score per channel with the per-channel score in each element of the resulting cv::Scalar. See specific algorithm for interpreting result scores

Implements Algorithm::empty()

getDefaultName

Returns output quality map that was generated during computation, if supported by the algorithm

Returns output quality map that was generated during computation, if supported by the algorithm

Reads algorithm parameters from a file storage

Stores algorithm parameters in a file storage

Link to this section Types

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

Type that represents an Quality.QualityBase struct.

  • ref. reference()

    The underlying erlang resource variable.

Link to this section Functions

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

Implements Algorithm::clear()

Positional Arguments
  • self: Evision.Quality.QualityBase.t()

Python prototype (for reference only):

clear() -> None
@spec compute(t(), Evision.Mat.maybe_mat_in()) ::
  {number()}
  | {number(), number()}
  | {number() | number() | number()}
  | {number(), number(), number(), number()}
  | {:error, String.t()}

Compute quality score per channel with the per-channel score in each element of the resulting cv::Scalar. See specific algorithm for interpreting result scores

Positional Arguments
  • self: Evision.Quality.QualityBase.t()

  • img: Evision.Mat.t().

    comparison image, or image to evalute for no-reference quality algorithms

Return
  • retval: cv::Scalar

Python prototype (for reference only):

compute(img) -> retval
@spec empty(t()) :: boolean() | {:error, String.t()}

Implements Algorithm::empty()

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

Python prototype (for reference only):

empty() -> retval
@spec getDefaultName(t()) :: binary() | {:error, String.t()}

getDefaultName

Positional Arguments
  • self: Evision.Quality.QualityBase.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 getQualityMap(t()) :: Evision.Mat.t() | {:error, String.t()}

Returns output quality map that was generated during computation, if supported by the algorithm

Positional Arguments
  • self: Evision.Quality.QualityBase.t()
Return
  • dst: Evision.Mat.t().

Python prototype (for reference only):

getQualityMap([, dst]) -> dst
Link to this function

getQualityMap(self, opts)

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

Returns output quality map that was generated during computation, if supported by the algorithm

Positional Arguments
  • self: Evision.Quality.QualityBase.t()
Return
  • dst: Evision.Mat.t().

Python prototype (for reference only):

getQualityMap([, dst]) -> dst
@spec read(t(), Evision.FileNode.t()) :: t() | {:error, String.t()}

Reads algorithm parameters from a file storage

Positional Arguments
  • self: Evision.Quality.QualityBase.t()
  • fn_: Evision.FileNode.t()

Python prototype (for reference only):

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

save

Positional Arguments
  • self: Evision.Quality.QualityBase.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(t(), Evision.FileStorage.t()) :: t() | {:error, String.t()}

Stores algorithm parameters in a file storage

Positional Arguments
  • self: Evision.Quality.QualityBase.t()
  • fs: Evision.FileStorage.t()

Python prototype (for reference only):

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

write

Positional Arguments
  • self: Evision.Quality.QualityBase.t()
  • fs: Evision.FileStorage.t()
  • name: String

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None