BasicKeyPoint¶

class BasicKeyPoint¶

Bases: pybind11_object

class that defines what is a keypoint. This class provides all the basic elements to implement classes which aims to match points from an image to another.

Methods

`__init__`
`getCurrentImagePointsList`	Return the vector of current image point.
`getIndexInAllReferencePointList`	Get the nth matched reference point index in the complete list of reference point.
`getMatchedPointNumber`	Get the number of matched points.
`getMatchedPoints`	Get the nth couple of reference point and current point which have been matched.
`getMatchedReferencePoints`	Return the index of the matched associated to the current image point i.
`getReferenceImagePointsList`	Return the vector of reference image point.
`getReferencePoint`	Get the nth reference point.
`getReferencePointNumber`	Get the number of reference points.
`referenceBuilt`	Indicate wether the reference has been built or not.

Inherited Methods

Operators

`__doc__`
`__init__`
`__module__`

Attributes

`__annotations__`

__init__(*args, **kwargs)¶

getCurrentImagePointsList(self) → list[visp._visp.core.ImagePoint]¶

Return the vector of current image point.

Returns:: Vector of the current image point.

getIndexInAllReferencePointList(self, indexInMatchedPointList: int) → int¶

Get the nth matched reference point index in the complete list of reference point.

In the code below referencePoint1 and referencePoint2 correspond to the same matched reference point.

vpKeyPoint keypoint;

// Here the code to compute the reference points and the current points.
vpImagePoint referencePoint1;
vpImagePoint currentPoint;
keypoint.getMatchedPoints(1, referencePoint1, currentPoint);  //Get the first matched points

vpImagePoint referencePoint2;
const vpImagePoint* referencePointsList = keypoint.getAllPointsInReferenceImage();
// Get the first matched reference point index in the complete reference point list
int index = keypoint.getIndexInAllReferencePointList(1);
// Get the first matched reference point
referencePoint2 = referencePointsList[index];

getMatchedPointNumber(self) → int¶

Get the number of matched points.

Returns:: the number of matched points.

getMatchedPoints(self, index: int, referencePoint: visp._visp.core.ImagePoint, currentPoint: visp._visp.core.ImagePoint) → None¶

Get the nth couple of reference point and current point which have been matched. These points are copied in the vpImagePoint instances given in argument.

Parameters:

index: int¶: The index of the desired couple of reference point and current point. The index must be between 0 and the number of matched points - 1.
referencePoint: visp._visp.core.ImagePoint¶: The coordinates of the desired reference point are copied here.
currentPoint: visp._visp.core.ImagePoint¶: The coordinates of the desired current point are copied here.

getMatchedReferencePoints(self) → list[int]¶

Return the index of the matched associated to the current image point i. The ith element of the vector is the index of the reference image point matching with the current image point.

Returns:: The vector of matching index.

getReferenceImagePointsList(self) → list[visp._visp.core.ImagePoint]¶

Return the vector of reference image point.

Returns:: Vector of reference image point.

getReferencePoint(self, index: int, referencePoint: visp._visp.core.ImagePoint) → None¶

Get the nth reference point. This point is copied in the vpImagePoint instance given in argument.

Parameters:

index: int¶: The index of the desired reference point. The index must be between 0 and the number of reference points - 1.
referencePoint: visp._visp.core.ImagePoint¶: The coordinates of the desired reference point are copied there.

getReferencePointNumber(self) → int¶

Get the number of reference points.

Returns:: the number of reference points.

referenceBuilt(self) → bool¶

Indicate wether the reference has been built or not.

Returns:: True if the reference of the current instance has been built.