Struct opencv::core::KeyPoint

#[repr(C)]
pub struct KeyPoint {
    pub pt: Point2f,
    pub size: f32,
    pub angle: f32,
    pub response: f32,
    pub octave: i32,
    pub class_id: i32,
}

Data structure for salient point detectors.

The class instance stores a keypoint, i.e. a point feature found by one of many available keypoint detectors, such as Harris corner detector, #FAST, %StarDetector, %SURF, %SIFT etc.

The keypoint is characterized by the 2D position, scale (proportional to the diameter of the neighborhood that needs to be taken into account), orientation and some other parameters. The keypoint neighborhood is then analyzed by another algorithm that builds a descriptor (usually represented as a feature vector). The keypoints representing the same object in different images can then be matched using %KDTree or another method.

Fields

pt: Point2f

coordinates of the keypoints

size: f32

diameter of the meaningful keypoint neighborhood

angle: f32

computed orientation of the keypoint (-1 if not applicable); it’s in [0,360) degrees and measured relative to image coordinate system, ie in clockwise.

response: f32

the response by which the most strong keypoints have been selected. Can be used for the further sorting or subsampling

octave: i32

octave (pyramid layer) from which the keypoint has been extracted

class_id: i32

object class (if the keypoints need to be clustered by an object they belong to)

Implementations

impl KeyPoint

pub fn hash(self) -> Result<size_t>

pub fn default() -> Result<KeyPoint>

the default constructor

pub fn new_point(
    pt: Point2f,
    size: f32,
    angle: f32,
    response: f32,
    octave: i32,
    class_id: i32
) -> Result<KeyPoint>

Parameters

• pt: x & y coordinates of the keypoint
• size: keypoint diameter
• angle: keypoint orientation
• response: keypoint detector response on the keypoint (that is, strength of the keypoint)
• octave: pyramid octave in which the keypoint has been detected
• class_id: object id

C++ default parameters

• angle: -1
• response: 0
• octave: 0
• class_id: -1

pub fn new_coords(
    x: f32,
    y: f32,
    size: f32,
    angle: f32,
    response: f32,
    octave: i32,
    class_id: i32
) -> Result<KeyPoint>

Parameters

• x: x-coordinate of the keypoint
• y: y-coordinate of the keypoint
• size: keypoint diameter
• angle: keypoint orientation
• response: keypoint detector response on the keypoint (that is, strength of the keypoint)
• octave: pyramid octave in which the keypoint has been detected
• class_id: object id

C++ default parameters

• angle: -1
• response: 0
• octave: 0
• class_id: -1

pub fn convert(
    keypoints: &Vector<KeyPoint>,
    points2f: &mut Vector<Point2f>,
    keypoint_indexes: &Vector<i32>
) -> Result<()>

This method converts vector of keypoints to vector of points or the reverse, where each keypoint is assigned the same size and the same orientation.

Parameters

• keypoints: Keypoints obtained from any feature detection algorithm like SIFT/SURF/ORB
• points2f: Array of (x,y) coordinates of each keypoint
• keypointIndexes: Array of indexes of keypoints to be converted to points. (Acts like a mask to convert only specified keypoints)

C++ default parameters

• keypoint_indexes: std::vector()

pub fn convert_to(
    points2f: &Vector<Point2f>,
    keypoints: &mut Vector<KeyPoint>,
    size: f32,
    response: f32,
    octave: i32,
    class_id: i32
) -> Result<()>

This method converts vector of keypoints to vector of points or the reverse, where each keypoint is assigned the same size and the same orientation.

Parameters

• keypoints: Keypoints obtained from any feature detection algorithm like SIFT/SURF/ORB
• points2f: Array of (x,y) coordinates of each keypoint
• keypointIndexes: Array of indexes of keypoints to be converted to points. (Acts like a mask to convert only specified keypoints)

Overloaded parameters

• points2f: Array of (x,y) coordinates of each keypoint
• keypoints: Keypoints obtained from any feature detection algorithm like SIFT/SURF/ORB
• size: keypoint diameter
• response: keypoint detector response on the keypoint (that is, strength of the keypoint)
• octave: pyramid octave in which the keypoint has been detected
• class_id: object id

C++ default parameters

• size: 1
• response: 1
• octave: 0
• class_id: -1

pub fn overlap(kp1: KeyPoint, kp2: KeyPoint) -> Result<f32>

This method computes overlap for pair of keypoints. Overlap is the ratio between area of keypoint regions’ intersection and area of keypoint regions’ union (considering keypoint region as circle). If they don’t overlap, we get zero. If they coincide at same location with same size, we get 1.

Parameters

• kp1: First keypoint
• kp2: Second keypoint

Trait Implementations

impl Clone for KeyPoint

fn clone(&self) -> KeyPoint

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KeyPoint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<KeyPoint> for KeyPoint

fn eq(&self, other: &KeyPoint) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for KeyPoint

impl StructuralPartialEq for KeyPoint

impl VectorElement for KeyPointwhere
    Vector<KeyPoint>: VectorExtern<KeyPoint>,