ImageMoments Class Reference

State object for calculating various image moments. More...

#include <cvb/foundation/moments.hpp>

Public Member Functions
	ImageMoments (const ImagePlane &imagePlane, Rect< int > aoi, MomentsCalculation preference=MomentsCalculation::FavorNone)
	Calculate the moments on the input ImagePlane and area of interest.
	ImageMoments (const ImagePlane &imagePlane, MomentsCalculation preference=MomentsCalculation::FavorNone)
	Calculate the moments on the input imagePlane.
	ImageMoments (ImageMoments &&) noexcept=default
	Move constructor.
ImageMoments &	operator= (ImageMoments &&) noexcept=default
	Move assignment operator.
MomentsCalculation	CalculationPreference () const noexcept
	The preference of speed versus accuracy chosen when this object was created.
void *	Handle () const noexcept
	Classic API IMGMOMENTS handle.
double	SpatialMoment (MomentsOrder xOrder, MomentsOrder yOrder, MomentsNormalization normalization, Point2D< int > offset)
	Get one of the spatial image moments.
double	SpatialMoment (MomentsOrder xOrder, MomentsOrder yOrder, MomentsNormalization normalization)
	Get one of the spatial image moments.
double	CentralMoment (MomentsOrder xOrder, MomentsOrder yOrder, MomentsNormalization normalization)
	Get one of the central image moments.
HuMoments	HuMoments ()
	Get the seven Hu moments of the image.

Static Public Member Functions
static std::unique_ptr< ImageMoments >	Calculate (const ImagePlane &imagePlane, Rect< int > aoi, MomentsCalculation preference=MomentsCalculation::FavorNone)
	Calculate the moments on the input imagePlane and aoi.
static std::unique_ptr< ImageMoments >	Calculate (const ImagePlane &imagePlane, MomentsCalculation preference=MomentsCalculation::FavorNone)
	Calculate the moments on the input imagePlane.

Detailed Description

State object for calculating various image moments.

Constructor & Destructor Documentation

ImageMoments() [1/2]

ImageMoments ( const ImagePlane & imagePlane, Rect< int > aoi, MomentsCalculation preference = MomentsCalculation::FavorNone )

inline

Calculate the moments on the input ImagePlane and area of interest.

Parameters

[in]	imagePlane	Plane to calculate the moments.
[in]	aoi	Area of interest to calculate the moments in.
[in]	preference	Speed or accuracy.

Exceptions

Any	exception derived from std::exception including CvbException.

ImageMoments() [2/2]

ImageMoments ( const ImagePlane & imagePlane, MomentsCalculation preference = MomentsCalculation::FavorNone )

inline

Calculate the moments on the input imagePlane.

Parameters

[in]	imagePlane	Plane on which to calculate the moments.
[in]	preference	Speed or accuracy.

Exceptions

Any	exception derived from std::exception including CvbException.

Member Function Documentation

Calculate() [1/2]

static std::unique_ptr< ImageMoments > Calculate ( const ImagePlane & imagePlane, MomentsCalculation preference = MomentsCalculation::FavorNone )

inlinestatic

Calculate the moments on the input imagePlane.

Parameters

[in]	imagePlane	Plane on which to calculate the moments.
[in]	preference	Speed or accuracy.

Returns

Pointer to the created moments object.

Exceptions

Does	not throw any exception.

Calculate() [2/2]

static std::unique_ptr< ImageMoments > Calculate ( const ImagePlane & imagePlane, Rect< int > aoi, MomentsCalculation preference = MomentsCalculation::FavorNone )

inlinestatic

Calculate the moments on the input imagePlane and aoi.

Parameters

[in]	imagePlane	Plane on which to calculate the moments.
[in]	aoi	Area of interest to calculate the moments.
[in]	preference	Speed or accuracy.

Returns

Pointer to the created moments object.

Exceptions

Does	not throw any exception.

CalculationPreference()

MomentsCalculation CalculationPreference ( ) const

inlinenoexcept

The preference of speed versus accuracy chosen when this object was created.

Returns

The preference value.

Exceptions

Does	not throw any exception.

CentralMoment()

double CentralMoment ( MomentsOrder xOrder, MomentsOrder yOrder, MomentsNormalization normalization )

inline

Get one of the central image moments.

Parameters

[in]	xOrder	X order of the moment to retrieve.
[in]	yOrder	Y order of the moment to retrieve.
[in]	normalization	Whether or not to normalize.

Returns

The central moment.

Exceptions

Any	exception derived from std::exception including CvbException.

Handle()

void * Handle ( ) const

inlinenoexcept

Classic API IMGMOMENTS handle.

Returns

Classic API handle.

Exceptions

Does	not throw any exception.

It is normally not necessary to work with this handle.

HuMoments()

HuMoments HuMoments ( )

inline

Get the seven Hu moments of the image.

Returns

Hu moments.

Exceptions

Any	exception derived from std::exception including CvbException.

SpatialMoment() [1/2]

double SpatialMoment ( MomentsOrder xOrder, MomentsOrder yOrder, MomentsNormalization normalization )

inline

Get one of the spatial image moments.

Parameters

[in]	xOrder	X order of the moment to retrieve.
[in]	yOrder	Y order of the moment to retrieve.
[in]	normalization	Whether or not to normalize.

Returns

The spatial moment.

Exceptions

Any	exception derived from std::exception including CvbException.

This overload automatically uses the offset used in creating this object.

SpatialMoment() [2/2]

double SpatialMoment ( MomentsOrder xOrder, MomentsOrder yOrder, MomentsNormalization normalization, Point2D< int > offset )

inline

Get one of the spatial image moments.

Parameters

[in]	xOrder	X order of the moment to retrieve.
[in]	yOrder	Y order of the moment to retrieve.
[in]	normalization	Whether or not to normalize.
[in]	offset	Offset of the moments.

Returns

The spatial moment.

Exceptions

Any	exception derived from std::exception including CvbException.