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

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

Computes SSIM

Positional Arguments

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

• cmp: Evision.Mat.

  Comparison image

Return

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

@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()) ::
  {Evision.scalar(), Evision.Mat.t()} | {:error, String.t()}

static method for computing quality

Positional Arguments

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

• ref: Evision.Mat.

  reference image

• cmp: Evision.Mat.

  comparison image

Return

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

• 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 compute(
  t(),
  Evision.Mat.maybe_mat_in(),
  Evision.Mat.maybe_mat_in(),
  [{atom(), term()}, ...] | nil
) :: {Evision.scalar(), Evision.Mat.t()} | {:error, String.t()}

static method for computing quality

Positional Arguments

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

• ref: Evision.Mat.

  reference image

• cmp: Evision.Mat.

  comparison image

Return

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

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

@spec create(Evision.Mat.maybe_mat_in()) :: t() | {:error, String.t()}

Create an object which calculates quality

Positional Arguments

• ref: Evision.Mat.

  input image to use as the reference image for comparison

Return

• retval: QualitySSIM

Python prototype (for reference only):

create(ref) -> retval

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

@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