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

@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()) ::
  Evision.scalar() | {: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.

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

Return

• retval: Evision.scalar().t()

Python prototype (for reference only):

compute(img) -> retval

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

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

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

getDefaultName

Positional Arguments

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

@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

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

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

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

Has overloading in C++

Python prototype (for reference only):

write(fs, name) -> None