Metrics

Functions
float	oevislib_net.Image.Correlation (Image inPatternImage, CorrelationMeasure inCorrelationMeasure, Optional< Region > inRoi=null)
	Computes the correlation between the image and a chosen pattern.
Image	oevislib_net.Image.CorrelationImage (Image inPatternImage, CorrelationMeasure inCorrelationMeasure, Optional< Region > inRoi, Optional< Region > inPatternRoi)
	Computes the correlation between the image and a chosen pattern, returning as output an image where each pixel represents a single comparison result.
float	oevislib_net.Image.Dissimilarity (Image inPatternImage, DistanceMeasure inDistanceMeasure, Optional< Region > inRoi=null)
	Measures the dissimilarity between the image and a chosen pattern.
Image	oevislib_net.Image.DissimilarityImage (Image inPatternImage, DistanceMeasure inDistanceMeasure, Optional< Region > inRoi, Optional< Region > inPatternRoi)
	Measures the dissimilarity between the image and a chosen pattern (moving on all image).
static float	oevislib_net.Image.PixelDistance (Pixel inPixel1, Pixel inPixel2, float inChromaAmount)
	Compares two pixels using chromatic and non-chromatic information.

Detailed Description

Function Documentation

Correlation()

float oevislib_net.Image.Correlation ( Image inPatternImage, CorrelationMeasure inCorrelationMeasure, Optional< Region > inRoi = null )

inline

Computes the correlation between the image and a chosen pattern.

Parameters

inPatternImage	Pattern to compare with the image.
inCorrelationMeasure	Correlation measure (normalized cross-correlation or cross-correlation).
inRoi	Region of interest of the image.

Returns

Correlation value.

CorrelationImage()

Image oevislib_net.Image.CorrelationImage ( Image inPatternImage, CorrelationMeasure inCorrelationMeasure, Optional< Region > inRoi, Optional< Region > inPatternRoi )

inline

Computes the correlation between the image and a chosen pattern, returning as output an image where each pixel represents a single comparison result.

Parameters

inPatternImage	Pattern to compare with the image.
inCorrelationMeasure	Correlation measure (normalized cross-correlation or cross-correlation).
inRoi	Region of interest of the image.
inPatternRoi	Region of interest of the pattern.

Returns

Correlation image.

Dissimilarity()

float oevislib_net.Image.Dissimilarity ( Image inPatternImage, DistanceMeasure inDistanceMeasure, Optional< Region > inRoi = null )

inline

Measures the dissimilarity between the image and a chosen pattern.

Parameters

inPatternImage	Pattern to compare with the image.
inDistanceMeasure	Distance measure (mean-error or mean-squared-error).
inRoi	Region of interest of the image.

Returns

Difference value.

DissimilarityImage()

Image oevislib_net.Image.DissimilarityImage ( Image inPatternImage, DistanceMeasure inDistanceMeasure, Optional< Region > inRoi, Optional< Region > inPatternRoi )

inline

Measures the dissimilarity between the image and a chosen pattern (moving on all image).

Parameters

inPatternImage	Pattern to compare with the image.
inDistanceMeasure	Distance measure (mean-error or mean-squared-error).
inRoi	Region of interest of the image.
inPatternRoi	Region of interest of the pattern.

Returns

Difference value.

PixelDistance()

float oevislib_net.Image.PixelDistance ( Pixel inPixel1, Pixel inPixel2, float inChromaAmount )

inlinestatic

Compares two pixels using chromatic and non-chromatic information.

Parameters

inPixel1	First pixel.
inPixel2	Second pixel.
inChromaAmount	Proportion of chromatic information to consider in computations. Range: [0, 1].

Returns

Distance value.