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

Link to this section Summary

Types

t()

Type that represents an Quality.QualitySSIM struct.

Functions

Implements Algorithm::clear()

Computes SSIM

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.QualitySSIM{ref: reference()}

Type that represents an Quality.QualitySSIM 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.QualitySSIM.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 SSIM

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

  • cmp: Evision.Mat.t().

    Comparison image

Return
  • retval: cv::Scalar

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

Python prototype (for reference only):

compute(cmp) -> 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.QualitySSIM.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 (worst) to 1 (best)

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.QualitySSIM.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 (worst) to 1 (best)

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 image for comparison

Return
  • retval: QualitySSIM

Python prototype (for reference only):

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

Implements Algorithm::empty()

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

Python prototype (for reference only):

empty() -> retval