eVision Python API
Loading...
Searching...
No Matches
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...

Public Member Functions

None __init__ (self)
 Constructs an OCVChar context.
None __init__ (self, eVision.EOCVChar other)
 Constructs an OCVChar context.
None ResetParameters (self)
 Sets all character parameters to the undefined value for use before a eVision.EOCV.SetTextCharParameters or eVision.EOCV.ScatterTextsCharsParameters operation.

Properties

 WhiteOnBlack = property(_WhiteOnBlack__getter, _WhiteOnBlack__setter)
 Character contrast: true for light characters on a dark background.
 Selected = property(_Selected__getter, _Selected__setter)
 Selection state: TRUE when selected.
 NumContourPoints = property(_NumContourPoints__getter, _NumContourPoints__setter)
 Number of contour points of this character used for location.
 TemplateLocationScore = property(_TemplateLocationScore__getter, _TemplateLocationScore__setter)
 Value of the location score measured on the template during learning.
 SampleLocationScore = property(_SampleLocationScore__getter, _SampleLocationScore__setter)
 Value of the location score measured on the sample during inspection.
 LocationScoreTolerance = property(_LocationScoreTolerance__getter, _LocationScoreTolerance__setter)
 Allowed absolute difference between the template and sample scores.
 ShiftX = property(_ShiftX__getter, _ShiftX__setter)
 Measured horizontal translation.
 ShiftXBias = property(_ShiftXBias__getter, _ShiftXBias__setter)
 Horizontal translation bias.
 ShiftXTolerance = property(_ShiftXTolerance__getter, _ShiftXTolerance__setter)
 Horizontal translation tolerance.
 ShiftXStride = property(_ShiftXStride__getter, _ShiftXStride__setter)
 First pass stride for the horizontal translation.
 ShiftY = property(_ShiftY__getter, _ShiftY__setter)
 Measured vertical translation.
 ShiftYBias = property(_ShiftYBias__getter, _ShiftYBias__setter)
 Vertical translation bias.
 ShiftYTolerance = property(_ShiftYTolerance__getter, _ShiftYTolerance__setter)
 Vertical translation tolerance.
 ShiftYStride = property(_ShiftYStride__getter, _ShiftYStride__setter)
 First pass stride for the vertical translation.
 Diagnostics = property(_Diagnostics__getter, _Diagnostics__setter)
 Logical combination (bitwise OR) of defects.
 MarginWidth = property(_MarginWidth__getter, _MarginWidth__setter)
 Width of the extra space to be used around the characters bounding box (on all four sides) when computing a quality indicator.
 TemplateForegroundArea = property(_TemplateForegroundArea__getter, _TemplateForegroundArea__setter)
 Number of pixels in the template foreground of this character.
 SampleForegroundArea = property(_SampleForegroundArea__getter, _SampleForegroundArea__setter)
 Number of foreground pixels of this character corresponding to a foreground pixel of the template character.
 ForegroundAreaTolerance = property(_ForegroundAreaTolerance__getter, _ForegroundAreaTolerance__setter)
 Maximum allowed difference between the sample and template foreground areas.
 TemplateBackgroundArea = property(_TemplateBackgroundArea__getter, _TemplateBackgroundArea__setter)
 Number of pixels in the background of this character.
 SampleBackgroundArea = property(_SampleBackgroundArea__getter, _SampleBackgroundArea__setter)
 Number of background pixels of this character corresponding to a background pixel of the template character.
 BackgroundAreaTolerance = property(_BackgroundAreaTolerance__getter, _BackgroundAreaTolerance__setter)
 Maximum allowed difference between the sample and template background areas.
 TemplateForegroundSum = property(_TemplateForegroundSum__getter, _TemplateForegroundSum__setter)
 Sum of the normalized gray-level values of the foreground pixels of this character.
 SampleForegroundSum = property(_SampleForegroundSum__getter, _SampleForegroundSum__setter)
 Sum of the normalized gray-level values of the pixels of this character corresponding to a foreground pixel of the template character.
 ForegroundSumTolerance = property(_ForegroundSumTolerance__getter, _ForegroundSumTolerance__setter)
 Maximum allowed difference between the sample and template foreground sums.
 TemplateBackgroundSum = property(_TemplateBackgroundSum__getter, _TemplateBackgroundSum__setter)
 Sum of the normalized gray-level values of the background pixels of this character.
 SampleBackgroundSum = property(_SampleBackgroundSum__getter, _SampleBackgroundSum__setter)
 Sum of the normalized gray-level values of the pixels of this character corresponding to a background pixel of the template character.
 BackgroundSumTolerance = property(_BackgroundSumTolerance__getter, _BackgroundSumTolerance__setter)
 Maximum allowed difference between the sample and template background sums.
 Correlation = property(_Correlation__getter, _Correlation__setter)
 Normalized correlation involving the template and sample character images.
 CorrelationTolerance = property(_CorrelationTolerance__getter, _CorrelationTolerance__setter)
 Maximum allowed difference between the normalized correlation and unity.
 LocationScoreAverage = property(_LocationScoreAverage__getter, _LocationScoreAverage__setter)
 Location score average.
 LocationScoreDeviation = property(_LocationScoreDeviation__getter, _LocationScoreDeviation__setter)
 Location score standard deviation.
 ShiftXAverage = property(_ShiftXAverage__getter, _ShiftXAverage__setter)
 Shift X average.
 ShiftXDeviation = property(_ShiftXDeviation__getter, _ShiftXDeviation__setter)
 Shift X standard deviation.
 ShiftXMin = property(_ShiftXMin__getter, _ShiftXMin__setter)
 Minimum Shift X.
 ShiftXMax = property(_ShiftXMax__getter, _ShiftXMax__setter)
 Maximum Shift X.
 ShiftYAverage = property(_ShiftYAverage__getter, _ShiftYAverage__setter)
 Shift Y average.
 ShiftYDeviation = property(_ShiftYDeviation__getter, _ShiftYDeviation__setter)
 Shift Y standard deviation.
 ShiftYMin = property(_ShiftYMin__getter, _ShiftYMin__setter)
 Minimum Shift Y.
 ShiftYMax = property(_ShiftYMax__getter, _ShiftYMax__setter)
 Maximum Shift Y.
 ForegroundAreaAverage = property(_ForegroundAreaAverage__getter, _ForegroundAreaAverage__setter)
 Foreground area average.
 ForegroundAreaDeviation = property(_ForegroundAreaDeviation__getter, _ForegroundAreaDeviation__setter)
 Foreground area standard deviation.
 BackgroundAreaAverage = property(_BackgroundAreaAverage__getter, _BackgroundAreaAverage__setter)
 Background area average.
 BackgroundAreaDeviation = property(_BackgroundAreaDeviation__getter, _BackgroundAreaDeviation__setter)
 Background area standard deviation.
 ForegroundSumAverage = property(_ForegroundSumAverage__getter, _ForegroundSumAverage__setter)
 Foreground sum average.
 ForegroundSumDeviation = property(_ForegroundSumDeviation__getter, _ForegroundSumDeviation__setter)
 Foreground sum standard deviation.
 BackgroundSumAverage = property(_BackgroundSumAverage__getter, _BackgroundSumAverage__setter)
 Background sum average.
 BackgroundSumDeviation = property(_BackgroundSumDeviation__getter, _BackgroundSumDeviation__setter)
 Background sum standard deviation.
 CorrelationAverage = property(_CorrelationAverage__getter, _CorrelationAverage__setter)
 Correlation average.
 CorrelationDeviation = property(_CorrelationDeviation__getter, _CorrelationDeviation__setter)
 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.

Remarks:

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 eVision.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

◆ __init__() [1/2]

None eVision.EOCVChar.__init__ ( self)

Constructs an OCVChar context.

Remarks:

Default and copy constructors.

◆ __init__() [2/2]

None eVision.EOCVChar.__init__ ( self,
eVision.EOCVChar other )

Constructs an OCVChar context.

Remarks:

Default and copy constructors.

Parameters
othereVision.EOCVChar object to be copied.

Member Function Documentation

◆ ResetParameters()

None eVision.EOCVChar.ResetParameters ( self)

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

Property Documentation

◆ BackgroundAreaAverage

eVision.EOCVChar.BackgroundAreaAverage = property(_BackgroundAreaAverage__getter, _BackgroundAreaAverage__setter)
static

Background area average.

◆ BackgroundAreaDeviation

eVision.EOCVChar.BackgroundAreaDeviation = property(_BackgroundAreaDeviation__getter, _BackgroundAreaDeviation__setter)
static

Background area standard deviation.

◆ BackgroundAreaTolerance

eVision.EOCVChar.BackgroundAreaTolerance = property(_BackgroundAreaTolerance__getter, _BackgroundAreaTolerance__setter)
static

Maximum allowed difference between the sample and template background areas.

◆ BackgroundSumAverage

eVision.EOCVChar.BackgroundSumAverage = property(_BackgroundSumAverage__getter, _BackgroundSumAverage__setter)
static

Background sum average.

◆ BackgroundSumDeviation

eVision.EOCVChar.BackgroundSumDeviation = property(_BackgroundSumDeviation__getter, _BackgroundSumDeviation__setter)
static

Background sum standard deviation.

◆ BackgroundSumTolerance

eVision.EOCVChar.BackgroundSumTolerance = property(_BackgroundSumTolerance__getter, _BackgroundSumTolerance__setter)
static

Maximum allowed difference between the sample and template background sums.

◆ Correlation

eVision.EOCVChar.Correlation = property(_Correlation__getter, _Correlation__setter)
static

Normalized correlation involving the template and sample character images.

◆ CorrelationAverage

eVision.EOCVChar.CorrelationAverage = property(_CorrelationAverage__getter, _CorrelationAverage__setter)
static

Correlation average.

◆ CorrelationDeviation

eVision.EOCVChar.CorrelationDeviation = property(_CorrelationDeviation__getter, _CorrelationDeviation__setter)
static

Correlation standard deviation.

◆ CorrelationTolerance

eVision.EOCVChar.CorrelationTolerance = property(_CorrelationTolerance__getter, _CorrelationTolerance__setter)
static

Maximum allowed difference between the normalized correlation and unity.

◆ Diagnostics

eVision.EOCVChar.Diagnostics = property(_Diagnostics__getter, _Diagnostics__setter)
static

Logical combination (bitwise OR) of defects.

Remarks:

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

◆ ForegroundAreaAverage

eVision.EOCVChar.ForegroundAreaAverage = property(_ForegroundAreaAverage__getter, _ForegroundAreaAverage__setter)
static

Foreground area average.

◆ ForegroundAreaDeviation

eVision.EOCVChar.ForegroundAreaDeviation = property(_ForegroundAreaDeviation__getter, _ForegroundAreaDeviation__setter)
static

Foreground area standard deviation.

◆ ForegroundAreaTolerance

eVision.EOCVChar.ForegroundAreaTolerance = property(_ForegroundAreaTolerance__getter, _ForegroundAreaTolerance__setter)
static

Maximum allowed difference between the sample and template foreground areas.

◆ ForegroundSumAverage

eVision.EOCVChar.ForegroundSumAverage = property(_ForegroundSumAverage__getter, _ForegroundSumAverage__setter)
static

Foreground sum average.

◆ ForegroundSumDeviation

eVision.EOCVChar.ForegroundSumDeviation = property(_ForegroundSumDeviation__getter, _ForegroundSumDeviation__setter)
static

Foreground sum standard deviation.

◆ ForegroundSumTolerance

eVision.EOCVChar.ForegroundSumTolerance = property(_ForegroundSumTolerance__getter, _ForegroundSumTolerance__setter)
static

Maximum allowed difference between the sample and template foreground sums.

◆ LocationScoreAverage

eVision.EOCVChar.LocationScoreAverage = property(_LocationScoreAverage__getter, _LocationScoreAverage__setter)
static

Location score average.

◆ LocationScoreDeviation

eVision.EOCVChar.LocationScoreDeviation = property(_LocationScoreDeviation__getter, _LocationScoreDeviation__setter)
static

Location score standard deviation.

◆ LocationScoreTolerance

eVision.EOCVChar.LocationScoreTolerance = property(_LocationScoreTolerance__getter, _LocationScoreTolerance__setter)
static

Allowed absolute difference between the template and sample scores.

Remarks:

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

eVision.EOCVChar.MarginWidth = property(_MarginWidth__getter, _MarginWidth__setter)
static

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

◆ NumContourPoints

eVision.EOCVChar.NumContourPoints = property(_NumContourPoints__getter, _NumContourPoints__setter)
static

Number of contour points of this character used for location.

Remarks:

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

eVision.EOCVChar.SampleBackgroundArea = property(_SampleBackgroundArea__getter, _SampleBackgroundArea__setter)
static

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

◆ SampleBackgroundSum

eVision.EOCVChar.SampleBackgroundSum = property(_SampleBackgroundSum__getter, _SampleBackgroundSum__setter)
static

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

◆ SampleForegroundArea

eVision.EOCVChar.SampleForegroundArea = property(_SampleForegroundArea__getter, _SampleForegroundArea__setter)
static

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

◆ SampleForegroundSum

eVision.EOCVChar.SampleForegroundSum = property(_SampleForegroundSum__getter, _SampleForegroundSum__setter)
static

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

◆ SampleLocationScore

eVision.EOCVChar.SampleLocationScore = property(_SampleLocationScore__getter, _SampleLocationScore__setter)
static

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

Remarks:

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

eVision.EOCVChar.Selected = property(_Selected__getter, _Selected__setter)
static

Selection state: TRUE when selected.

◆ ShiftX

eVision.EOCVChar.ShiftX = property(_ShiftX__getter, _ShiftX__setter)
static

Measured horizontal translation.

◆ ShiftXAverage

eVision.EOCVChar.ShiftXAverage = property(_ShiftXAverage__getter, _ShiftXAverage__setter)
static

Shift X average.

◆ ShiftXBias

eVision.EOCVChar.ShiftXBias = property(_ShiftXBias__getter, _ShiftXBias__setter)
static

Horizontal translation bias.

Remarks:

0 corresponds to the nominal position.

◆ ShiftXDeviation

eVision.EOCVChar.ShiftXDeviation = property(_ShiftXDeviation__getter, _ShiftXDeviation__setter)
static

Shift X standard deviation.

◆ ShiftXMax

eVision.EOCVChar.ShiftXMax = property(_ShiftXMax__getter, _ShiftXMax__setter)
static

Maximum Shift X.

◆ ShiftXMin

eVision.EOCVChar.ShiftXMin = property(_ShiftXMin__getter, _ShiftXMin__setter)
static

Minimum Shift X.

◆ ShiftXStride

eVision.EOCVChar.ShiftXStride = property(_ShiftXStride__getter, _ShiftXStride__setter)
static

First pass stride for the horizontal translation.

◆ ShiftXTolerance

eVision.EOCVChar.ShiftXTolerance = property(_ShiftXTolerance__getter, _ShiftXTolerance__setter)
static

Horizontal translation tolerance.

◆ ShiftY

eVision.EOCVChar.ShiftY = property(_ShiftY__getter, _ShiftY__setter)
static

Measured vertical translation.

◆ ShiftYAverage

eVision.EOCVChar.ShiftYAverage = property(_ShiftYAverage__getter, _ShiftYAverage__setter)
static

Shift Y average.

◆ ShiftYBias

eVision.EOCVChar.ShiftYBias = property(_ShiftYBias__getter, _ShiftYBias__setter)
static

Vertical translation bias.

0 corresponds to the nominal position.

◆ ShiftYDeviation

eVision.EOCVChar.ShiftYDeviation = property(_ShiftYDeviation__getter, _ShiftYDeviation__setter)
static

Shift Y standard deviation.

◆ ShiftYMax

eVision.EOCVChar.ShiftYMax = property(_ShiftYMax__getter, _ShiftYMax__setter)
static

Maximum Shift Y.

◆ ShiftYMin

eVision.EOCVChar.ShiftYMin = property(_ShiftYMin__getter, _ShiftYMin__setter)
static

Minimum Shift Y.

◆ ShiftYStride

eVision.EOCVChar.ShiftYStride = property(_ShiftYStride__getter, _ShiftYStride__setter)
static

First pass stride for the vertical translation.

◆ ShiftYTolerance

eVision.EOCVChar.ShiftYTolerance = property(_ShiftYTolerance__getter, _ShiftYTolerance__setter)
static

Vertical translation tolerance.

◆ TemplateBackgroundArea

eVision.EOCVChar.TemplateBackgroundArea = property(_TemplateBackgroundArea__getter, _TemplateBackgroundArea__setter)
static

Number of pixels in the background of this character.

◆ TemplateBackgroundSum

eVision.EOCVChar.TemplateBackgroundSum = property(_TemplateBackgroundSum__getter, _TemplateBackgroundSum__setter)
static

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

◆ TemplateForegroundArea

eVision.EOCVChar.TemplateForegroundArea = property(_TemplateForegroundArea__getter, _TemplateForegroundArea__setter)
static

Number of pixels in the template foreground of this character.

◆ TemplateForegroundSum

eVision.EOCVChar.TemplateForegroundSum = property(_TemplateForegroundSum__getter, _TemplateForegroundSum__setter)
static

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

◆ TemplateLocationScore

eVision.EOCVChar.TemplateLocationScore = property(_TemplateLocationScore__getter, _TemplateLocationScore__setter)
static

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

Remarks:

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

eVision.EOCVChar.WhiteOnBlack = property(_WhiteOnBlack__getter, _WhiteOnBlack__setter)
static

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