Skip to content

OdometrySettings

ptcloudclassOpenCV 5.0.0
import { OdometrySettings } from '@banou/opencv-wasm'

Use after await initOpenCV(). See the initialization and named imports guide.

ARGUMENTSConstructor or factory
CLASSOdometrySettings
RETURN TYPEOwned native handle
Call structure. A void return can still write to destination arguments. The parameter descriptions define inputs, outputs and ownership.

Native object: release it with using or delete(). Factories can return null; check before calling methods.

odometry settings value in the OpenCV API.

Constructors and members

static new

Create an owned OdometrySettings object. Release native handles with using or delete().

new(): OdometrySettings;
Returns

The OdometrySettings result.

clone

Create another handle to the same native object. This retains the object without copying its pixels or algorithm state; dispose both handles separately.

clone(): this;
Returns

The this result.

setCameraMatrix

Set the camera matrix used by this OdometrySettings object.

setCameraMatrix(val: Mat): void;
val

val argument (Mat).

getCameraMatrix

Return the camera matrix configured on this OdometrySettings object.

getCameraMatrix(val: Mat): void;
val

Output destination, filled by the native operation. val argument (Mat).

setIterCounts

Set the iter counts used by this OdometrySettings object.

setIterCounts(val: Mat): void;
val

val argument (Mat).

getIterCounts

Return the iter counts configured on this OdometrySettings object.

getIterCounts(val: Mat): void;
val

Output destination, filled by the native operation. val argument (Mat).

setMinDepth

Set the min depth used by this OdometrySettings object.

setMinDepth(val: number): void;
val

val argument (number).

getMinDepth

Return the min depth configured on this OdometrySettings object.

getMinDepth(): number;
Returns

The number result.

setMaxDepth

Set the max depth used by this OdometrySettings object.

setMaxDepth(val: number): void;
val

val argument (number).

getMaxDepth

Return the max depth configured on this OdometrySettings object.

getMaxDepth(): number;
Returns

The number result.

setMaxDepthDiff

Set the max depth diff used by this OdometrySettings object.

setMaxDepthDiff(val: number): void;
val

val argument (number).

getMaxDepthDiff

Return the max depth diff configured on this OdometrySettings object.

getMaxDepthDiff(): number;
Returns

The number result.

setMaxPointsPart

Set the max points part used by this OdometrySettings object.

setMaxPointsPart(val: number): void;
val

val argument (number).

getMaxPointsPart

Return the max points part configured on this OdometrySettings object.

getMaxPointsPart(): number;
Returns

The number result.

setSobelSize

Set the sobel size used by this OdometrySettings object.

setSobelSize(val: number): void;
val

val argument (number).

getSobelSize

Return the sobel size configured on this OdometrySettings object.

getSobelSize(): number;
Returns

The number result.

setSobelScale

Set the sobel scale used by this OdometrySettings object.

setSobelScale(val: number): void;
val

val argument (number).

getSobelScale

Return the sobel scale configured on this OdometrySettings object.

getSobelScale(): number;
Returns

The number result.

setNormalWinSize

Set the normal win size used by this OdometrySettings object.

setNormalWinSize(val: number): void;
val

val argument (number).

getNormalWinSize

Return the normal win size configured on this OdometrySettings object.

getNormalWinSize(): number;
Returns

The number result.

setNormalDiffThreshold

Set the normal diff threshold used by this OdometrySettings object.

setNormalDiffThreshold(val: number): void;
val

val argument (number).

getNormalDiffThreshold

Return the normal diff threshold configured on this OdometrySettings object.

getNormalDiffThreshold(): number;
Returns

The number result.

setNormalMethod

Set the normal method used by this OdometrySettings object.

setNormalMethod(nm: number): void;
nm

nm argument (number).

getNormalMethod

Return the normal method configured on this OdometrySettings object.

getNormalMethod(): number;
Returns

The number result.

setAngleThreshold

Set the angle threshold used by this OdometrySettings object.

setAngleThreshold(val: number): void;
val

val argument (number).

getAngleThreshold

Return the angle threshold configured on this OdometrySettings object.

getAngleThreshold(): number;
Returns

The number result.

setMaxTranslation

Set the max translation used by this OdometrySettings object.

setMaxTranslation(val: number): void;
val

val argument (number).

getMaxTranslation

Return the max translation configured on this OdometrySettings object.

getMaxTranslation(): number;
Returns

The number result.

setMaxRotation

Set the max rotation used by this OdometrySettings object.

setMaxRotation(val: number): void;
val

val argument (number).

getMaxRotation

Return the max rotation configured on this OdometrySettings object.

getMaxRotation(): number;
Returns

The number result.

setMinGradientMagnitude

Set the min gradient magnitude used by this OdometrySettings object.

setMinGradientMagnitude(val: number): void;
val

val argument (number).

getMinGradientMagnitude

Return the min gradient magnitude configured on this OdometrySettings object.

getMinGradientMagnitude(): number;
Returns

The number result.

setMinGradientMagnitudes

Set the min gradient magnitudes used by this OdometrySettings object.

setMinGradientMagnitudes(val: Mat): void;
val

val argument (Mat).

getMinGradientMagnitudes

Return the min gradient magnitudes configured on this OdometrySettings object.

getMinGradientMagnitudes(val: Mat): void;
val

Output destination, filled by the native operation. val argument (Mat).

These signatures describe this package. Upstream documentation can mention optional backends that are absent from this build. Check runtime compatibility before choosing a backend or file format.