speedy-vision/types/core/speedy-keypoint.d.ts

GPU-accelerated Computer Vision for JavaScript

/**
 * Represents a keypoint
 */
export class SpeedyKeypoint {
    /**
     * Constructor
     * @param {number} x X position
     * @param {number} y Y position
     * @param {number} [lod] Level-of-detail
     * @param {number} [rotation] Rotation in radians
     * @param {number} [score] Cornerness measure
     * @param {SpeedyKeypointDescriptor|null} [descriptor] Keypoint descriptor, if any
     */
    constructor(x: number, y: number, lod?: number | undefined, rotation?: number | undefined, score?: number | undefined, descriptor?: SpeedyKeypointDescriptor | null | undefined);
    /** @type {SpeedyPoint2} keypoint position */
    _position: SpeedyPoint2;
    /** @type {number} level of detail */
    _lod: number;
    /** @type {number} rotation in radians */
    _rotation: number;
    /** @type {number} a cornerness measure */
    _score: number;
    /** @type {SpeedyKeypointDescriptor|null} keypoint descriptor, if any */
    _descriptor: SpeedyKeypointDescriptor | null;
    /**
     * Converts this keypoint to a descriptive string
     * @returns {string}
     */
    toString(): string;
    /**
     * The position of this keypoint
     * @returns {SpeedyPoint2}
     */
    get position(): SpeedyPoint2;
    /**
     * The x-position of this keypoint
     * @param {number} value
     */
    set x(arg: number);
    /**
     * The x-position of this keypoint
     * @returns {number}
     */
    get x(): number;
    /**
     * The y-position of this keypoint
     * @param {number} value
     */
    set y(arg: number);
    /**
     * The y-position of this keypoint
     * @returns {number}
     */
    get y(): number;
    /**
     * The pyramid level-of-detail from which this keypoint was extracted
     * @returns {number}
     */
    get lod(): number;
    /**
     * Scale: 2^lod
     * @returns {number}
     */
    get scale(): number;
    /**
     * The orientation of the keypoint, in radians
     * @returns {number} Angle in radians
     */
    get rotation(): number;
    /**
     * Score: a cornerness measure
     * @returns {number} Score
     */
    get score(): number;
    /**
     * Keypoint descriptor
     * @return {SpeedyKeypointDescriptor|null}
     */
    get descriptor(): SpeedyKeypointDescriptor | null;
}
/**
 * Represents a tracked keypoint
 */
export class SpeedyTrackedKeypoint extends SpeedyKeypoint {
    /**
     * Constructor
     * @param {number} x X position
     * @param {number} y Y position
     * @param {number} [lod] Level-of-detail
     * @param {number} [rotation] Rotation in radians
     * @param {number} [score] Cornerness measure
     * @param {SpeedyKeypointDescriptor|null} [descriptor] Keypoint descriptor, if any
     * @param {SpeedyVector2} [flow] flow vector
     */
    constructor(x: number, y: number, lod?: number | undefined, rotation?: number | undefined, score?: number | undefined, descriptor?: SpeedyKeypointDescriptor | null | undefined, flow?: SpeedyVector2 | undefined);
    /** @type {SpeedyVector2} flow vector */
    _flow: SpeedyVector2;
    /**
     * Flow vector
     * @returns {SpeedyVector2}
     */
    get flow(): SpeedyVector2;
}
/**
 * Represents a matched keypoint
 */
export class SpeedyMatchedKeypoint extends SpeedyKeypoint {
    /**
     * Constructor
     * @param {number} x X position
     * @param {number} y Y position
     * @param {number} [lod] Level-of-detail
     * @param {number} [rotation] Rotation in radians
     * @param {number} [score] Cornerness measure
     * @param {SpeedyKeypointDescriptor|null} [descriptor] Keypoint descriptor, if any
     * @param {SpeedyKeypointMatch[]} [matches] Keypoint matches, if any
     */
    constructor(x: number, y: number, lod?: number | undefined, rotation?: number | undefined, score?: number | undefined, descriptor?: SpeedyKeypointDescriptor | null | undefined, matches?: SpeedyKeypointMatch[] | undefined);
    /** @type {SpeedyKeypointMatch[]} keypoint matches */
    _matches: SpeedyKeypointMatch[];
    /**
     * Keypoint matches
     * @returns {SpeedyKeypointMatch[]}
     */
    get matches(): SpeedyKeypointMatch[];
}
import { SpeedyPoint2 } from "./speedy-point";
import { SpeedyKeypointDescriptor } from "./speedy-keypoint-descriptor";
import { SpeedyVector2 } from "./speedy-vector";
import { SpeedyKeypointMatch } from "./speedy-keypoint-match";