eVision.EOCVText Class Reference

Holds all information related to a single piece of text, such as nominal and average position, reference quality indicators,... It also keeps the list of its constituent characters. More...

Inheritance diagram for eVision.EOCVText:

Collaboration diagram for eVision.EOCVText:

Public Member Functions
	EOCVText ()
	Constructs an OCVText context.
	EOCVText (eVision.EOCVText ocvText)
	Constructs an OCVText context.
void	ResetParameters ()
	Sets all text parameters to the undefined value for use before a EOCV.SetTextParameters or EOCV.ScatterTextsParameters operation.

Properties
int	IsotropicScaling [get, set]
	Flag indicating whether the scaling degree of freedom should be considered isotropic (ScaleX and ScaleY identical) or not.
int	Selected [get, set]
	Selection state. TRUE when selected.
float	TemplateLocationScore [get, set]
	Value of the location score measured on the template during learning. If necessary, this value may be set explicitly.
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	ShiftXBias [get, set]
	Horizontal translation bias.
float	ShiftXTolerance [get, set]
	Horizontal translation tolerance.
float	ShiftYBias [get, set]
	Vertical translation bias.
float	ShiftYTolerance [get, set]
	Vertical translation tolerance.
float	ScaleXBias [get, set]
	Horizontal scaling bias.
float	ScaleXTolerance [get, set]
	Horizontal scaling tolerance.
float	ScaleYBias [get, set]
	Vertical scaling bias.
float	ScaleYTolerance [get, set]
	Vertical scaling tolerance.
float	ShearBias [get, set]
	Shearing bias.
float	ShearTolerance [get, set]
	Shearing tolerance.
float	SkewBias [get, set]
	Rotation bias.
float	SkewTolerance [get, set]
	Rotation tolerance.
float	ScaleX [get, set]
	Measured horizontal scaling, expressed as a dimensionless ratio.
float	ScaleY [get, set]
	Measured vertical scaling, expressed as a dimensionless ratio.
float	Shear [get, set]
	Measured shearing, clockwise from the vertical direction, expressed in the current angle unit.
float	Skew [get, set]
	Measured rotation, clockwise from the horizontal direction, expressed in the current angle unit.
float	ShiftX [get, set]
	Measured horizontal translation, in pixels.
float	ShiftY [get, set]
	Measured vertical translation, in pixels.
float	TemplateForegroundSum [get, set]
	Sum of the normalized gray-level values of the foreground pixels of the characters of this text.
float	SampleForegroundSum [get, set]
	Sum of the normalized gray-level values of the pixels of this text corresponding to a foreground pixel of the characters of the template text.
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 the characters of this text.
float	SampleBackgroundSum [get, set]
	Sum of the normalized gray-level values of the pixels of this text corresponding to a background pixel of the characters of the template text.
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 images of the characters of this text.
float	CorrelationTolerance [get, set]
	Maximum allowed difference between the normalized correlation and unity.
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 Y.
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	ShearAverage [get, set]
	Shear average.
float	ShearDeviation [get, set]
	Shear standard deviation.
float	ShearMin [get, set]
	Minimum shear.
float	ShearMax [get, set]
	Maximum shear.
float	SkewAverage [get, set]
	Skew average.
float	SkewDeviation [get, set]
	Skew standard deviation.
float	SkewMin [get, set]
	Minimum skew.
float	SkewMax [get, set]
	Maximum skew.
float	ScaleXAverage [get, set]
	Scale X average.
float	ScaleXDeviation [get, set]
	Scale X standard deviation.
float	ScaleXMin [get, set]
	Minimum X-scale.
float	ScaleXMax [get, set]
	Maximum Y-scale.
float	ScaleYAverage [get, set]
	Scale Y average.
float	ScaleYDeviation [get, set]
	Scale Y standard deviation.
float	ScaleYMin [get, set]
	Minimum Y-scale.
float	ScaleYMax [get, set]
	Maximum Y-scale.
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.
float	LocationScoreAverage [get, set]
	Location score average.
float	LocationScoreDeviation [get, set]
	Location score standard deviation.
uint	NumContourPoints [get, set]
	Number of contour points used for location of this text.
uint	ShiftXStride [get, set]
	First pass stride for the horizontal translation.
uint	ShiftYStride [get, set]
	First pass stride for the vertical translation.
uint	ScaleXCount [get, set]
	Number of values to be tried in the Bias +/- Tolerance range, bounds included.
uint	ScaleYCount [get, set]
	Number of values to be tried in the Bias +/- Tolerance range, bounds included.
uint	ShearCount [get, set]
	Number of values to be tried in the Bias +/- Tolerance range, bounds included.
uint	SkewCount [get, set]
	Number of values to be tried in the Bias +/- Tolerance range, bounds included.
uint	Diagnostics [get, set]
	Logical combination (bitwise OR) of defects.
uint	MarginWidth [get, set]
	Unused.
uint	TemplateForegroundArea [get, set]
	Number of pixels in the foreground of all characters of this text.
uint	SampleForegroundArea [get, set]
	Number of foreground pixels of this text corresponding to a foreground pixel of the characters of the template text.
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 the characters of this text.
uint	SampleBackgroundArea [get, set]
	Number of background pixels of this text corresponding to a background pixel of the characters of the template text.
uint	BackgroundAreaTolerance [get, set]
	Maximum allowed difference between the sample and template background areas.

Detailed Description

Holds all information related to a single piece of text, such as nominal and average position, reference quality indicators,... It also keeps the list of its constituent characters.

Each text can be translated horizontally and vertically, rotated, scaled horizontally and vertically and sheared with respect to its nominal position, to cope with mechanical displacement of the marking device. Location is performed in the range Bias +/- Tolerance around the nominal position. To speed up location, a two pass search may be performed, first with a large stride, then with a unit stride.

Note. The stride parameters apply to the two translation degrees of freedom only. A set of parameters are computed on demand (see Inspection Options) during inspection. The values of these parameters are used to detect defects of various kinds by checking that they remain in a given tolerance interval. If not, a diagnostic is issued. Note that the quality indicators associated with the texts are the sums of the corresponding parameters for each of the constituent characters. The statistics available for each text 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

EOCVText() [1/2]

eVision.EOCVText.EOCVText

(

)

Constructs an OCVText context.

Default and copy constructors.

EOCVText() [2/2]

eVision.EOCVText.EOCVText

(

eVision.EOCVText

ocvText

)

Constructs an OCVText context.

Parameters

ocvText

EOCVText object to be copied.

Default and copy constructors.

Member Function Documentation

ResetParameters()

void eVision.EOCVText.ResetParameters

(

)

Sets all text parameters to the undefined value for use before a EOCV.SetTextParameters or EOCV.ScatterTextsParameters operation.

Property Documentation

BackgroundAreaAverage

float eVision.EOCVText.BackgroundAreaAverage

getset

Background area average.

BackgroundAreaDeviation

float eVision.EOCVText.BackgroundAreaDeviation

getset

Background area standard deviation.

BackgroundAreaTolerance

uint eVision.EOCVText.BackgroundAreaTolerance

getset

Maximum allowed difference between the sample and template background areas.

BackgroundSumAverage

float eVision.EOCVText.BackgroundSumAverage

getset

Background sum average.

BackgroundSumDeviation

float eVision.EOCVText.BackgroundSumDeviation

getset

Background sum standard deviation.

BackgroundSumTolerance

float eVision.EOCVText.BackgroundSumTolerance

getset

Maximum allowed difference between the sample and template background sums.

Correlation

float eVision.EOCVText.Correlation

getset

Normalized correlation involving the template and sample images of the characters of this text.

CorrelationAverage

float eVision.EOCVText.CorrelationAverage

getset

Correlation average.

CorrelationDeviation

float eVision.EOCVText.CorrelationDeviation

getset

Correlation standard deviation.

CorrelationTolerance

float eVision.EOCVText.CorrelationTolerance

getset

Maximum allowed difference between the normalized correlation and unity.

Diagnostics

uint eVision.EOCVText.Diagnostics

getset

Logical combination (bitwise OR) of defects.

After inspection, each text is tagged with a logical combination of diagnostics, each corresponding to a kind of defect. The defects of the characters belonging to this texts are also added to this combination.

ForegroundAreaAverage

float eVision.EOCVText.ForegroundAreaAverage

getset

Foreground area average.

ForegroundAreaDeviation

float eVision.EOCVText.ForegroundAreaDeviation

getset

Foreground area standard deviation.

ForegroundAreaTolerance

uint eVision.EOCVText.ForegroundAreaTolerance

getset

Maximum allowed difference between the sample and template foreground areas.

ForegroundSumAverage

float eVision.EOCVText.ForegroundSumAverage

getset

Foreground sum average.

ForegroundSumDeviation

float eVision.EOCVText.ForegroundSumDeviation

getset

Foreground sum standard deviation.

ForegroundSumTolerance

float eVision.EOCVText.ForegroundSumTolerance

getset

Maximum allowed difference between the sample and template foreground sums.

IsotropicScaling

int eVision.EOCVText.IsotropicScaling

getset

Flag indicating whether the scaling degree of freedom should be considered isotropic (ScaleX and ScaleY identical) or not.

In most cases, isotropic scaling (default mode), is recommended. Isotropic scaling executes faster and is more realistic. In case of isotropic scaling search, the ScaleY... values are meaningless.

LocationScoreAverage

float eVision.EOCVText.LocationScoreAverage

getset

Location score average.

LocationScoreDeviation

float eVision.EOCVText.LocationScoreDeviation

getset

Location score standard deviation.

LocationScoreTolerance

float eVision.EOCVText.LocationScoreTolerance

getset

Allowed absolute difference between the template and sample scores.

When the sample value lies outside the acceptance interval, a text not found diagnostic is issued.

MarginWidth

uint eVision.EOCVText.MarginWidth

getset

Unused.

NumContourPoints

uint eVision.EOCVText.NumContourPoints

getset

Number of contour points used for location of this text.

SampleBackgroundArea

uint eVision.EOCVText.SampleBackgroundArea

getset

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

SampleBackgroundSum

float eVision.EOCVText.SampleBackgroundSum

getset

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

SampleForegroundArea

uint eVision.EOCVText.SampleForegroundArea

getset

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

SampleForegroundSum

float eVision.EOCVText.SampleForegroundSum

getset

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

SampleLocationScore

float eVision.EOCVText.SampleLocationScore

getset

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

ScaleX

float eVision.EOCVText.ScaleX

getset

Measured horizontal scaling, expressed as a dimensionless ratio.

ScaleXAverage

float eVision.EOCVText.ScaleXAverage

getset

Scale X average.

ScaleXBias

float eVision.EOCVText.ScaleXBias

getset

Horizontal scaling bias.

0 corresponds to the nominal, true scale factor.

ScaleXCount

uint eVision.EOCVText.ScaleXCount

getset

Number of values to be tried in the Bias +/- Tolerance range, bounds included.

ScaleXDeviation

float eVision.EOCVText.ScaleXDeviation

getset

Scale X standard deviation.

ScaleXMax

float eVision.EOCVText.ScaleXMax

getset

Maximum Y-scale.

ScaleXMin

float eVision.EOCVText.ScaleXMin

getset

Minimum X-scale.

ScaleXTolerance

float eVision.EOCVText.ScaleXTolerance

getset

Horizontal scaling tolerance.

ScaleY

float eVision.EOCVText.ScaleY

getset

Measured vertical scaling, expressed as a dimensionless ratio.

ScaleYAverage

float eVision.EOCVText.ScaleYAverage

getset

Scale Y average.

ScaleYBias

float eVision.EOCVText.ScaleYBias

getset

Vertical scaling bias.

0 corresponds to the nominal, true scale factor.

ScaleYCount

uint eVision.EOCVText.ScaleYCount

getset

Number of values to be tried in the Bias +/- Tolerance range, bounds included.

ScaleYDeviation

float eVision.EOCVText.ScaleYDeviation

getset

Scale Y standard deviation.

ScaleYMax

float eVision.EOCVText.ScaleYMax

getset

Maximum Y-scale.

ScaleYMin

float eVision.EOCVText.ScaleYMin

getset

Minimum Y-scale.

ScaleYTolerance

float eVision.EOCVText.ScaleYTolerance

getset

Vertical scaling tolerance.

Selected

int eVision.EOCVText.Selected

getset

Selection state. TRUE when selected.

Shear

float eVision.EOCVText.Shear

getset

Measured shearing, clockwise from the vertical direction, expressed in the current angle unit.

ShearAverage

float eVision.EOCVText.ShearAverage

getset

Shear average.

ShearBias

float eVision.EOCVText.ShearBias

getset

Shearing bias.

0 corresponds to the nominal, upright position.

ShearCount

uint eVision.EOCVText.ShearCount

getset

Number of values to be tried in the Bias +/- Tolerance range, bounds included.

ShearDeviation

float eVision.EOCVText.ShearDeviation

getset

Shear standard deviation.

ShearMax

float eVision.EOCVText.ShearMax

getset

Maximum shear.

ShearMin

float eVision.EOCVText.ShearMin

getset

Minimum shear.

ShearTolerance

float eVision.EOCVText.ShearTolerance

getset

Shearing tolerance.

ShiftX

float eVision.EOCVText.ShiftX

getset

Measured horizontal translation, in pixels.

ShiftXAverage

float eVision.EOCVText.ShiftXAverage

getset

Shift X average.

ShiftXBias

float eVision.EOCVText.ShiftXBias

getset

Horizontal translation bias.

0 corresponds to the nominal position.

ShiftXDeviation

float eVision.EOCVText.ShiftXDeviation

getset

Shift X standard deviation.

ShiftXMax

float eVision.EOCVText.ShiftXMax

getset

Maximum Shift Y.

ShiftXMin

float eVision.EOCVText.ShiftXMin

getset

Minimum Shift X.

ShiftXStride

uint eVision.EOCVText.ShiftXStride

getset

First pass stride for the horizontal translation.

ShiftXTolerance

float eVision.EOCVText.ShiftXTolerance

getset

Horizontal translation tolerance.

ShiftY

float eVision.EOCVText.ShiftY

getset

Measured vertical translation, in pixels.

ShiftYAverage

float eVision.EOCVText.ShiftYAverage

getset

Shift Y average.

ShiftYBias

float eVision.EOCVText.ShiftYBias

getset

Vertical translation bias.

0 corresponds to the nominal position.

ShiftYDeviation

float eVision.EOCVText.ShiftYDeviation

getset

Shift Y standard deviation.

ShiftYMax

float eVision.EOCVText.ShiftYMax

getset

Maximum Shift Y.

ShiftYMin

float eVision.EOCVText.ShiftYMin

getset

Minimum Shift Y.

ShiftYStride

uint eVision.EOCVText.ShiftYStride

getset

First pass stride for the vertical translation.

ShiftYTolerance

float eVision.EOCVText.ShiftYTolerance

getset

Vertical translation tolerance.

Skew

float eVision.EOCVText.Skew

getset

Measured rotation, clockwise from the horizontal direction, expressed in the current angle unit.

SkewAverage

float eVision.EOCVText.SkewAverage

getset

Skew average.

SkewBias

float eVision.EOCVText.SkewBias

getset

Rotation bias.

0 corresponds to the nominal, horizontal position.

SkewCount

uint eVision.EOCVText.SkewCount

getset

Number of values to be tried in the Bias +/- Tolerance range, bounds included.

SkewDeviation

float eVision.EOCVText.SkewDeviation

getset

Skew standard deviation.

SkewMax

float eVision.EOCVText.SkewMax

getset

Maximum skew.

SkewMin

float eVision.EOCVText.SkewMin

getset

Minimum skew.

SkewTolerance

float eVision.EOCVText.SkewTolerance

getset

Rotation tolerance.

TemplateBackgroundArea

uint eVision.EOCVText.TemplateBackgroundArea

getset

Number of pixels in the background of the characters of this text.

TemplateBackgroundSum

float eVision.EOCVText.TemplateBackgroundSum

getset

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

TemplateForegroundArea

uint eVision.EOCVText.TemplateForegroundArea

getset

Number of pixels in the foreground of all characters of this text.

TemplateForegroundSum

float eVision.EOCVText.TemplateForegroundSum

getset

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

TemplateLocationScore

float eVision.EOCVText.TemplateLocationScore

getset

Value of the location score measured on the template during learning. If necessary, this value may be set explicitly.