eVision.EOCVChar Class Reference

Holds all information related to a single character, such as nominal and average position, reference quality indicators,... During the learning phases, it also keeps the list of its constituent blobs. More...

Inheritance diagram for eVision.EOCVChar:

Collaboration diagram for eVision.EOCVChar:

Public Member Functions
	EOCVChar ()
	Constructs an OCVChar context.
	EOCVChar (eVision.EOCVChar other)
	Constructs an OCVChar context.
void	ResetParameters ()
	Sets all character parameters to the undefined value for use before a EOCV.SetTextCharParameters or EOCV.ScatterTextsCharsParameters operation.

Properties
bool	WhiteOnBlack [get, set]
	Character contrast: true for light characters on a dark background.
int	Selected [get, set]
	Selection state: TRUE when selected.
uint	NumContourPoints [get, set]
	Number of contour points of this character used for location.
float	TemplateLocationScore [get, set]
	Value of the location score measured on the template during learning.
float	SampleLocationScore [get, set]
	Value of the location score measured on the sample during inspection.
float	LocationScoreTolerance [get, set]
	Allowed absolute difference between the template and sample scores.
float	ShiftX [get, set]
	Measured horizontal translation.
float	ShiftXBias [get, set]
	Horizontal translation bias.
float	ShiftXTolerance [get, set]
	Horizontal translation tolerance.
uint	ShiftXStride [get, set]
	First pass stride for the horizontal translation.
float	ShiftY [get, set]
	Measured vertical translation.
float	ShiftYBias [get, set]
	Vertical translation bias. 0 corresponds to the nominal position.
float	ShiftYTolerance [get, set]
	Vertical translation tolerance.
uint	ShiftYStride [get, set]
	First pass stride for the vertical translation.
uint	Diagnostics [get, set]
	Logical combination (bitwise OR) of defects.
uint	MarginWidth [get, set]
	Width of the extra space to be used around the characters bounding box (on all four sides) when computing a quality indicator.
uint	TemplateForegroundArea [get, set]
	Number of pixels in the template foreground of this character.
uint	SampleForegroundArea [get, set]
	Number of foreground pixels of this character corresponding to a foreground pixel of the template character.
uint	ForegroundAreaTolerance [get, set]
	Maximum allowed difference between the sample and template foreground areas.
uint	TemplateBackgroundArea [get, set]
	Number of pixels in the background of this character.
uint	SampleBackgroundArea [get, set]
	Number of background pixels of this character corresponding to a background pixel of the template character.
uint	BackgroundAreaTolerance [get, set]
	Maximum allowed difference between the sample and template background areas.
float	TemplateForegroundSum [get, set]
	Sum of the normalized gray-level values of the foreground pixels of this character.
float	SampleForegroundSum [get, set]
	Sum of the normalized gray-level values of the pixels of this character corresponding to a foreground pixel of the template character.
float	ForegroundSumTolerance [get, set]
	Maximum allowed difference between the sample and template foreground sums.
float	TemplateBackgroundSum [get, set]
	Sum of the normalized gray-level values of the background pixels of this character.
float	SampleBackgroundSum [get, set]
	Sum of the normalized gray-level values of the pixels of this character corresponding to a background pixel of the template character.
float	BackgroundSumTolerance [get, set]
	Maximum allowed difference between the sample and template background sums.
float	Correlation [get, set]
	Normalized correlation involving the template and sample character images.
float	CorrelationTolerance [get, set]
	Maximum allowed difference between the normalized correlation and unity.
float	LocationScoreAverage [get, set]
	Location score average.
float	LocationScoreDeviation [get, set]
	Location score standard deviation.
float	ShiftXAverage [get, set]
	Shift X average.
float	ShiftXDeviation [get, set]
	Shift X standard deviation.
float	ShiftXMin [get, set]
	Minimum Shift X.
float	ShiftXMax [get, set]
	Maximum Shift X.
float	ShiftYAverage [get, set]
	Shift Y average.
float	ShiftYDeviation [get, set]
	Shift Y standard deviation.
float	ShiftYMin [get, set]
	Minimum Shift Y.
float	ShiftYMax [get, set]
	Maximum Shift Y.
float	ForegroundAreaAverage [get, set]
	Foreground area average.
float	ForegroundAreaDeviation [get, set]
	Foreground area standard deviation.
float	BackgroundAreaAverage [get, set]
	Background area average.
float	BackgroundAreaDeviation [get, set]
	Background area standard deviation.
float	ForegroundSumAverage [get, set]
	Foreground sum average.
float	ForegroundSumDeviation [get, set]
	Foreground sum standard deviation.
float	BackgroundSumAverage [get, set]
	Background sum average.
float	BackgroundSumDeviation [get, set]
	Background sum standard deviation.
float	CorrelationAverage [get, set]
	Correlation average.
float	CorrelationDeviation [get, set]
	Correlation standard deviation.

Detailed Description

Holds all information related to a single character, such as nominal and average position, reference quality indicators,... During the learning phases, it also keeps the list of its constituent blobs.

The statistics available for each character are the average, standard deviation (unbiased), minimum and maximum computed on the corresponding parameters for all images for which EOCV.UpdateStatistics has been invoked after inspection. The average is only available when at least one set of results has been accumulated. The standard deviation is only available when at least two sets of results have been accumulated.

License(s): EasyOCV

Deprecated

Deprecated in version 26.2. Scheduled to be removed in version 27.6.

Constructor & Destructor Documentation

EOCVChar() [1/2]

eVision.EOCVChar.EOCVChar

(

)

Constructs an OCVChar context.

Default and copy constructors.

EOCVChar() [2/2]

eVision.EOCVChar.EOCVChar

(

eVision.EOCVChar

other

)

Constructs an OCVChar context.

Parameters

other

EOCVChar object to be copied.

Default and copy constructors.

Member Function Documentation

ResetParameters()

void eVision.EOCVChar.ResetParameters

(

)

Sets all character parameters to the undefined value for use before a EOCV.SetTextCharParameters or EOCV.ScatterTextsCharsParameters operation.

Property Documentation

BackgroundAreaAverage

float eVision.EOCVChar.BackgroundAreaAverage

getset

Background area average.

BackgroundAreaDeviation

float eVision.EOCVChar.BackgroundAreaDeviation

getset

Background area standard deviation.

BackgroundAreaTolerance

uint eVision.EOCVChar.BackgroundAreaTolerance

getset

Maximum allowed difference between the sample and template background areas.

BackgroundSumAverage

float eVision.EOCVChar.BackgroundSumAverage

getset

Background sum average.

BackgroundSumDeviation

float eVision.EOCVChar.BackgroundSumDeviation

getset

Background sum standard deviation.

BackgroundSumTolerance

float eVision.EOCVChar.BackgroundSumTolerance

getset

Maximum allowed difference between the sample and template background sums.

Correlation

float eVision.EOCVChar.Correlation

getset

Normalized correlation involving the template and sample character images.

CorrelationAverage

float eVision.EOCVChar.CorrelationAverage

getset

Correlation average.

CorrelationDeviation

float eVision.EOCVChar.CorrelationDeviation

getset

Correlation standard deviation.

CorrelationTolerance

float eVision.EOCVChar.CorrelationTolerance

getset

Maximum allowed difference between the normalized correlation and unity.

Diagnostics

uint eVision.EOCVChar.Diagnostics

getset

Logical combination (bitwise OR) of defects.

After inspection, each character is tagged with a logical combination of diagnostics, each corresponding to a kind of defect.

ForegroundAreaAverage

float eVision.EOCVChar.ForegroundAreaAverage

getset

Foreground area average.

ForegroundAreaDeviation

float eVision.EOCVChar.ForegroundAreaDeviation

getset

Foreground area standard deviation.

ForegroundAreaTolerance

uint eVision.EOCVChar.ForegroundAreaTolerance

getset

Maximum allowed difference between the sample and template foreground areas.

ForegroundSumAverage

float eVision.EOCVChar.ForegroundSumAverage

getset

Foreground sum average.

ForegroundSumDeviation

float eVision.EOCVChar.ForegroundSumDeviation

getset

Foreground sum standard deviation.

ForegroundSumTolerance

float eVision.EOCVChar.ForegroundSumTolerance

getset

Maximum allowed difference between the sample and template foreground sums.

LocationScoreAverage

float eVision.EOCVChar.LocationScoreAverage

getset

Location score average.

LocationScoreDeviation

float eVision.EOCVChar.LocationScoreDeviation

getset

Location score standard deviation.

LocationScoreTolerance

float eVision.EOCVChar.LocationScoreTolerance

getset

Allowed absolute difference between the template and sample scores.

When the sample value lies outside the acceptance interval, a character not found diagnostic is issued. During the location phase, a score is computed on the sample image. During learning, the same score is measured on the template image to serve as a reference. The closer the template and sample scores, the more successful the location. The location score is a first indication on the conformance of the inspected sample. In particular, a very small sample score may indicate that the character is absent.

MarginWidth

uint eVision.EOCVChar.MarginWidth

getset

Width of the extra space to be used around the characters bounding box (on all four sides) when computing a quality indicator.

NumContourPoints

uint eVision.EOCVChar.NumContourPoints

getset

Number of contour points of this character used for location.

The location process relies on points from the external contours of the character constituent blobs. The number of points to be used can be adjusted. The smaller this value, the faster the location, but a too small value can cause mismatches.

SampleBackgroundArea

uint eVision.EOCVChar.SampleBackgroundArea

getset

Number of background pixels of this character corresponding to a background pixel of the template character.

SampleBackgroundSum

float eVision.EOCVChar.SampleBackgroundSum

getset

Sum of the normalized gray-level values of the pixels of this character corresponding to a background pixel of the template character.

SampleForegroundArea

uint eVision.EOCVChar.SampleForegroundArea

getset

Number of foreground pixels of this character corresponding to a foreground pixel of the template character.

SampleForegroundSum

float eVision.EOCVChar.SampleForegroundSum

getset

Sum of the normalized gray-level values of the pixels of this character corresponding to a foreground pixel of the template character.

SampleLocationScore

float eVision.EOCVChar.SampleLocationScore

getset

Value of the location score measured on the sample during inspection.

During the location phase, a score is computed on the sample image. During learning, the same score is measured on the template image to serve as a reference. The closer the template and sample scores, the more successful the location. The location score is a first indication on the conformance of the inspected sample. In particular, a very small sample score may indicate that the character is absent.

Selected

int eVision.EOCVChar.Selected

getset

Selection state: TRUE when selected.

ShiftX

float eVision.EOCVChar.ShiftX

getset

Measured horizontal translation.

ShiftXAverage

float eVision.EOCVChar.ShiftXAverage

getset

Shift X average.

ShiftXBias

float eVision.EOCVChar.ShiftXBias

getset

Horizontal translation bias.

0 corresponds to the nominal position.

ShiftXDeviation

float eVision.EOCVChar.ShiftXDeviation

getset

Shift X standard deviation.

ShiftXMax

float eVision.EOCVChar.ShiftXMax

getset

Maximum Shift X.

ShiftXMin

float eVision.EOCVChar.ShiftXMin

getset

Minimum Shift X.

ShiftXStride

uint eVision.EOCVChar.ShiftXStride

getset

First pass stride for the horizontal translation.

ShiftXTolerance

float eVision.EOCVChar.ShiftXTolerance

getset

Horizontal translation tolerance.

ShiftY

float eVision.EOCVChar.ShiftY

getset

Measured vertical translation.

ShiftYAverage

float eVision.EOCVChar.ShiftYAverage

getset

Shift Y average.

ShiftYBias

float eVision.EOCVChar.ShiftYBias

getset

Vertical translation bias. 0 corresponds to the nominal position.

ShiftYDeviation

float eVision.EOCVChar.ShiftYDeviation

getset

Shift Y standard deviation.

ShiftYMax

float eVision.EOCVChar.ShiftYMax

getset

Maximum Shift Y.

ShiftYMin

float eVision.EOCVChar.ShiftYMin

getset

Minimum Shift Y.

ShiftYStride

uint eVision.EOCVChar.ShiftYStride

getset

First pass stride for the vertical translation.

ShiftYTolerance

float eVision.EOCVChar.ShiftYTolerance

getset

Vertical translation tolerance.

TemplateBackgroundArea

uint eVision.EOCVChar.TemplateBackgroundArea

getset

Number of pixels in the background of this character.

TemplateBackgroundSum

float eVision.EOCVChar.TemplateBackgroundSum

getset

Sum of the normalized gray-level values of the background pixels of this character.

TemplateForegroundArea

uint eVision.EOCVChar.TemplateForegroundArea

getset

Number of pixels in the template foreground of this character.

TemplateForegroundSum

float eVision.EOCVChar.TemplateForegroundSum

getset

Sum of the normalized gray-level values of the foreground pixels of this character.

TemplateLocationScore

float eVision.EOCVChar.TemplateLocationScore

getset

Value of the location score measured on the template during learning.

If necessary, this value may be set explicitly. During the location phase, a score is computed on the sample image. During learning, the same score is measured on the template image to serve as a reference. The closer the template and sample scores, the more successful the location. The location score is a first indication on the conformance of the inspected sample. In particular, a very small sample score may indicate that the character is absent.

WhiteOnBlack

bool eVision.EOCVChar.WhiteOnBlack

getset

Character contrast: true for light characters on a dark background.