Evision
v0.1.34

View Source Evision.Quality.QualityPSNR (Evision v0.1.34)

Summary

Types

t()

Type that represents an Quality.QualityPSNR struct.

Functions

clear(self)

Implements Algorithm::clear()

compute(self, cmp)

Compute the PSNR

compute(self, ref, cmp)

static method for computing quality

compute(self, ref, cmp, opts)

static method for computing quality

create(ref)

Create an object which calculates quality

create(ref, opts)

Create an object which calculates quality

empty(self)

Implements Algorithm::empty()

getMaxPixelValue(self)

return the maximum pixel value used for PSNR computation

setMaxPixelValue(self, val)

sets the maximum pixel value used for PSNR computation

Types

Link to this type

t()

View Source 
@type t() :: %Evision.Quality.QualityPSNR{ref: reference()}

Type that represents an Quality.QualityPSNR struct.

  • ref. reference()

    The underlying erlang resource variable.

Functions

Link to this function

clear(self)

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

Implements Algorithm::clear()

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

Python prototype (for reference only):

clear() -> None
Link to this function

compute(self, cmp)

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

Compute the PSNR

Positional Arguments

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

  • cmp: Evision.Mat.t().

    Comparison image

Return
  • retval: cv::Scalar

@returns Per-channel PSNR value, or std::numeric_limits<double>::infinity() if the MSE between the two images == 0

Python prototype (for reference only):

compute(cmp) -> retval
Link to this function

compute(self, ref, cmp)

View Source 
@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.QualityPSNR.t()

  • ref: Evision.Mat.t().

    reference image

  • cmp: Evision.Mat.t().

    comparison image

Keyword Arguments

  • maxPixelValue: double.

    maximum per-channel value for any individual pixel; eg 255 for uint8 image

Return

  • retval: cv::Scalar

  • qualityMap: Evision.Mat.t().

    output quality map, or cv::noArray()

@returns PSNR value, or std::numeric_limits<double>::infinity() if the MSE between the two images == 0

Python prototype (for reference only):

compute(ref, cmp[, qualityMap[, maxPixelValue]]) -> 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.QualityPSNR.t()

  • ref: Evision.Mat.t().

    reference image

  • cmp: Evision.Mat.t().

    comparison image

Keyword Arguments

  • maxPixelValue: double.

    maximum per-channel value for any individual pixel; eg 255 for uint8 image

Return

  • retval: cv::Scalar

  • qualityMap: Evision.Mat.t().

    output quality map, or cv::noArray()

@returns PSNR value, or std::numeric_limits<double>::infinity() if the MSE between the two images == 0

Python prototype (for reference only):

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

create(ref)

View Source 
@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 source for comparison

Keyword Arguments

  • maxPixelValue: double.

    maximum per-channel value for any individual pixel; eg 255 for uint8 image

Return
  • retval: QualityPSNR

Python prototype (for reference only):

create(ref[, maxPixelValue]) -> retval
Link to this function

create(ref, opts)

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

Create an object which calculates quality

Positional Arguments

  • ref: Evision.Mat.t().

    input image to use as the source for comparison

Keyword Arguments

  • maxPixelValue: double.

    maximum per-channel value for any individual pixel; eg 255 for uint8 image

Return
  • retval: QualityPSNR

Python prototype (for reference only):

create(ref[, maxPixelValue]) -> retval
Link to this function

empty(self)

View Source 
@spec empty(t()) :: boolean() | {:error, String.t()}

Implements Algorithm::empty()

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

Python prototype (for reference only):

empty() -> retval
Link to this function

getMaxPixelValue(self)

View Source 
@spec getMaxPixelValue(t()) :: number() | {:error, String.t()}

return the maximum pixel value used for PSNR computation

Positional Arguments
  • self: Evision.Quality.QualityPSNR.t()
Return
  • retval: double

Python prototype (for reference only):

getMaxPixelValue() -> retval
Link to this function

setMaxPixelValue(self, val)

View Source 
@spec setMaxPixelValue(t(), number()) :: t() | {:error, String.t()}

sets the maximum pixel value used for PSNR computation

Positional Arguments

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

  • val: double.

    Maximum pixel value

Python prototype (for reference only):

setMaxPixelValue(val) -> None