ImageSimilarityOptions Class

Immutable options of ImageSimilarity.ComputeSsim and ImageSimilarity.ComputePsnr: the precision of the samples they compare.

public sealed class ImageSimilarityOptions

Constructors

NameDescription
ImageSimilarityOptions()

ImageSimilarityOptions()

ImageSimilarityOptions.cs
public ImageSimilarityOptions()

No documentation is available.

Properties

NameDescription
DataRangeGets the range of the color samples with SimilarityPrecision.FloatingPoint: the peak of the PSNR and the L of the SSIM constants, scikit-image's data_range. Defaults to 1, the reference white; use the largest value of high dynamic range frames, such as 4 for a highlight headroom of 4. Alpha, a coverage, always has the range 1. The other precisions have the range of their samples (255 or 65,535).
PrecisionGets the samples that are compared. Defaults to SimilarityPrecision.EightBit, the samples of the overloads without options.

Gets the range of the color samples with SimilarityPrecision.FloatingPoint: the peak of the PSNR and the L of the SSIM constants, scikit-image's data_range. Defaults to 1, the reference white; use the largest value of high dynamic range frames, such as 4 for a highlight headroom of 4. Alpha, a coverage, always has the range 1. The other precisions have the range of their samples (255 or 65,535).

public double DataRange { get; init; }

Property value

double

Exceptions

ArgumentOutOfRangeException
The value is not positive and finite.

Gets the samples that are compared. Defaults to SimilarityPrecision.EightBit, the samples of the overloads without options.

public SimilarityPrecision Precision { get; init; }

Property value

SimilarityPrecision

Exceptions

ArgumentOutOfRangeException
The value is not a defined SimilarityPrecision.