ShapeFinder2 classifier factory object. More...

#include <cvb/shapefinder2/classifier_factory.hpp>

Public Member Functions
	ClassifierFactory () noexcept=default
	The object that holds methods for generating ShapeFinder classifier factory.

std::vector< int >	GradientHistogram (const ImagePlane &plane, Rect< int > aoi, ShapeFinder2::GradientType gradient) const
	Calculate the gradient histogram.

ValueRange< Angle >	RotationRangeMax () const noexcept
	The maximum range of rotations (in degrees), that may be set on the learner.

ValueRange< Angle >	RotationRange () const noexcept
	Range of rotations, that the classifier should be able to cover.

void	SetRotationRange (ValueRange< Angle > value)
	Range of rotations, that the classifier should be able to cover.

ValueRange< double >	ScaleRangeMax () const noexcept
	The maximum range of scales, that may be set on the learner.

ValueRange< double >	ScaleRange () const noexcept
	Range of scales, that the classifier should be able to cover.

void	SetScaleRange (ValueRange< double > value)
	Range of scales, that the classifier should be able to cover.

int	FeatureCount () const noexcept
	Minimum number of features the result classifier should have.

void	SetFeatureCount (int value)
	Minimum number of features the result classifier should have.

int	ContrastThreshold () const noexcept
	Minimum contrast a feature must have to enter into the classifier.

void	SetContrastThreshold (int value)
	Minimum contrast a feature must have to enter into the classifier.

int	MaxCoarseLayerScale () const noexcept
	Maximum exponent of the scale factor between the coarse layer and the image.

void	SetMaxCoarseLayerScale (int value)
	Maximum exponent of the scale factor between the coarse layer and the image.

Cvb::ShapeFinder2::ContrastMode	ContrastMode () const noexcept
	Contrast mode to be used for feature extraction.

void	SetContrastMode (Cvb::ShapeFinder2::ContrastMode mode) noexcept
	Contrast mode to be used for feature extraction.

int	ProfileSize () const noexcept
	Profile size gives the number of profile points to be used for correlation around each feature.

void	SetProfileSize (int value)
	Profile size gives the number of profile points to be used for correlation around each feature.

int	ProfileDelta () const noexcept
	Distance (in pixels) between adjacent profile points.

void	SetProfileDelta (int value)
	Distance (in pixels) between adjacent profile points.

std::unique_ptr< Classifier >	Learn (const ImagePlane &plane, Point2D< int > position, Rect< int > teachWindow, const std::vector< Point2D< int > > &dontCarePoints) const
	Creates a ShapeFinder2 classifier from plane 0 of the input image.

std::unique_ptr< Classifier >	Learn (const ImagePlane &plane, Point2D< int > position, Rect< int > teachWindow) const
	Create a ShapeFinder2 classifier from plane 0 of the input image.

std::unique_ptr< Classifier >	Learn (const ImagePlane &plane, Point2D< int > position, Angle angleOffset, double scaleFactor, Rect< int > teachWindow) const
	Create a ShapeFinder2 classifier from the input image.

std::unique_ptr< Classifier >	Learn (const ImagePlane &plane, Point2D< int > position, Angle angleOffset, double scaleFactor, Rect< int > teachWindow, const std::vector< Point2D< int > > &dontCarePoints) const
	Create a ShapeFinder2 classifier from the input image.

Detailed Description

ShapeFinder2 classifier factory object.

Constructor & Destructor Documentation

◆ ClassifierFactory()

ClassifierFactory ( )

defaultnoexcept

The object that holds methods for generating ShapeFinder classifier factory.

Exceptions

Does	not throw any exception.

Member Function Documentation

◆ ContrastMode()

Cvb::ShapeFinder2::ContrastMode ContrastMode ( ) const

inlinenoexcept

Contrast mode to be used for feature extraction.

Returns: The contrast mode

Exceptions

Does	not throw any exception.

◆ ContrastThreshold()

int ContrastThreshold ( ) const

inlinenoexcept

Minimum contrast a feature must have to enter into the classifier.

Returns: The minimum contrast

Exceptions

Does	not throw any exception.

◆ FeatureCount()

int FeatureCount ( ) const

inlinenoexcept

Minimum number of features the result classifier should have.

Returns: The minimum number of features

Exceptions

Does	not throw any exception.

◆ GradientHistogram()

std::vector< int > GradientHistogram	(	const ImagePlane &	plane,
		Rect< int >	aoi,
		ShapeFinder2::GradientType	gradient ) const

inline

Calculate the gradient histogram.

Parameters

[in]	plane	The image plane in which to calculate the histogram.
[in]	aoi	The area of interest in which to calculate the histogram.
[in]	gradient	The gradient operator to calculate the histogram.

Returns: The calculated histogram

Exceptions

Any	exception derived from std::exception including CvbException.

◆ Learn() [1/4]

std::unique_ptr< Classifier > Learn	(	const ImagePlane &	plane,
		Point2D< int >	position,
		Angle	angleOffset,
		double	scaleFactor,
		Rect< int >	teachWindow ) const

inline

Create a ShapeFinder2 classifier from the input image.

Parameters

[in]	plane	The image plane to create the classifier from.
[in]	position	The position in the input image at which to extract the classifier.
[in]	angleOffset	The initial rotation of the object.
[in]	scaleFactor	The initial scale factor of the object.
[in]	teachWindow	The teach window for the classifier learning process relative to position.

Returns: The newly created classifier

Exceptions

Any	exception derived from std::exception including CvbException.

◆ Learn() [2/4]

std::unique_ptr< Classifier > Learn	(	const ImagePlane &	plane,
		Point2D< int >	position,
		Angle	angleOffset,
		double	scaleFactor,
		Rect< int >	teachWindow,
		const std::vector< Point2D< int > > &	dontCarePoints ) const

inline

Create a ShapeFinder2 classifier from the input image.

Parameters

[in]	plane	The image plane to create the classifier from.
[in]	position	The position in the input image at which to extract the classifier.
[in]	angleOffset	The initial rotation of the object.
[in]	scaleFactor	The initial scale factor of the object.
[in]	teachWindow	The teach window for the classifier learning process relative to position.
[in]	dontCarePoints	The list of points relative to position from which no features for the classifier should be extracted.

Returns: The newly created classifier

Exceptions

Any	exception derived from std::exception including CvbException.

◆ Learn() [3/4]

std::unique_ptr< Classifier > Learn	(	const ImagePlane &	plane,
		Point2D< int >	position,
		Rect< int >	teachWindow ) const

inline

Create a ShapeFinder2 classifier from plane 0 of the input image.

Parameters

[in]	plane	The plane in the input image from which to create the classifier.
[in]	position	The position in the input image at which to extract the classifier.
[in]	teachWindow	The teach window for the classifier learning process relative to position.

Returns: The newly created classifier

Exceptions

Any	exception derived from std::exception including CvbException.

◆ Learn() [4/4]

std::unique_ptr< Classifier > Learn	(	const ImagePlane &	plane,
		Point2D< int >	position,
		Rect< int >	teachWindow,
		const std::vector< Point2D< int > > &	dontCarePoints ) const

inline

Creates a ShapeFinder2 classifier from plane 0 of the input image.

Parameters

[in]	plane	The plane in the input image from which to create the classifier.
[in]	position	The position in the input image at which to extract the classifier.
[in]	teachWindow	The teach window for the classifier learning process relative to position.
[in]	dontCarePoints	The list of points relative to position from which no features for the classifier should be extracted.

Returns: The newly created classifier

Exceptions

Any	exception derived from std::exception including CvbException.

◆ MaxCoarseLayerScale()

int MaxCoarseLayerScale ( ) const

inlinenoexcept

Maximum exponent of the scale factor between the coarse layer and the image.

Returns: The maximum exponent of the scale factor

Exceptions

Does	not throw any exception.

◆ ProfileDelta()

int ProfileDelta ( ) const

inlinenoexcept

Distance (in pixels) between adjacent profile points.

Returns: The profile delta

Exceptions

Does	not throw any exception.

◆ ProfileSize()

int ProfileSize ( ) const

inlinenoexcept

Profile size gives the number of profile points to be used for correlation around each feature.

Returns: The profile size

Exceptions

Does	not throw any exception.

◆ RotationRange()

ValueRange< Angle > RotationRange ( ) const

inlinenoexcept

Range of rotations, that the classifier should be able to cover.

Returns: The range of rotations

Exceptions

Does	not throw any exception.

◆ RotationRangeMax()

ValueRange< Angle > RotationRangeMax ( ) const

inlinenoexcept

The maximum range of rotations (in degrees), that may be set on the learner.

Returns: The maximum range of rotations

Exceptions

Does	not throw any exception.

◆ ScaleRange()

ValueRange< double > ScaleRange ( ) const

inlinenoexcept

Range of scales, that the classifier should be able to cover.

Returns: The range of scales

Exceptions

Does	not throw any exception.

◆ ScaleRangeMax()

ValueRange< double > ScaleRangeMax ( ) const

inlinenoexcept

The maximum range of scales, that may be set on the learner.

Returns: The maximum range of scales

Exceptions

Does	not throw any exception.

◆ SetContrastMode()

void SetContrastMode ( Cvb::ShapeFinder2::ContrastMode mode )

inlinenoexcept

Contrast mode to be used for feature extraction.

Parameters

[in] mode The contrast mode.

Exceptions

Does	not throw any exception.

◆ SetContrastThreshold()

void SetContrastThreshold ( int value )

inline

Minimum contrast a feature must have to enter into the classifier.

Parameters

[in] value The minimum contrast.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ SetFeatureCount()

void SetFeatureCount ( int value )

inline

Minimum number of features the result classifier should have.

Parameters

[in] value The minimum number of features.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ SetMaxCoarseLayerScale()

void SetMaxCoarseLayerScale ( int value )

inline

Maximum exponent of the scale factor between the coarse layer and the image.

Parameters

[in] value The maximum exponent of the scale factor.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ SetProfileDelta()

void SetProfileDelta ( int value )

inline

Distance (in pixels) between adjacent profile points.

Parameters

[in] value The profile delta.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ SetProfileSize()

void SetProfileSize ( int value )

inline

Profile size gives the number of profile points to be used for correlation around each feature.

Parameters

[in] value The profile size.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ SetRotationRange()

void SetRotationRange ( ValueRange< Angle > value )

inline

Range of rotations, that the classifier should be able to cover.

Parameters

[in] value The minimum and maximum rotation range.

Exceptions

Any	exception derived from std::exception including CvbException.

◆ SetScaleRange()

void SetScaleRange ( ValueRange< double > value )

inline

Range of scales, that the classifier should be able to cover.

Parameters

[in] value The minimum and maximum scale range.

Exceptions

Any	exception derived from std::exception including CvbException.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ClassifierFactory()

Member Function Documentation

◆ ContrastMode()

◆ ContrastThreshold()

◆ FeatureCount()

◆ GradientHistogram()

◆ Learn() [1/4]

◆ Learn() [2/4]

◆ Learn() [3/4]

◆ Learn() [4/4]

◆ MaxCoarseLayerScale()

◆ ProfileDelta()

◆ ProfileSize()

◆ RotationRange()

◆ RotationRangeMax()

◆ ScaleRange()

◆ ScaleRangeMax()

◆ SetContrastMode()

◆ SetContrastThreshold()

◆ SetFeatureCount()

◆ SetMaxCoarseLayerScale()

◆ SetProfileDelta()

◆ SetProfileSize()

◆ SetRotationRange()

◆ SetScaleRange()