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

Link to this section Summary

Types

t()

Type that represents an Quality.QualityMSE struct.

Functions

Implements Algorithm::clear()

Computes MSE for reference images supplied in class constructor and provided comparison images

static method for computing quality

static method for computing quality

Create an object which calculates quality

Implements Algorithm::empty()

Link to this section Types

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

Type that represents an Quality.QualityMSE 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.QualityMSE.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()}

Computes MSE for reference images supplied in class constructor and provided comparison images

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

  • cmpImgs: [Evision.Mat].

    Comparison image(s)

Return
  • retval: cv::Scalar

@returns cv::Scalar with per-channel quality values. Values range from 0 (best) to potentially max float (worst)

Python prototype (for reference only):

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

static method for computing quality

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

  • ref: Evision.Mat.t().

    reference image

  • cmp: Evision.Mat.t().

    comparison image=

Return
  • retval: cv::Scalar

  • qualityMap: Evision.Mat.t().

    output quality map, or cv::noArray()

@returns cv::Scalar with per-channel quality values. Values range from 0 (best) to max float (worst)

Python prototype (for reference only):

compute(ref, cmp[, qualityMap]) -> retval, qualityMap
Link to this function

compute(self, ref, cmp, opts)

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

static method for computing quality

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

  • ref: Evision.Mat.t().

    reference image

  • cmp: Evision.Mat.t().

    comparison image=

Return
  • retval: cv::Scalar

  • qualityMap: Evision.Mat.t().

    output quality map, or cv::noArray()

@returns cv::Scalar with per-channel quality values. Values range from 0 (best) to max float (worst)

Python prototype (for reference only):

compute(ref, cmp[, qualityMap]) -> retval, qualityMap
@spec create(Evision.Mat.maybe_mat_in()) :: t() | {:error, String.t()}

Create an object which calculates quality

Positional Arguments
  • ref: Evision.Mat.t().

    input image to use as the reference for comparison

Return
  • retval: QualityMSE

Python prototype (for reference only):

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

Implements Algorithm::empty()

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

Python prototype (for reference only):

empty() -> retval