Image.Options.Compare (image v0.73.0)

Copy Markdown View Source

Options and option validation for Image.compare/3.

Summary

Types

compare_option()

Options applicable to Image.compare/3.

compare_options()
metric()

The comparison metric used by Image.compare/3.

Functions

validate_options(image, options)

Validate the options for Image.compare/3.

Types

compare_option()

@type compare_option() ::
  {:metric, metric()}
  | {:saturation, number()}
  | {:brightness, number()}
  | {:difference_boost, number()}
  | {:difference_color, Image.Pixel.t()}

Options applicable to Image.compare/3.

compare_options()

@type compare_options() :: [compare_option()]

metric()

@type metric() :: :ae | :mse | :rmse

The comparison metric used by Image.compare/3.

Functions

validate_options(image, options)

Validate the options for Image.compare/3.