Cvb::Foundation::Norm Namespace Reference

Namespace for collection of functions for calculating different norms over the gray values of an image. More...

Enumerations
enum class	ValueNormalization { Unnormalized , Normalized }
	Available normalization modes for norm calculations. More...

Functions
double	NormL1 (const ImagePlane &plane, ValueNormalization normalize, Rect< int > aoi)
	Calculate and return the L1 norm (sum of absolute values) over all the pixels inside the plane. More...
double	NormL1 (const ImagePlane &plane, ValueNormalization normalize)
	Calculate and return the L1 norm (sum of absolute values) over all the pixels inside the plane. More...
double	NormL2 (const ImagePlane &plane, ValueNormalization normalize, Rect< int > aoi)
	Calculate and return the L2 norm (euclidean norm) over the pixels inside the plane. More...
double	NormL2 (const ImagePlane &plane, ValueNormalization normalize)
	Calculate and return the L2 norm (euclidean norm) over the pixels inside the plane. More...
double	NormLInf (const ImagePlane &plane, ValueNormalization normalize, Rect< int > aoi)
	Calculate and return the L infinity norm (maximum norm) over the pixels inside the plane. More...
double	NormLInf (const ImagePlane &plane, ValueNormalization normalize)
	Calculate and return the L infinity norm (maximum norm) over the pixels inside the plane. More...

Detailed Description

Namespace for collection of functions for calculating different norms over the gray values of an image.

Remarks

CMake users: Link to imported target CVB::CvbFoundationNorm

Enumeration Type Documentation

ValueNormalization

enum class ValueNormalization

strong

Available normalization modes for norm calculations.

Enumerator
Unnormalized	Report norms unnormalized.
Normalized	Report norms normalized.

Function Documentation

NormL1() [1/2]

double NormL1 ( const ImagePlane &  plane, ValueNormalization  normalize  )

inline

Calculate and return the L1 norm (sum of absolute values) over all the pixels inside the plane.

Parameters

[in]	plane	Plane to calculate the norm on.
[in]	normalize	Normalize results to [0...1] or not.

Returns

The calculated norm.

Exceptions

Any	exception derived from std::exception including CvbException.

NormL1() [2/2]

double NormL1 ( const ImagePlane &  plane, ValueNormalization  normalize, Rect< int >  aoi  )

inline

Calculate and return the L1 norm (sum of absolute values) over all the pixels inside the plane.

Parameters

[in]	plane	Plane to calculate the norm on.
[in]	normalize	Normalize results to [0...1] or not.
[in]	aoi	Area to calculate the norm in.

Returns

The calculated norm.

Exceptions

Any	exception derived from std::exception including CvbException.

NormL2() [1/2]

double NormL2 ( const ImagePlane &  plane, ValueNormalization  normalize  )

inline

Calculate and return the L2 norm (euclidean norm) over the pixels inside the plane.

Parameters

[in]	plane	Plane to calculate the norm on.
[in]	normalize	Normalize results to [0...1] or not.

Returns

The calculated norm.

Exceptions

Any	exception derived from std::exception including CvbException.

NormL2() [2/2]

double NormL2 ( const ImagePlane &  plane, ValueNormalization  normalize, Rect< int >  aoi  )

inline

Calculate and return the L2 norm (euclidean norm) over the pixels inside the plane.

Parameters

[in]	plane	Plane to calculate the norm on.
[in]	normalize	Normalize results to [0...1] or not.
[in]	aoi	Area to calculate the norm in.

Returns

The calculated norm.

Exceptions

Any	exception derived from std::exception including CvbException.

NormLInf() [1/2]

double NormLInf ( const ImagePlane &  plane, ValueNormalization  normalize  )

inline

Calculate and return the L infinity norm (maximum norm) over the pixels inside the plane.

Parameters

[in]	plane	Plane to calculate the norm on.
[in]	normalize	Normalize results to [0...1] or not.

Returns

The calculated norm.

Exceptions

Any	exception derived from std::exception including CvbException.

NormLInf() [2/2]

double NormLInf ( const ImagePlane &  plane, ValueNormalization  normalize, Rect< int >  aoi  )

inline

Calculate and return the L infinity norm (maximum norm) over the pixels inside the plane.

Parameters

[in]	plane	Plane to calculate the norm on.
[in]	normalize	Normalize results to [0...1] or not.
[in]	aoi	Area to calculate the norm in.

Returns

The calculated norm.

Exceptions

Any	exception derived from std::exception including CvbException.