PFeaturePoint Class Reference

Detailed Description

The PFeaturePoint class represents a sub-pixel accurate 2D location on an image; PFeaturePoint instances are immutable (thread-safe).

Definition at line 28 of file PFeaturePoint.h.

#include <PFeaturePoint.h>

Constructor & Destructor Documentation

◆ PFeaturePoint() [1/3]

PFeaturePoint::PFeaturePoint ( )

Constructs an invalid feature point.

◆ PFeaturePoint() [2/3]

PFeaturePoint::PFeaturePoint ( const PFeaturePoint other)

Constructs a shared of other.

◆ PFeaturePoint() [3/3]

PFeaturePoint::PFeaturePoint ( const PPoint2Df location,
const PString description,
float  confidence 
)

Constructs a feature point from its location, its description and a confidence value.

◆ ~PFeaturePoint()

virtual PFeaturePoint::~PFeaturePoint ( )
virtual

Destroys this object.

Member Function Documentation

◆ Bad()

static const PFeaturePoint& PFeaturePoint::Bad ( )
inlinestatic

Returns the constant holding the bad instance of a PFeaturePoint.

Definition at line 34 of file PFeaturePoint.h.

◆ FeaturePoints()

static const papillon::PStringList& PFeaturePoint::FeaturePoints ( )
static

Returns the mapping of feature point id to feature name.

This mapping contains 68 points and corresponds to the output of FaceDetector2.

◆ Finalise()

static void PFeaturePoint::Finalise ( )
static

◆ GetColumn()

float PFeaturePoint::GetColumn ( ) const

DEPRECATED, use GetX() instead.

Returns the column (x) of this feature point.

◆ GetConfidence()

float PFeaturePoint::GetConfidence ( ) const

Returns the confidence of this feature point.

◆ GetDescription()

PString PFeaturePoint::GetDescription ( ) const

Returns the description associated with this feature point.

◆ GetLocation()

const PPoint2Df& PFeaturePoint::GetLocation ( ) const

Returns the location of this feature point.

◆ GetRow()

float PFeaturePoint::GetRow ( ) const

DEPRECATED, use GetY() instead.

Returns the row (y) of this feature point.

◆ GetX()

float PFeaturePoint::GetX ( ) const

Returns the column (x) of this feature point.

◆ GetY()

float PFeaturePoint::GetY ( ) const

Returns the row (y) of this feature point.

◆ Initialise()

static void PFeaturePoint::Initialise ( )
static

◆ IsValid()

bool PFeaturePoint::IsValid ( ) const

Returns true if this feature point is valid, false otherwise.

See also
Bad()

◆ operator!=()

bool PFeaturePoint::operator!= ( const PFeaturePoint other) const

Returns true if this PFeaturePoint is different from other; otherwise returns false.

◆ operator=()

PFeaturePoint& PFeaturePoint::operator= ( const PFeaturePoint other)

Performs a shared copy of other to this object.

◆ operator==()

bool PFeaturePoint::operator== ( const PFeaturePoint other) const

Returns true if this PFeaturePoint is equal to other; otherwise returns false.