Ocean::CV::Calibration::Point Class Reference

This class holds the relevant information of a detected marker point. More...

#include <Point.h>

Public Member Functions
	Point ()=default
	Creates a new invalid point.
	Point (const Vector2 &observation, const unsigned int radius, const float strength)
	Creates a new point.
const Vector2 &	observation () const
	Returns the 2D observation location in the camera image.
float	strength () const
	Returns th strength of the point, positive for black points on white background, negative for white points on black background.
bool	sign () const
	Returns the sign of the point, true for black points on white background, false for white points on black background.
unsigned int	radius () const
	Returns the radius of this point (the scale of the point).
bool	isValid () const
	Returns whether this point is valid.

Protected Attributes
Vector2	observation_ = Vector2::minValue()
	The 2D observation of the point within the camera image.
unsigned int	radius_ = 0u
	The radius of the point (the scale of the point), in pixel, with range [1, infinity)
float	strength_ = 0.0f
	The strength of the point, positive for black points on white background, negative for white points on black background, with range (-infinity, infinity)

Detailed Description

This class holds the relevant information of a detected marker point.

A point is defined by an 2D observation location in the camera image, an approximated radius of the point, a sign (black vs. white), and a strength value.

Constructor & Destructor Documentation

Point() [1/2]

Ocean::CV::Calibration::Point::Point ( )

default

Creates a new invalid point.

Point() [2/2]

Ocean::CV::Calibration::Point::Point ( const Vector2 &  observation, const unsigned int  radius, const float  strength  )

inline

Creates a new point.

Parameters

observation	The 2D observation location in the camera image, must be valid
radius	The approximated radius of the point, in pixel, with range [1, infinity)
strength	The strength of the point, with range [0, infinity)

Member Function Documentation

isValid()

bool Ocean::CV::Calibration::Point::isValid ( ) const

inline

Returns whether this point is valid.

Returns

True, if so

observation()

const Vector2 & Ocean::CV::Calibration::Point::observation ( ) const

inline

Returns the 2D observation location in the camera image.

Returns

The point's observation

radius()

unsigned int Ocean::CV::Calibration::Point::radius ( ) const

inline

Returns the radius of this point (the scale of the point).

Returns

The point's radius, in pixel

sign()

bool Ocean::CV::Calibration::Point::sign ( ) const

inline

Returns the sign of the point, true for black points on white background, false for white points on black background.

Returns

The point's sign

strength()

float Ocean::CV::Calibration::Point::strength ( ) const

inline

Returns th strength of the point, positive for black points on white background, negative for white points on black background.

Returns

The point's strength

Field Documentation

observation_

Vector2 Ocean::CV::Calibration::Point::observation_ = Vector2::minValue()

protected

The 2D observation of the point within the camera image.

radius_

unsigned int Ocean::CV::Calibration::Point::radius_ = 0u

protected

The radius of the point (the scale of the point), in pixel, with range [1, infinity)

strength_

float Ocean::CV::Calibration::Point::strength_ = 0.0f

protected

The strength of the point, positive for black points on white background, negative for white points on black background, with range (-infinity, infinity)

---

The documentation for this class was generated from the following file:

• cv/calibration/Point.h