Skip to content

large_kinfu_VolumeParams

rgbdclassOpenCV 5.0.0
import { large_kinfu_VolumeParams } from '@banou/opencv-wasm'

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

ARGUMENTSConstructor or factory
CLASSlarge_kinfu_VolumeParams
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.

large kinfu volume params value in the OpenCV API.

Constructors and members

static defaultParams

Default set of parameters that provide higher quality reconstruction at the cost of slow performance.

defaultParams(volumeType: number): large_kinfu_VolumeParams | null;
volumeType

volume type argument (number).

Returns

The large_kinfu_VolumeParams | null result.

static coarseParams

Coarse set of parameters that provides relatively higher performance at the cost of reconstrution quality.

coarseParams(volumeType: number): large_kinfu_VolumeParams | null;
volumeType

volume type argument (number).

Returns

The large_kinfu_VolumeParams | null 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.

kind

Kind of Volume

    Values can be TSDF (single volume) or HASHTSDF (hashtable of volume units)
kind: number;

resolutionX

Resolution of voxel space

    Number of voxels in each dimension.
    Applicable only for TSDF Volume.
    HashTSDF volume only supports equal resolution in all three dimensions
resolutionX: number;

resolutionY

Resolution of voxel space

    Number of voxels in each dimension.
    Applicable only for TSDF Volume.
    HashTSDF volume only supports equal resolution in all three dimensions
resolutionY: number;

resolutionZ

Resolution of voxel space

    Number of voxels in each dimension.
    Applicable only for TSDF Volume.
    HashTSDF volume only supports equal resolution in all three dimensions
resolutionZ: number;

unitResolution

Resolution of volumeUnit in voxel space

    Number of voxels in each dimension for volumeUnit
    Applicable only for hashTSDF.
unitResolution: number;

volumSize

Size of volume in meters

volumSize: number;

voxelSize

Length of voxels in meters

voxelSize: number;

tsdfTruncDist

TSDF truncation distance

    Distances greater than value from surface will be truncated to 1.0
tsdfTruncDist: number;

maxWeight

Max number of frames to integrate per voxel

    Represents the max number of frames over which a running average
    of the TSDF is calculated for a voxel
maxWeight: number;

depthTruncThreshold

Threshold for depth truncation in meters

    Truncates the depth greater than threshold to 0
depthTruncThreshold: number;

raycastStepFactor

Length of single raycast step

    Describes the percentage of voxel length that is skipped per march
raycastStepFactor: number;

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.