Minos classifier object. More...

#include <cvb/minos/classifier.hpp>

Public Member Functions
	Classifier (const String &fileName)
	Loads a classifier with the given file name.

void *	Handle () const noexcept
	Classic API CLF handle.

void	Save (const String &fileName) const
	Write the classifier to a file.

std::vector< std::uint8_t >	ToBuffer () const
	Builds a byte buffer with the classifier.

String	FileName () const
	Name of the file from which this classifier was loaded (empty string, if this image list was neither loaded nor saved since its construction).

ClassifierModelInfoCollection	Models () const
	Collection of the models contained in this classifier.

Rect< int >	Extent () const noexcept
	Extent of the classes in the classifier relative to the anchor point.

std::chrono::system_clock::time_point	CreationDate () const noexcept
	Creation date of the classifier.

bool	IsMinos16BitClassifier () const
	Returns true if the classifier was generated by Minos16Bit.

int	ContrastTrigger () const
	Get the trigger value for the contrast of features to be taken into account.

void	SetContrastTrigger (int trigger)
	Set the trigger value for the contrast of features to be taken into account.

double	Threshold () const
	Get the threshold for search operations with normalized quality feedback.

void	SetThreshold (double threshold)
	Set the threshold for search operations with normalized quality feedback.

QualityFeedback	QualityMeasure () const
	Get the type of quality feedback from the classifier.

void	SetQualityMeasure (QualityFeedback quality)
	Set the type of quality feedback from the classifier.

String	TrainingSetName () const
	Get name of the training set from which this classifier was generated.

class LearnParameters	LearnParameters () const
	Get the set of parameters that has been used during classifier generation.

String	Comment () const
	Get the comment assigned to the classifier at generation time.

void	SetComment (String comment)
	Set the comment assigned to the classifier at generation time.

std::unique_ptr< Classifier >	Transform (Matrix2D transformation)
	Generate a new classifier by transforming this classifier with a 2x2 transformation matrix.

std::unique_ptr< Classifier >	SetGlobalAdvanceVector (Point2D< int > advance)
	Create a new classifier, that is a copy of this classifier, but with a global advance vector applied to all classes in the classifier.

String	Read (const ImagePlane &plane, ReadMode mode, Area2D startAOI, Area2D ocrAOI, SearchResult &startOrStop, double density=1.0)
	Reads a string of characters.

std::vector< SearchResult >	Read (const ImagePlane &plane, Area2D startAOI, Area2D ocrAOI, double density=1.0)
	Reads a list of characters.

SearchResult	Search (const ImagePlane &plane, SearchMode mode, Area2D aoi, double density=1.0)
	Search one object using this Minos classifier.

SearchResult	Search (const ImagePlane &plane, SearchMode mode, double density=1.0)
	Search one object using this Minos classifier.

std::vector< SearchResult >	SearchAll (const ImagePlane &plane, int locality, Area2D aoi, double density=1.0)
	Search all objects using this Minos classifier.

std::vector< SearchResult >	SearchAll (const ImagePlane &plane, int locality, double density=1.0)
	Search all objects using this Minos classifier.

Static Public Member Functions
static std::unique_ptr< Classifier >	Load (const String &fileName)
	Load a saved classifier from a file.

static std::unique_ptr< Classifier >	FromBuffer (const void *buffer, size_t size)
	Recreate a serialized Minos classifier from a byte array.

template<class RANGE>
static TypedRange< std::unique_ptr< Classifier >, std::uint8_t, RANGE >::type	FromBuffer (const RANGE &buffer)
	Recreate a serialized Minos classifier from a byte array.

static std::unique_ptr< Classifier >	FromHandle (HandleGuard< Classifier > &&guard)
	Creates classifier from a classic API handle.

Detailed Description

Minos classifier object.

Constructor & Destructor Documentation

◆ Classifier()

Classifier ( const String & fileName )

inlineexplicit

Loads a classifier with the given file name.

Parameters

[in] fileName The file name.

Exceptions

Any	exception derived from std::exception including CvbException.

Member Function Documentation

◆ Comment()

String Comment ( ) const

inline

Get the comment assigned to the classifier at generation time.

Returns: The comment.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ ContrastTrigger()

int ContrastTrigger ( ) const

inline

Get the trigger value for the contrast of features to be taken into account.

Returns: The trigger value.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ CreationDate()

std::chrono::system_clock::time_point CreationDate ( ) const

inlinenoexcept

Creation date of the classifier.

Returns: The creation date.

Exceptions

Does	not throw any exception.

◆ Extent()

Rect< int > Extent ( ) const

inlinenoexcept

Extent of the classes in the classifier relative to the anchor point.

Returns: The classifier extent.

Exceptions

Does	not throw any exception.

◆ FileName()

String FileName ( ) const

inline

Name of the file from which this classifier was loaded (empty string, if this image list was neither loaded nor saved since its construction).

Returns: The file name.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ FromBuffer() [1/2]

template<class RANGE>

static TypedRange< std::unique_ptr< Classifier >, std::uint8_t, RANGE >::type FromBuffer ( const RANGE & buffer )

inlinestatic

Recreate a serialized Minos classifier from a byte array.

Parameters

[in] buffer Byte array from which to create the classifier.

Returns: Pointer to the loaded classifier.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ FromBuffer() [2/2]

static std::unique_ptr< Classifier > FromBuffer	(	const void *	buffer,
		size_t	size )

inlinestatic

Recreate a serialized Minos classifier from a byte array.

Parameters

[in]	buffer	Byte array from which to create the classifier.
[in]	size	Number of bytes to use.

Returns: Pointer to the loaded classifier.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ FromHandle()

static std::unique_ptr< Classifier > FromHandle ( HandleGuard< Classifier > && guard )

inlinestatic

Creates classifier from a classic API handle.

Parameters

[in] guard Life time guard for C-API handle.

Returns: The classifier created from the classic API handle.

Exceptions

Any	exception derived from std::exception including CvbException.

The classifier takes ownership of the handle, so you must share it before using this function.

◆ Handle()

void * Handle ( ) const

inlinenoexcept

Classic API CLF handle.

Returns: Classic API handle.

Exceptions

Does	not throw any exception.

It is normally not necessary to work with this handle.

◆ IsMinos16BitClassifier()

bool IsMinos16BitClassifier ( ) const

inline

Returns true if the classifier was generated by Minos16Bit.

Returns: True if generated by Minos16Bit, false otherwise.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ LearnParameters()

class LearnParameters LearnParameters ( ) const

inline

Get the set of parameters that has been used during classifier generation.

Returns: The learn parameters.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ Load()

static std::unique_ptr< Classifier > Load ( const String & fileName )

inlinestatic

Load a saved classifier from a file.

Parameters

[in] fileName Name of the file to be loaded.

Returns: Pointer to the loaded classifier.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ Models()

ClassifierModelInfoCollection Models ( ) const

inline

Collection of the models contained in this classifier.

Returns: The model info collection.

Exceptions

Any	exception derived from std::exception including CvbException.

The collection keeps internal link to the classifier, shares resources with it and stays valid even if the classifier object itself gets destroyed.

◆ QualityMeasure()

QualityFeedback QualityMeasure ( ) const

inline

Get the type of quality feedback from the classifier.

Returns: The quality value.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ Read() [1/2]

std::vector< SearchResult > Read	(	const ImagePlane &	plane,
		Area2D	startAOI,
		Area2D	ocrAOI,
		double	density = 1.0 )

inline

Reads a list of characters.

Parameters

[in]	plane	Image plane to read on.
[in]	startAOI	Area in which to start the read operation.
[in]	ocrAOI	Area to be used for the intermediate read steps; this area will be applied relative to the expected position of the next character and is typically only a few pixels wide and high.
[in]	density	Density to be used for the read operation.

Returns: The list of characters that has been read by this function.

Exceptions

Any	exception derived from std::exception including CvbException.

Uses the following approach:

To begin with, the first object in the startAOI will be searched.
This result's advance vector will be added to this result's position; around the result position, the ocrAOI will be centered.
The result area will be used as the AOI for a new FindFirst search operation. The whole process will be repeated until no more results are encountered. String of up to 32k characters are read.

◆ Read() [2/2]

String Read	(	const ImagePlane &	plane,
		ReadMode	mode,
		Area2D	startAOI,
		Area2D	ocrAOI,
		SearchResult &	startOrStop,
		double	density = 1.0 )

inline

Reads a string of characters.

Parameters

[in]	plane	Image plane to read on.
[in]	mode	Read mode.
[in]	startAOI	Area in which to start the read operation.
[in]	ocrAOI	Area to be used for the intermediate read steps; this area will be applied relative to the expected position of the next character and is typically only a few pixels wide and high.
[out]	startOrStop	First or last character that has been read (depending on the value of the mode parameter), output.
[in]	density	Density to be used for the read operation.

Returns: The string that has been read by this function.

Exceptions

Any	exception derived from std::exception including CvbException.

Uses the following approach:

To begin with, the first object in the startAOI will be searched.
This result's advance vector will be added to this result's position; around the result position, the ocrAOI will be centered.
The result area will be used as the AOI for a new FindFirst search operation. The whole process will be repeated until no more results are encountered. String of up to 32k characters are read.

◆ Save()

void Save ( const String & fileName ) const

inline

Write the classifier to a file.

Parameters

[in] fileName Path to save to.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ Search() [1/2]

SearchResult Search	(	const ImagePlane &	plane,
		SearchMode	mode,
		Area2D	aoi,
		double	density = 1.0 )

inline

Search one object using this Minos classifier.

Parameters

[in]	plane	Image plane to search on.
[in]	mode	Search mode to be used.
[in]	aoi	Area to search in.
[in]	density	Density at which to search ([0...1]).

Returns: The found result (SearchResult::Nothing() if none was found).

Exceptions

Any	exception derived from std::exception including CvbException.

◆ Search() [2/2]

SearchResult Search	(	const ImagePlane &	plane,
		SearchMode	mode,
		double	density = 1.0 )

inline

Search one object using this Minos classifier.

Parameters

[in]	plane	Image plane to search on.
[in]	mode	Search mode to be used.
[in]	density	Density at which to search ([0...1]).

Returns: The found result (SearchResult::Nothing() if none was found)..

Exceptions

Any	exception derived from std::exception including CvbException.

◆ SearchAll() [1/2]

std::vector< SearchResult > SearchAll	(	const ImagePlane &	plane,
		int	locality,
		Area2D	aoi,
		double	density = 1.0 )

inline

Search all objects using this Minos classifier.

Parameters

[in]	plane	Image plane to search on.
[in]	locality	Radius within which no better solution may exist.
[in]	aoi	Area to search in.
[in]	density	Density at which to search ([0...1]).

Returns: List of found results.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ SearchAll() [2/2]

std::vector< SearchResult > SearchAll	(	const ImagePlane &	plane,
		int	locality,
		double	density = 1.0 )

inline

Search all objects using this Minos classifier.

Parameters

[in]	plane	Image plane to search on.
[in]	locality	Radius within which no better solution may exist.
[in]	density	Density at which to search ([0...1]).

Returns: List of found results.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ SetComment()

void SetComment ( String comment )

inline

Set the comment assigned to the classifier at generation time.

Parameters

[in] comment The comment.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ SetContrastTrigger()

void SetContrastTrigger ( int trigger )

inline

Set the trigger value for the contrast of features to be taken into account.

Parameters

[in] trigger The trigger value.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ SetGlobalAdvanceVector()

std::unique_ptr< Classifier > SetGlobalAdvanceVector ( Point2D< int > advance )

inline

Create a new classifier, that is a copy of this classifier, but with a global advance vector applied to all classes in the classifier.

Parameters

[in] advance Advance vector to apply globally.

Returns: The new classifier.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ SetQualityMeasure()

void SetQualityMeasure ( QualityFeedback quality )

inline

Set the type of quality feedback from the classifier.

Parameters

[in] quality The quality value.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ SetThreshold()

void SetThreshold ( double threshold )

inline

Set the threshold for search operations with normalized quality feedback.

Parameters

[in] threshold The threshold value.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ Threshold()

double Threshold ( ) const

inline

Get the threshold for search operations with normalized quality feedback.

Returns: The threshold value.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ ToBuffer()

std::vector< std::uint8_t > ToBuffer ( ) const

inline

Builds a byte buffer with the classifier.

Returns: Byte array with serialzed Minos classifier.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ TrainingSetName()

String TrainingSetName ( ) const

inline

Get name of the training set from which this classifier was generated.

Returns: The training set name.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ Transform()

std::unique_ptr< Classifier > Transform ( Matrix2D transformation )

inline

Generate a new classifier by transforming this classifier with a 2x2 transformation matrix.

Parameters

[in] transformation Matrix with which to transform the geometry of this classifier.

Returns: The transformed classifier.

Exceptions

Any	exception derived from std::exception including CvbException.

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Classifier()

Member Function Documentation

◆ Comment()

◆ ContrastTrigger()

◆ CreationDate()

◆ Extent()

◆ FileName()

◆ FromBuffer() [1/2]

◆ FromBuffer() [2/2]

◆ FromHandle()

◆ Handle()

◆ IsMinos16BitClassifier()

◆ LearnParameters()

◆ Load()

◆ Models()

◆ QualityMeasure()

◆ Read() [1/2]

◆ Read() [2/2]

◆ Save()

◆ Search() [1/2]

◆ Search() [2/2]

◆ SearchAll() [1/2]

◆ SearchAll() [2/2]

◆ SetComment()

◆ SetContrastTrigger()

◆ SetGlobalAdvanceVector()

◆ SetQualityMeasure()

◆ SetThreshold()

◆ Threshold()

◆ ToBuffer()

◆ TrainingSetName()

◆ Transform()