spot-sdk-ts
Version:
TypeScript bindings based on protobufs (proto3) provided by Boston Dynamics
339 lines • 14.7 kB
TypeScript
import { Vec2 } from "./geometry";
import _m0 from "protobufjs/minimal";
export declare const protobufPackage = "bosdyn.api";
/** A point of interest in an image expressed as a pixel coordinate with associated metadata. */
export interface Keypoint {
/** The image pixel coordinates of the keypoint. */
coordinates: Vec2 | undefined;
/** A binary descriptor representing the keypoint. */
binaryDescriptor: Uint8Array;
/** The score of this keypoint from the underlying keypoint detector, if applicable. */
score: number;
/** The diameter in pixels of the local neighborhood used to construct the descriptor. */
size: number;
/** The orientation of the keypoint, if applicable. */
angle: number;
}
/** A set of keypoints detected in a single image. */
export interface KeypointSet {
/** A set of detected keypoints and associated metadata. */
keypoints: Keypoint[];
/** The algorithm used to compute this keypoint and its descriptor. */
type: KeypointSet_KeypointType;
}
export declare enum KeypointSet_KeypointType {
KEYPOINT_UNKNOWN = 0,
/**
* KEYPOINT_SIMPLE - Keypoints that consist only of image coordinates. Simple keypoints do not have
* descriptors.
*/
KEYPOINT_SIMPLE = 1,
/**
* KEYPOINT_ORB - Keypoints detected by the ORB feature extraction algorithm (Oriented FAST and Rotated
* BRIEF.)
*/
KEYPOINT_ORB = 2,
UNRECOGNIZED = -1
}
export declare function keypointSet_KeypointTypeFromJSON(object: any): KeypointSet_KeypointType;
export declare function keypointSet_KeypointTypeToJSON(object: KeypointSet_KeypointType): string;
export interface Match {
/** The index in the reference KeypointSet of the keypoint in the matching pair. */
referenceIndex: number;
/** The index in the live KeypointSet of the keypoint in the matching pair. */
liveIndex: number;
/** The distance in descriptor space between the two keypoints. */
distance: number;
}
/** A pair of keypoint sets containing only features in common that have been matched. */
export interface KeypointMatches {
/** The set of common keypoints in a first ("reference") image. */
referenceKeypoints: KeypointSet | undefined;
/** The set of common keypoints in a second ("live") image. */
liveKeypoints: KeypointSet | undefined;
/** Indices of pairs of matches in the two KeypointSets and their distance measure. */
matches: Match[];
}
export declare const Keypoint: {
encode(message: Keypoint, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): Keypoint;
fromJSON(object: any): Keypoint;
toJSON(message: Keypoint): unknown;
fromPartial<I extends {
coordinates?: {
x?: number | undefined;
y?: number | undefined;
} | undefined;
binaryDescriptor?: Uint8Array | undefined;
score?: number | undefined;
size?: number | undefined;
angle?: number | undefined;
} & {
coordinates?: ({
x?: number | undefined;
y?: number | undefined;
} & {
x?: number | undefined;
y?: number | undefined;
} & { [K in Exclude<keyof I["coordinates"], keyof Vec2>]: never; }) | undefined;
binaryDescriptor?: Uint8Array | undefined;
score?: number | undefined;
size?: number | undefined;
angle?: number | undefined;
} & { [K_1 in Exclude<keyof I, keyof Keypoint>]: never; }>(object: I): Keypoint;
};
export declare const KeypointSet: {
encode(message: KeypointSet, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): KeypointSet;
fromJSON(object: any): KeypointSet;
toJSON(message: KeypointSet): unknown;
fromPartial<I extends {
keypoints?: {
coordinates?: {
x?: number | undefined;
y?: number | undefined;
} | undefined;
binaryDescriptor?: Uint8Array | undefined;
score?: number | undefined;
size?: number | undefined;
angle?: number | undefined;
}[] | undefined;
type?: KeypointSet_KeypointType | undefined;
} & {
keypoints?: ({
coordinates?: {
x?: number | undefined;
y?: number | undefined;
} | undefined;
binaryDescriptor?: Uint8Array | undefined;
score?: number | undefined;
size?: number | undefined;
angle?: number | undefined;
}[] & ({
coordinates?: {
x?: number | undefined;
y?: number | undefined;
} | undefined;
binaryDescriptor?: Uint8Array | undefined;
score?: number | undefined;
size?: number | undefined;
angle?: number | undefined;
} & {
coordinates?: ({
x?: number | undefined;
y?: number | undefined;
} & {
x?: number | undefined;
y?: number | undefined;
} & { [K in Exclude<keyof I["keypoints"][number]["coordinates"], keyof Vec2>]: never; }) | undefined;
binaryDescriptor?: Uint8Array | undefined;
score?: number | undefined;
size?: number | undefined;
angle?: number | undefined;
} & { [K_1 in Exclude<keyof I["keypoints"][number], keyof Keypoint>]: never; })[] & { [K_2 in Exclude<keyof I["keypoints"], keyof {
coordinates?: {
x?: number | undefined;
y?: number | undefined;
} | undefined;
binaryDescriptor?: Uint8Array | undefined;
score?: number | undefined;
size?: number | undefined;
angle?: number | undefined;
}[]>]: never; }) | undefined;
type?: KeypointSet_KeypointType | undefined;
} & { [K_3 in Exclude<keyof I, keyof KeypointSet>]: never; }>(object: I): KeypointSet;
};
export declare const Match: {
encode(message: Match, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): Match;
fromJSON(object: any): Match;
toJSON(message: Match): unknown;
fromPartial<I extends {
referenceIndex?: number | undefined;
liveIndex?: number | undefined;
distance?: number | undefined;
} & {
referenceIndex?: number | undefined;
liveIndex?: number | undefined;
distance?: number | undefined;
} & { [K in Exclude<keyof I, keyof Match>]: never; }>(object: I): Match;
};
export declare const KeypointMatches: {
encode(message: KeypointMatches, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): KeypointMatches;
fromJSON(object: any): KeypointMatches;
toJSON(message: KeypointMatches): unknown;
fromPartial<I extends {
referenceKeypoints?: {
keypoints?: {
coordinates?: {
x?: number | undefined;
y?: number | undefined;
} | undefined;
binaryDescriptor?: Uint8Array | undefined;
score?: number | undefined;
size?: number | undefined;
angle?: number | undefined;
}[] | undefined;
type?: KeypointSet_KeypointType | undefined;
} | undefined;
liveKeypoints?: {
keypoints?: {
coordinates?: {
x?: number | undefined;
y?: number | undefined;
} | undefined;
binaryDescriptor?: Uint8Array | undefined;
score?: number | undefined;
size?: number | undefined;
angle?: number | undefined;
}[] | undefined;
type?: KeypointSet_KeypointType | undefined;
} | undefined;
matches?: {
referenceIndex?: number | undefined;
liveIndex?: number | undefined;
distance?: number | undefined;
}[] | undefined;
} & {
referenceKeypoints?: ({
keypoints?: {
coordinates?: {
x?: number | undefined;
y?: number | undefined;
} | undefined;
binaryDescriptor?: Uint8Array | undefined;
score?: number | undefined;
size?: number | undefined;
angle?: number | undefined;
}[] | undefined;
type?: KeypointSet_KeypointType | undefined;
} & {
keypoints?: ({
coordinates?: {
x?: number | undefined;
y?: number | undefined;
} | undefined;
binaryDescriptor?: Uint8Array | undefined;
score?: number | undefined;
size?: number | undefined;
angle?: number | undefined;
}[] & ({
coordinates?: {
x?: number | undefined;
y?: number | undefined;
} | undefined;
binaryDescriptor?: Uint8Array | undefined;
score?: number | undefined;
size?: number | undefined;
angle?: number | undefined;
} & {
coordinates?: ({
x?: number | undefined;
y?: number | undefined;
} & {
x?: number | undefined;
y?: number | undefined;
} & { [K in Exclude<keyof I["referenceKeypoints"]["keypoints"][number]["coordinates"], keyof Vec2>]: never; }) | undefined;
binaryDescriptor?: Uint8Array | undefined;
score?: number | undefined;
size?: number | undefined;
angle?: number | undefined;
} & { [K_1 in Exclude<keyof I["referenceKeypoints"]["keypoints"][number], keyof Keypoint>]: never; })[] & { [K_2 in Exclude<keyof I["referenceKeypoints"]["keypoints"], keyof {
coordinates?: {
x?: number | undefined;
y?: number | undefined;
} | undefined;
binaryDescriptor?: Uint8Array | undefined;
score?: number | undefined;
size?: number | undefined;
angle?: number | undefined;
}[]>]: never; }) | undefined;
type?: KeypointSet_KeypointType | undefined;
} & { [K_3 in Exclude<keyof I["referenceKeypoints"], keyof KeypointSet>]: never; }) | undefined;
liveKeypoints?: ({
keypoints?: {
coordinates?: {
x?: number | undefined;
y?: number | undefined;
} | undefined;
binaryDescriptor?: Uint8Array | undefined;
score?: number | undefined;
size?: number | undefined;
angle?: number | undefined;
}[] | undefined;
type?: KeypointSet_KeypointType | undefined;
} & {
keypoints?: ({
coordinates?: {
x?: number | undefined;
y?: number | undefined;
} | undefined;
binaryDescriptor?: Uint8Array | undefined;
score?: number | undefined;
size?: number | undefined;
angle?: number | undefined;
}[] & ({
coordinates?: {
x?: number | undefined;
y?: number | undefined;
} | undefined;
binaryDescriptor?: Uint8Array | undefined;
score?: number | undefined;
size?: number | undefined;
angle?: number | undefined;
} & {
coordinates?: ({
x?: number | undefined;
y?: number | undefined;
} & {
x?: number | undefined;
y?: number | undefined;
} & { [K_4 in Exclude<keyof I["liveKeypoints"]["keypoints"][number]["coordinates"], keyof Vec2>]: never; }) | undefined;
binaryDescriptor?: Uint8Array | undefined;
score?: number | undefined;
size?: number | undefined;
angle?: number | undefined;
} & { [K_5 in Exclude<keyof I["liveKeypoints"]["keypoints"][number], keyof Keypoint>]: never; })[] & { [K_6 in Exclude<keyof I["liveKeypoints"]["keypoints"], keyof {
coordinates?: {
x?: number | undefined;
y?: number | undefined;
} | undefined;
binaryDescriptor?: Uint8Array | undefined;
score?: number | undefined;
size?: number | undefined;
angle?: number | undefined;
}[]>]: never; }) | undefined;
type?: KeypointSet_KeypointType | undefined;
} & { [K_7 in Exclude<keyof I["liveKeypoints"], keyof KeypointSet>]: never; }) | undefined;
matches?: ({
referenceIndex?: number | undefined;
liveIndex?: number | undefined;
distance?: number | undefined;
}[] & ({
referenceIndex?: number | undefined;
liveIndex?: number | undefined;
distance?: number | undefined;
} & {
referenceIndex?: number | undefined;
liveIndex?: number | undefined;
distance?: number | undefined;
} & { [K_8 in Exclude<keyof I["matches"][number], keyof Match>]: never; })[] & { [K_9 in Exclude<keyof I["matches"], keyof {
referenceIndex?: number | undefined;
liveIndex?: number | undefined;
distance?: number | undefined;
}[]>]: never; }) | undefined;
} & { [K_10 in Exclude<keyof I, keyof KeypointMatches>]: never; }>(object: I): KeypointMatches;
};
declare type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
export declare type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
[K in keyof T]?: DeepPartial<T[K]>;
} : Partial<T>;
declare type KeysOfUnion<T> = T extends T ? keyof T : never;
export declare type Exact<P, I extends P> = P extends Builtin ? P : P & {
[K in keyof P]: Exact<P[K], I[K]>;
} & {
[K in Exclude<keyof I, KeysOfUnion<P>>]: never;
};
export {};
//# sourceMappingURL=sparse_features.d.ts.map