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

#include <eVision/EasyOcv/EOCVText.h>

Collaboration diagram for eVision::EOCVText:

Public Member Functions
	EOCVText ()
	Constructs an OCVText context.
	EOCVText (const eVision::EOCVText &ocvText)
	Constructs an OCVText context.
virtual	~EOCVText () throw ()
eVision::EOCVText &	operator= (const eVision::EOCVText &other)
	Copies all the data from another EOCVText object into the current EOCVText object.
void	SetIsotropicScaling (int isotropicScaling)
	Flag indicating whether the scaling degree of freedom should be considered isotropic (ScaleX and ScaleY identical) or not.
int	GetIsotropicScaling ()
	Flag indicating whether the scaling degree of freedom should be considered isotropic (ScaleX and ScaleY identical) or not.
void	ResetParameters ()
	Sets all text parameters to the undefined value for use before a EOCV::SetTextParameters or EOCV::ScatterTextsParameters operation.
void	SetSelected (int selected)
	Selection state. TRUE when selected.
int	GetSelected ()
	Selection state. TRUE when selected.
float	GetTemplateLocationScore () const
	Value of the location score measured on the template during learning. If necessary, this value may be set explicitly.
void	SetTemplateLocationScore (float value)
	Value of the location score measured on the template during learning. If necessary, this value may be set explicitly.
float	GetSampleLocationScore () const
	Value of the location score measured on the sample during inspection.
void	SetSampleLocationScore (float value)
	Value of the location score measured on the sample during inspection.
float	GetLocationScoreTolerance () const
	Allowed absolute difference between the template and sample scores.
void	SetLocationScoreTolerance (float value)
	Allowed absolute difference between the template and sample scores.
float	GetShiftXBias () const
	Horizontal translation bias.
void	SetShiftXBias (float value)
	Horizontal translation bias.
float	GetShiftXTolerance () const
	Horizontal translation tolerance.
void	SetShiftXTolerance (float value)
	Horizontal translation tolerance.
float	GetShiftYBias () const
	Vertical translation bias.
void	SetShiftYBias (float value)
	Vertical translation bias.
float	GetShiftYTolerance () const
	Vertical translation tolerance.
void	SetShiftYTolerance (float value)
	Vertical translation tolerance.
float	GetScaleXBias () const
	Horizontal scaling bias.
void	SetScaleXBias (float value)
	Horizontal scaling bias.
float	GetScaleXTolerance () const
	Horizontal scaling tolerance.
void	SetScaleXTolerance (float value)
	Horizontal scaling tolerance.
float	GetScaleYBias () const
	Vertical scaling bias.
void	SetScaleYBias (float value)
	Vertical scaling bias.
float	GetScaleYTolerance () const
	Vertical scaling tolerance.
void	SetScaleYTolerance (float value)
	Vertical scaling tolerance.
float	GetShearBias () const
	Shearing bias.
void	SetShearBias (float value)
	Shearing bias.
float	GetShearTolerance () const
	Shearing tolerance.
void	SetShearTolerance (float value)
	Shearing tolerance.
float	GetSkewBias () const
	Rotation bias.
void	SetSkewBias (float value)
	Rotation bias.
float	GetSkewTolerance () const
	Rotation tolerance.
void	SetSkewTolerance (float value)
	Rotation tolerance.
float	GetScaleX () const
	Measured horizontal scaling, expressed as a dimensionless ratio.
void	SetScaleX (float value)
	Measured horizontal scaling, expressed as a dimensionless ratio.
float	GetScaleY () const
	Measured vertical scaling, expressed as a dimensionless ratio.
void	SetScaleY (float value)
	Measured vertical scaling, expressed as a dimensionless ratio.
float	GetShear () const
	Measured shearing, clockwise from the vertical direction, expressed in the current angle unit.
void	SetShear (float value)
	Measured shearing, clockwise from the vertical direction, expressed in the current angle unit.
float	GetSkew () const
	Measured rotation, clockwise from the horizontal direction, expressed in the current angle unit.
void	SetSkew (float value)
	Measured rotation, clockwise from the horizontal direction, expressed in the current angle unit.
float	GetShiftX () const
	Measured horizontal translation, in pixels.
void	SetShiftX (float value)
	Measured horizontal translation, in pixels.
float	GetShiftY () const
	Measured vertical translation, in pixels.
void	SetShiftY (float value)
	Measured vertical translation, in pixels.
float	GetTemplateForegroundSum () const
	Sum of the normalized gray-level values of the foreground pixels of the characters of this text.
void	SetTemplateForegroundSum (float value)
	Sum of the normalized gray-level values of the foreground pixels of the characters of this text.
float	GetSampleForegroundSum () const
	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.
void	SetSampleForegroundSum (float value)
	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	GetForegroundSumTolerance () const
	Maximum allowed difference between the sample and template foreground sums.
void	SetForegroundSumTolerance (float value)
	Maximum allowed difference between the sample and template foreground sums.
float	GetTemplateBackgroundSum () const
	Sum of the normalized gray-level values of the background pixels of the characters of this text.
void	SetTemplateBackgroundSum (float value)
	Sum of the normalized gray-level values of the background pixels of the characters of this text.
float	GetSampleBackgroundSum () const
	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.
void	SetSampleBackgroundSum (float value)
	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	GetBackgroundSumTolerance () const
	Maximum allowed difference between the sample and template background sums.
void	SetBackgroundSumTolerance (float value)
	Maximum allowed difference between the sample and template background sums.
float	GetCorrelation () const
	Normalized correlation involving the template and sample images of the characters of this text.
void	SetCorrelation (float value)
	Normalized correlation involving the template and sample images of the characters of this text.
float	GetCorrelationTolerance () const
	Maximum allowed difference between the normalized correlation and unity.
void	SetCorrelationTolerance (float value)
	Maximum allowed difference between the normalized correlation and unity.
float	GetShiftXAverage () const
	Shift X average.
void	SetShiftXAverage (float value)
	Shift X average.
float	GetShiftXDeviation () const
	Shift X standard deviation.
void	SetShiftXDeviation (float value)
	Shift X standard deviation.
float	GetShiftXMin () const
	Minimum Shift X.
void	SetShiftXMin (float value)
	Minimum Shift X.
float	GetShiftXMax () const
	Maximum Shift Y.
void	SetShiftXMax (float value)
	Maximum Shift Y.
float	GetShiftYAverage () const
	Shift Y average.
void	SetShiftYAverage (float value)
	Shift Y average.
float	GetShiftYDeviation () const
	Shift Y standard deviation.
void	SetShiftYDeviation (float value)
	Shift Y standard deviation.
float	GetShiftYMin () const
	Minimum Shift Y.
void	SetShiftYMin (float value)
	Minimum Shift Y.
float	GetShiftYMax () const
	Maximum Shift Y.
void	SetShiftYMax (float value)
	Maximum Shift Y.
float	GetShearAverage () const
	Shear average.
void	SetShearAverage (float value)
	Shear average.
float	GetShearDeviation () const
	Shear standard deviation.
void	SetShearDeviation (float value)
	Shear standard deviation.
float	GetShearMin () const
	Minimum shear.
void	SetShearMin (float value)
	Minimum shear.
float	GetShearMax () const
	Maximum shear.
void	SetShearMax (float value)
	Maximum shear.
float	GetSkewAverage () const
	Skew average.
void	SetSkewAverage (float value)
	Skew average.
float	GetSkewDeviation () const
	Skew standard deviation.
void	SetSkewDeviation (float value)
	Skew standard deviation.
float	GetSkewMin () const
	Minimum skew.
void	SetSkewMin (float value)
	Minimum skew.
float	GetSkewMax () const
	Maximum skew.
void	SetSkewMax (float value)
	Maximum skew.
float	GetScaleXAverage () const
	Scale X average.
void	SetScaleXAverage (float value)
	Scale X average.
float	GetScaleXDeviation () const
	Scale X standard deviation.
void	SetScaleXDeviation (float value)
	Scale X standard deviation.
float	GetScaleXMin () const
	Minimum X-scale.
void	SetScaleXMin (float value)
	Minimum X-scale.
float	GetScaleXMax () const
	Maximum Y-scale.
void	SetScaleXMax (float value)
	Maximum Y-scale.
float	GetScaleYAverage () const
	Scale Y average.
void	SetScaleYAverage (float value)
	Scale Y average.
float	GetScaleYDeviation () const
	Scale Y standard deviation.
void	SetScaleYDeviation (float value)
	Scale Y standard deviation.
float	GetScaleYMin () const
	Minimum Y-scale.
void	SetScaleYMin (float value)
	Minimum Y-scale.
float	GetScaleYMax () const
	Maximum Y-scale.
void	SetScaleYMax (float value)
	Maximum Y-scale.
float	GetForegroundAreaAverage () const
	Foreground area average.
void	SetForegroundAreaAverage (float value)
	Foreground area average.
float	GetForegroundAreaDeviation () const
	Foreground area standard deviation.
void	SetForegroundAreaDeviation (float value)
	Foreground area standard deviation.
float	GetBackgroundAreaAverage () const
	Background area average.
void	SetBackgroundAreaAverage (float value)
	Background area average.
float	GetBackgroundAreaDeviation () const
	Background area standard deviation.
void	SetBackgroundAreaDeviation (float value)
	Background area standard deviation.
float	GetForegroundSumAverage () const
	Foreground sum average.
void	SetForegroundSumAverage (float value)
	Foreground sum average.
float	GetForegroundSumDeviation () const
	Foreground sum standard deviation.
void	SetForegroundSumDeviation (float value)
	Foreground sum standard deviation.
float	GetBackgroundSumAverage () const
	Background sum average.
void	SetBackgroundSumAverage (float value)
	Background sum average.
float	GetBackgroundSumDeviation () const
	Background sum standard deviation.
void	SetBackgroundSumDeviation (float value)
	Background sum standard deviation.
float	GetCorrelationAverage () const
	Correlation average.
void	SetCorrelationAverage (float value)
	Correlation average.
float	GetCorrelationDeviation () const
	Correlation standard deviation.
void	SetCorrelationDeviation (float value)
	Correlation standard deviation.
float	GetLocationScoreAverage () const
	Location score average.
void	SetLocationScoreAverage (float value)
	Location score average.
float	GetLocationScoreDeviation () const
	Location score standard deviation.
void	SetLocationScoreDeviation (float value)
	Location score standard deviation.
uint32_t	GetNumContourPoints () const
	Number of contour points used for location of this text.
void	SetNumContourPoints (uint32_t value)
	Number of contour points used for location of this text.
uint32_t	GetShiftXStride () const
	First pass stride for the horizontal translation.
void	SetShiftXStride (uint32_t value)
	First pass stride for the horizontal translation.
uint32_t	GetShiftYStride () const
	First pass stride for the vertical translation.
void	SetShiftYStride (uint32_t value)
	First pass stride for the vertical translation.
uint32_t	GetScaleXCount () const
	Number of values to be tried in the Bias +/- Tolerance range, bounds included.
void	SetScaleXCount (uint32_t value)
	Number of values to be tried in the Bias +/- Tolerance range, bounds included.
uint32_t	GetScaleYCount () const
	Number of values to be tried in the Bias +/- Tolerance range, bounds included.
void	SetScaleYCount (uint32_t value)
	Number of values to be tried in the Bias +/- Tolerance range, bounds included.
uint32_t	GetShearCount () const
	Number of values to be tried in the Bias +/- Tolerance range, bounds included.
void	SetShearCount (uint32_t value)
	Number of values to be tried in the Bias +/- Tolerance range, bounds included.
uint32_t	GetSkewCount () const
	Number of values to be tried in the Bias +/- Tolerance range, bounds included.
void	SetSkewCount (uint32_t value)
	Number of values to be tried in the Bias +/- Tolerance range, bounds included.
uint32_t	GetDiagnostics () const
	Logical combination (bitwise OR) of defects.
void	SetDiagnostics (uint32_t value)
	Logical combination (bitwise OR) of defects.
uint32_t	GetMarginWidth () const
	Unused.
void	SetMarginWidth (uint32_t value)
	Unused.
uint32_t	GetTemplateForegroundArea () const
	Number of pixels in the foreground of all characters of this text.
void	SetTemplateForegroundArea (uint32_t value)
	Number of pixels in the foreground of all characters of this text.
uint32_t	GetSampleForegroundArea () const
	Number of foreground pixels of this text corresponding to a foreground pixel of the characters of the template text.
void	SetSampleForegroundArea (uint32_t value)
	Number of foreground pixels of this text corresponding to a foreground pixel of the characters of the template text.
uint32_t	GetForegroundAreaTolerance () const
	Maximum allowed difference between the sample and template foreground areas.
void	SetForegroundAreaTolerance (uint32_t value)
	Maximum allowed difference between the sample and template foreground areas.
uint32_t	GetTemplateBackgroundArea () const
	Number of pixels in the background of the characters of this text.
void	SetTemplateBackgroundArea (uint32_t value)
	Number of pixels in the background of the characters of this text.
uint32_t	GetSampleBackgroundArea () const
	Number of background pixels of this text corresponding to a background pixel of the characters of the template text.
void	SetSampleBackgroundArea (uint32_t value)
	Number of background pixels of this text corresponding to a background pixel of the characters of the template text.
uint32_t	GetBackgroundAreaTolerance () const
	Maximum allowed difference between the sample and template background areas.
void	SetBackgroundAreaTolerance (uint32_t value)
	Maximum allowed difference between the sample and template background areas.
	EOCVText (CppWrapperInternal::InternalConstructor)

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

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/3]

eVision::EOCVText::EOCVText ( )

Constructs an OCVText context.

Default and copy constructors.

◆ EOCVText() [2/3]

eVision::EOCVText::EOCVText ( const eVision::EOCVText & ocvText )

Constructs an OCVText context.

Parameters

ocvText EOCVText object to be copied.

Default and copy constructors.

◆ ~EOCVText()

eVision::EOCVText::~EOCVText	(		)
throw	(	)

virtual

◆ EOCVText() [3/3]

eVision::EOCVText::EOCVText ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ GetBackgroundAreaAverage()

float eVision::EOCVText::GetBackgroundAreaAverage ( ) const

Background area average.

◆ GetBackgroundAreaDeviation()

float eVision::EOCVText::GetBackgroundAreaDeviation ( ) const

Background area standard deviation.

◆ GetBackgroundAreaTolerance()

uint32_t eVision::EOCVText::GetBackgroundAreaTolerance ( ) const

Maximum allowed difference between the sample and template background areas.

◆ GetBackgroundSumAverage()

float eVision::EOCVText::GetBackgroundSumAverage ( ) const

Background sum average.

◆ GetBackgroundSumDeviation()

float eVision::EOCVText::GetBackgroundSumDeviation ( ) const

Background sum standard deviation.

◆ GetBackgroundSumTolerance()

float eVision::EOCVText::GetBackgroundSumTolerance ( ) const

Maximum allowed difference between the sample and template background sums.

◆ GetCorrelation()

float eVision::EOCVText::GetCorrelation ( ) const

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

◆ GetCorrelationAverage()

float eVision::EOCVText::GetCorrelationAverage ( ) const

Correlation average.

◆ GetCorrelationDeviation()

float eVision::EOCVText::GetCorrelationDeviation ( ) const

Correlation standard deviation.

◆ GetCorrelationTolerance()

float eVision::EOCVText::GetCorrelationTolerance ( ) const

Maximum allowed difference between the normalized correlation and unity.

◆ GetDiagnostics()

uint32_t eVision::EOCVText::GetDiagnostics ( ) const

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.

◆ GetForegroundAreaAverage()

float eVision::EOCVText::GetForegroundAreaAverage ( ) const

Foreground area average.

◆ GetForegroundAreaDeviation()

float eVision::EOCVText::GetForegroundAreaDeviation ( ) const

Foreground area standard deviation.

◆ GetForegroundAreaTolerance()

uint32_t eVision::EOCVText::GetForegroundAreaTolerance ( ) const

Maximum allowed difference between the sample and template foreground areas.

◆ GetForegroundSumAverage()

float eVision::EOCVText::GetForegroundSumAverage ( ) const

Foreground sum average.

◆ GetForegroundSumDeviation()

float eVision::EOCVText::GetForegroundSumDeviation ( ) const

Foreground sum standard deviation.

◆ GetForegroundSumTolerance()

float eVision::EOCVText::GetForegroundSumTolerance ( ) const

Maximum allowed difference between the sample and template foreground sums.

◆ GetIsotropicScaling()

int eVision::EOCVText::GetIsotropicScaling ( )

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.

◆ GetLocationScoreAverage()

float eVision::EOCVText::GetLocationScoreAverage ( ) const

Location score average.

◆ GetLocationScoreDeviation()

float eVision::EOCVText::GetLocationScoreDeviation ( ) const

Location score standard deviation.

◆ GetLocationScoreTolerance()

float eVision::EOCVText::GetLocationScoreTolerance ( ) const

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.

◆ GetMarginWidth()

uint32_t eVision::EOCVText::GetMarginWidth ( ) const

Unused.

◆ GetNumContourPoints()

uint32_t eVision::EOCVText::GetNumContourPoints ( ) const

Number of contour points used for location of this text.

◆ GetSampleBackgroundArea()

uint32_t eVision::EOCVText::GetSampleBackgroundArea ( ) const

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

◆ GetSampleBackgroundSum()

float eVision::EOCVText::GetSampleBackgroundSum ( ) const

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.

◆ GetSampleForegroundArea()

uint32_t eVision::EOCVText::GetSampleForegroundArea ( ) const

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

◆ GetSampleForegroundSum()

float eVision::EOCVText::GetSampleForegroundSum ( ) const

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.

◆ GetSampleLocationScore()

float eVision::EOCVText::GetSampleLocationScore ( ) const

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

◆ GetScaleX()

float eVision::EOCVText::GetScaleX ( ) const

Measured horizontal scaling, expressed as a dimensionless ratio.

◆ GetScaleXAverage()

float eVision::EOCVText::GetScaleXAverage ( ) const

Scale X average.

◆ GetScaleXBias()

float eVision::EOCVText::GetScaleXBias ( ) const

Horizontal scaling bias.

0 corresponds to the nominal, true scale factor.

◆ GetScaleXCount()

uint32_t eVision::EOCVText::GetScaleXCount ( ) const

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

◆ GetScaleXDeviation()

float eVision::EOCVText::GetScaleXDeviation ( ) const

Scale X standard deviation.

◆ GetScaleXMax()

float eVision::EOCVText::GetScaleXMax ( ) const

Maximum Y-scale.

◆ GetScaleXMin()

float eVision::EOCVText::GetScaleXMin ( ) const

Minimum X-scale.

◆ GetScaleXTolerance()

float eVision::EOCVText::GetScaleXTolerance ( ) const

Horizontal scaling tolerance.

◆ GetScaleY()

float eVision::EOCVText::GetScaleY ( ) const

Measured vertical scaling, expressed as a dimensionless ratio.

◆ GetScaleYAverage()

float eVision::EOCVText::GetScaleYAverage ( ) const

Scale Y average.

◆ GetScaleYBias()

float eVision::EOCVText::GetScaleYBias ( ) const

Vertical scaling bias.

0 corresponds to the nominal, true scale factor.

◆ GetScaleYCount()

uint32_t eVision::EOCVText::GetScaleYCount ( ) const

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

◆ GetScaleYDeviation()

float eVision::EOCVText::GetScaleYDeviation ( ) const

Scale Y standard deviation.

◆ GetScaleYMax()

float eVision::EOCVText::GetScaleYMax ( ) const

Maximum Y-scale.

◆ GetScaleYMin()

float eVision::EOCVText::GetScaleYMin ( ) const

Minimum Y-scale.

◆ GetScaleYTolerance()

float eVision::EOCVText::GetScaleYTolerance ( ) const

Vertical scaling tolerance.

◆ GetSelected()

int eVision::EOCVText::GetSelected ( )

Selection state. TRUE when selected.

◆ GetShear()

float eVision::EOCVText::GetShear ( ) const

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

◆ GetShearAverage()

float eVision::EOCVText::GetShearAverage ( ) const

Shear average.

◆ GetShearBias()

float eVision::EOCVText::GetShearBias ( ) const

Shearing bias.

0 corresponds to the nominal, upright position.

◆ GetShearCount()

uint32_t eVision::EOCVText::GetShearCount ( ) const

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

◆ GetShearDeviation()

float eVision::EOCVText::GetShearDeviation ( ) const

Shear standard deviation.

◆ GetShearMax()

float eVision::EOCVText::GetShearMax ( ) const

Maximum shear.

◆ GetShearMin()

float eVision::EOCVText::GetShearMin ( ) const

Minimum shear.

◆ GetShearTolerance()

float eVision::EOCVText::GetShearTolerance ( ) const

Shearing tolerance.

◆ GetShiftX()

float eVision::EOCVText::GetShiftX ( ) const

Measured horizontal translation, in pixels.

◆ GetShiftXAverage()

float eVision::EOCVText::GetShiftXAverage ( ) const

Shift X average.

◆ GetShiftXBias()

float eVision::EOCVText::GetShiftXBias ( ) const

Horizontal translation bias.

0 corresponds to the nominal position.

◆ GetShiftXDeviation()

float eVision::EOCVText::GetShiftXDeviation ( ) const

Shift X standard deviation.

◆ GetShiftXMax()

float eVision::EOCVText::GetShiftXMax ( ) const

Maximum Shift Y.

◆ GetShiftXMin()

float eVision::EOCVText::GetShiftXMin ( ) const

Minimum Shift X.

◆ GetShiftXStride()

uint32_t eVision::EOCVText::GetShiftXStride ( ) const

First pass stride for the horizontal translation.

◆ GetShiftXTolerance()

float eVision::EOCVText::GetShiftXTolerance ( ) const

Horizontal translation tolerance.

◆ GetShiftY()

float eVision::EOCVText::GetShiftY ( ) const

Measured vertical translation, in pixels.

◆ GetShiftYAverage()

float eVision::EOCVText::GetShiftYAverage ( ) const

Shift Y average.

◆ GetShiftYBias()

float eVision::EOCVText::GetShiftYBias ( ) const

Vertical translation bias.

0 corresponds to the nominal position.

◆ GetShiftYDeviation()

float eVision::EOCVText::GetShiftYDeviation ( ) const

Shift Y standard deviation.

◆ GetShiftYMax()

float eVision::EOCVText::GetShiftYMax ( ) const

Maximum Shift Y.

◆ GetShiftYMin()

float eVision::EOCVText::GetShiftYMin ( ) const

Minimum Shift Y.

◆ GetShiftYStride()

uint32_t eVision::EOCVText::GetShiftYStride ( ) const

First pass stride for the vertical translation.

◆ GetShiftYTolerance()

float eVision::EOCVText::GetShiftYTolerance ( ) const

Vertical translation tolerance.

◆ GetSkew()

float eVision::EOCVText::GetSkew ( ) const

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

◆ GetSkewAverage()

float eVision::EOCVText::GetSkewAverage ( ) const

Skew average.

◆ GetSkewBias()

float eVision::EOCVText::GetSkewBias ( ) const

Rotation bias.

0 corresponds to the nominal, horizontal position.

◆ GetSkewCount()

uint32_t eVision::EOCVText::GetSkewCount ( ) const

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

◆ GetSkewDeviation()

float eVision::EOCVText::GetSkewDeviation ( ) const

Skew standard deviation.

◆ GetSkewMax()

float eVision::EOCVText::GetSkewMax ( ) const

Maximum skew.

◆ GetSkewMin()

float eVision::EOCVText::GetSkewMin ( ) const

Minimum skew.

◆ GetSkewTolerance()

float eVision::EOCVText::GetSkewTolerance ( ) const

Rotation tolerance.

◆ GetTemplateBackgroundArea()

uint32_t eVision::EOCVText::GetTemplateBackgroundArea ( ) const

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

◆ GetTemplateBackgroundSum()

float eVision::EOCVText::GetTemplateBackgroundSum ( ) const

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

◆ GetTemplateForegroundArea()

uint32_t eVision::EOCVText::GetTemplateForegroundArea ( ) const

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

◆ GetTemplateForegroundSum()

float eVision::EOCVText::GetTemplateForegroundSum ( ) const

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

◆ GetTemplateLocationScore()

float eVision::EOCVText::GetTemplateLocationScore ( ) const

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

◆ operator=()

eVision::EOCVText & eVision::EOCVText::operator= ( const eVision::EOCVText & other )

Copies all the data from another EOCVText object into the current EOCVText object.

Parameters

other EOCVText object to be copied

◆ ResetParameters()

void eVision::EOCVText::ResetParameters ( )

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

◆ SetBackgroundAreaAverage()

void eVision::EOCVText::SetBackgroundAreaAverage ( float value )

Background area average.

◆ SetBackgroundAreaDeviation()

void eVision::EOCVText::SetBackgroundAreaDeviation ( float value )

Background area standard deviation.

◆ SetBackgroundAreaTolerance()

void eVision::EOCVText::SetBackgroundAreaTolerance ( uint32_t value )

Maximum allowed difference between the sample and template background areas.

◆ SetBackgroundSumAverage()

void eVision::EOCVText::SetBackgroundSumAverage ( float value )

Background sum average.

◆ SetBackgroundSumDeviation()

void eVision::EOCVText::SetBackgroundSumDeviation ( float value )

Background sum standard deviation.

◆ SetBackgroundSumTolerance()

void eVision::EOCVText::SetBackgroundSumTolerance ( float value )

Maximum allowed difference between the sample and template background sums.

◆ SetCorrelation()

void eVision::EOCVText::SetCorrelation ( float value )

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

◆ SetCorrelationAverage()

void eVision::EOCVText::SetCorrelationAverage ( float value )

Correlation average.

◆ SetCorrelationDeviation()

void eVision::EOCVText::SetCorrelationDeviation ( float value )

Correlation standard deviation.

◆ SetCorrelationTolerance()

void eVision::EOCVText::SetCorrelationTolerance ( float value )

Maximum allowed difference between the normalized correlation and unity.

◆ SetDiagnostics()

void eVision::EOCVText::SetDiagnostics ( uint32_t value )

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.

◆ SetForegroundAreaAverage()

void eVision::EOCVText::SetForegroundAreaAverage ( float value )

Foreground area average.

◆ SetForegroundAreaDeviation()

void eVision::EOCVText::SetForegroundAreaDeviation ( float value )

Foreground area standard deviation.

◆ SetForegroundAreaTolerance()

void eVision::EOCVText::SetForegroundAreaTolerance ( uint32_t value )

Maximum allowed difference between the sample and template foreground areas.

◆ SetForegroundSumAverage()

void eVision::EOCVText::SetForegroundSumAverage ( float value )

Foreground sum average.

◆ SetForegroundSumDeviation()

void eVision::EOCVText::SetForegroundSumDeviation ( float value )

Foreground sum standard deviation.

◆ SetForegroundSumTolerance()

void eVision::EOCVText::SetForegroundSumTolerance ( float value )

Maximum allowed difference between the sample and template foreground sums.

◆ SetIsotropicScaling()

void eVision::EOCVText::SetIsotropicScaling ( int isotropicScaling )

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.

◆ SetLocationScoreAverage()

void eVision::EOCVText::SetLocationScoreAverage ( float value )

Location score average.

◆ SetLocationScoreDeviation()

void eVision::EOCVText::SetLocationScoreDeviation ( float value )

Location score standard deviation.

◆ SetLocationScoreTolerance()

void eVision::EOCVText::SetLocationScoreTolerance ( float value )

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.

◆ SetMarginWidth()

void eVision::EOCVText::SetMarginWidth ( uint32_t value )

Unused.

◆ SetNumContourPoints()

void eVision::EOCVText::SetNumContourPoints ( uint32_t value )

Number of contour points used for location of this text.

◆ SetSampleBackgroundArea()

void eVision::EOCVText::SetSampleBackgroundArea ( uint32_t value )

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

◆ SetSampleBackgroundSum()

void eVision::EOCVText::SetSampleBackgroundSum ( float value )

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.

◆ SetSampleForegroundArea()

void eVision::EOCVText::SetSampleForegroundArea ( uint32_t value )

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

◆ SetSampleForegroundSum()

void eVision::EOCVText::SetSampleForegroundSum ( float value )

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.

◆ SetSampleLocationScore()

void eVision::EOCVText::SetSampleLocationScore ( float value )

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

◆ SetScaleX()

void eVision::EOCVText::SetScaleX ( float value )

Measured horizontal scaling, expressed as a dimensionless ratio.

◆ SetScaleXAverage()

void eVision::EOCVText::SetScaleXAverage ( float value )

Scale X average.

◆ SetScaleXBias()

void eVision::EOCVText::SetScaleXBias ( float value )

Horizontal scaling bias.

0 corresponds to the nominal, true scale factor.

◆ SetScaleXCount()

void eVision::EOCVText::SetScaleXCount ( uint32_t value )

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

◆ SetScaleXDeviation()

void eVision::EOCVText::SetScaleXDeviation ( float value )

Scale X standard deviation.

◆ SetScaleXMax()

void eVision::EOCVText::SetScaleXMax ( float value )

Maximum Y-scale.

◆ SetScaleXMin()

void eVision::EOCVText::SetScaleXMin ( float value )

Minimum X-scale.

◆ SetScaleXTolerance()

void eVision::EOCVText::SetScaleXTolerance ( float value )

Horizontal scaling tolerance.

◆ SetScaleY()

void eVision::EOCVText::SetScaleY ( float value )

Measured vertical scaling, expressed as a dimensionless ratio.

◆ SetScaleYAverage()

void eVision::EOCVText::SetScaleYAverage ( float value )

Scale Y average.

◆ SetScaleYBias()

void eVision::EOCVText::SetScaleYBias ( float value )

Vertical scaling bias.

0 corresponds to the nominal, true scale factor.

◆ SetScaleYCount()

void eVision::EOCVText::SetScaleYCount ( uint32_t value )

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

◆ SetScaleYDeviation()

void eVision::EOCVText::SetScaleYDeviation ( float value )

Scale Y standard deviation.

◆ SetScaleYMax()

void eVision::EOCVText::SetScaleYMax ( float value )

Maximum Y-scale.

◆ SetScaleYMin()

void eVision::EOCVText::SetScaleYMin ( float value )

Minimum Y-scale.

◆ SetScaleYTolerance()

void eVision::EOCVText::SetScaleYTolerance ( float value )

Vertical scaling tolerance.

◆ SetSelected()

void eVision::EOCVText::SetSelected ( int selected )

Selection state. TRUE when selected.

◆ SetShear()

void eVision::EOCVText::SetShear ( float value )

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

◆ SetShearAverage()

void eVision::EOCVText::SetShearAverage ( float value )

Shear average.

◆ SetShearBias()

void eVision::EOCVText::SetShearBias ( float value )

Shearing bias.

0 corresponds to the nominal, upright position.

◆ SetShearCount()

void eVision::EOCVText::SetShearCount ( uint32_t value )

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

◆ SetShearDeviation()

void eVision::EOCVText::SetShearDeviation ( float value )

Shear standard deviation.

◆ SetShearMax()

void eVision::EOCVText::SetShearMax ( float value )

Maximum shear.

◆ SetShearMin()

void eVision::EOCVText::SetShearMin ( float value )

Minimum shear.

◆ SetShearTolerance()

void eVision::EOCVText::SetShearTolerance ( float value )

Shearing tolerance.

◆ SetShiftX()

void eVision::EOCVText::SetShiftX ( float value )

Measured horizontal translation, in pixels.

◆ SetShiftXAverage()

void eVision::EOCVText::SetShiftXAverage ( float value )

Shift X average.

◆ SetShiftXBias()

void eVision::EOCVText::SetShiftXBias ( float value )

Horizontal translation bias.

0 corresponds to the nominal position.

◆ SetShiftXDeviation()

void eVision::EOCVText::SetShiftXDeviation ( float value )

Shift X standard deviation.

◆ SetShiftXMax()

void eVision::EOCVText::SetShiftXMax ( float value )

Maximum Shift Y.

◆ SetShiftXMin()

void eVision::EOCVText::SetShiftXMin ( float value )

Minimum Shift X.

◆ SetShiftXStride()

void eVision::EOCVText::SetShiftXStride ( uint32_t value )

First pass stride for the horizontal translation.

◆ SetShiftXTolerance()

void eVision::EOCVText::SetShiftXTolerance ( float value )

Horizontal translation tolerance.

◆ SetShiftY()

void eVision::EOCVText::SetShiftY ( float value )

Measured vertical translation, in pixels.

◆ SetShiftYAverage()

void eVision::EOCVText::SetShiftYAverage ( float value )

Shift Y average.

◆ SetShiftYBias()

void eVision::EOCVText::SetShiftYBias ( float value )

Vertical translation bias.

0 corresponds to the nominal position.

◆ SetShiftYDeviation()

void eVision::EOCVText::SetShiftYDeviation ( float value )

Shift Y standard deviation.

◆ SetShiftYMax()

void eVision::EOCVText::SetShiftYMax ( float value )

Maximum Shift Y.

◆ SetShiftYMin()

void eVision::EOCVText::SetShiftYMin ( float value )

Minimum Shift Y.

◆ SetShiftYStride()

void eVision::EOCVText::SetShiftYStride ( uint32_t value )

First pass stride for the vertical translation.

◆ SetShiftYTolerance()

void eVision::EOCVText::SetShiftYTolerance ( float value )

Vertical translation tolerance.

◆ SetSkew()

void eVision::EOCVText::SetSkew ( float value )

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

◆ SetSkewAverage()

void eVision::EOCVText::SetSkewAverage ( float value )

Skew average.

◆ SetSkewBias()

void eVision::EOCVText::SetSkewBias ( float value )

Rotation bias.

0 corresponds to the nominal, horizontal position.

◆ SetSkewCount()

void eVision::EOCVText::SetSkewCount ( uint32_t value )

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

◆ SetSkewDeviation()

void eVision::EOCVText::SetSkewDeviation ( float value )

Skew standard deviation.

◆ SetSkewMax()

void eVision::EOCVText::SetSkewMax ( float value )

Maximum skew.

◆ SetSkewMin()

void eVision::EOCVText::SetSkewMin ( float value )

Minimum skew.

◆ SetSkewTolerance()

void eVision::EOCVText::SetSkewTolerance ( float value )

Rotation tolerance.

◆ SetTemplateBackgroundArea()

void eVision::EOCVText::SetTemplateBackgroundArea ( uint32_t value )

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

◆ SetTemplateBackgroundSum()

void eVision::EOCVText::SetTemplateBackgroundSum ( float value )

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

◆ SetTemplateForegroundArea()

void eVision::EOCVText::SetTemplateForegroundArea ( uint32_t value )

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

◆ SetTemplateForegroundSum()

void eVision::EOCVText::SetTemplateForegroundSum ( float value )

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

◆ SetTemplateLocationScore()

void eVision::EOCVText::SetTemplateLocationScore ( float value )

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

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::EOCVText::wrappedClass_

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EOCVText() [1/3]

◆ EOCVText() [2/3]

◆ ~EOCVText()

◆ EOCVText() [3/3]

Member Function Documentation

◆ GetBackgroundAreaAverage()

◆ GetBackgroundAreaDeviation()

◆ GetBackgroundAreaTolerance()

◆ GetBackgroundSumAverage()

◆ GetBackgroundSumDeviation()

◆ GetBackgroundSumTolerance()

◆ GetCorrelation()

◆ GetCorrelationAverage()

◆ GetCorrelationDeviation()

◆ GetCorrelationTolerance()

◆ GetDiagnostics()

◆ GetForegroundAreaAverage()

◆ GetForegroundAreaDeviation()

◆ GetForegroundAreaTolerance()

◆ GetForegroundSumAverage()

◆ GetForegroundSumDeviation()

◆ GetForegroundSumTolerance()

◆ GetIsotropicScaling()

◆ GetLocationScoreAverage()

◆ GetLocationScoreDeviation()

◆ GetLocationScoreTolerance()

◆ GetMarginWidth()

◆ GetNumContourPoints()

◆ GetSampleBackgroundArea()

◆ GetSampleBackgroundSum()

◆ GetSampleForegroundArea()

◆ GetSampleForegroundSum()

◆ GetSampleLocationScore()

◆ GetScaleX()

◆ GetScaleXAverage()

◆ GetScaleXBias()

◆ GetScaleXCount()

◆ GetScaleXDeviation()

◆ GetScaleXMax()

◆ GetScaleXMin()

◆ GetScaleXTolerance()

◆ GetScaleY()

◆ GetScaleYAverage()

◆ GetScaleYBias()

◆ GetScaleYCount()

◆ GetScaleYDeviation()

◆ GetScaleYMax()

◆ GetScaleYMin()

◆ GetScaleYTolerance()

◆ GetSelected()

◆ GetShear()

◆ GetShearAverage()

◆ GetShearBias()

◆ GetShearCount()

◆ GetShearDeviation()

◆ GetShearMax()

◆ GetShearMin()

◆ GetShearTolerance()

◆ GetShiftX()

◆ GetShiftXAverage()

◆ GetShiftXBias()

◆ GetShiftXDeviation()

◆ GetShiftXMax()

◆ GetShiftXMin()

◆ GetShiftXStride()

◆ GetShiftXTolerance()

◆ GetShiftY()

◆ GetShiftYAverage()

◆ GetShiftYBias()

◆ GetShiftYDeviation()

◆ GetShiftYMax()

◆ GetShiftYMin()

◆ GetShiftYStride()

◆ GetShiftYTolerance()

◆ GetSkew()

◆ GetSkewAverage()