VolumeSettings
import { VolumeSettings } from '@banou/opencv-wasm'Use after await initOpenCV(). See the initialization and named imports guide.
Native object: release it with using or delete(). Factories can return null; check before calling methods.
volume settings value in the OpenCV API.
Constructors and members
static new
Constructor of settings for custom Volume type.
new(volumeType: VolumeType): VolumeSettings;volumeTypevolume type.
The VolumeSettings 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;The this result.
setIntegrateWidth
Sets the width of the image for integration.
setIntegrateWidth(val: number): void;valinput value.
getIntegrateWidth
Returns the width of the image for integration.
getIntegrateWidth(): number;The number result.
setIntegrateHeight
Sets the height of the image for integration.
setIntegrateHeight(val: number): void;valinput value.
getIntegrateHeight
Returns the height of the image for integration.
getIntegrateHeight(): number;The number result.
setRaycastWidth
Sets the width of the raycasted image, used when user does not provide it at raycast() call.
setRaycastWidth(val: number): void;valinput value.
getRaycastWidth
Returns the width of the raycasted image, used when user does not provide it at raycast() call.
getRaycastWidth(): number;The number result.
setRaycastHeight
Sets the height of the raycasted image, used when user does not provide it at raycast() call.
setRaycastHeight(val: number): void;valinput value.
getRaycastHeight
Returns the height of the raycasted image, used when user does not provide it at raycast() call.
getRaycastHeight(): number;The number result.
setDepthFactor
Sets depth factor, witch is the number for depth scaling.
setDepthFactor(val: number): void;valinput value.
getDepthFactor
Returns depth factor, witch is the number for depth scaling.
getDepthFactor(): number;The number result.
setVoxelSize
Sets the size of voxel.
setVoxelSize(val: number): void;valinput value.
getVoxelSize
Returns the size of voxel.
getVoxelSize(): number;The number result.
setTsdfTruncateDistance
Sets TSDF truncation distance. Distances greater than value from surface will be truncated to 1.0.
setTsdfTruncateDistance(val: number): void;valinput value.
getTsdfTruncateDistance
Returns TSDF truncation distance. Distances greater than value from surface will be truncated to 1.0.
getTsdfTruncateDistance(): number;The number result.
setMaxDepth
Sets threshold for depth truncation in meters. Truncates the depth greater than threshold to 0.
setMaxDepth(val: number): void;valinput value.
getMaxDepth
Returns threshold for depth truncation in meters. Truncates the depth greater than threshold to 0.
getMaxDepth(): number;The number result.
setMaxWeight
Sets 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.
setMaxWeight(val: number): void;valinput value.
getMaxWeight
Returns 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.
getMaxWeight(): number;The number result.
setRaycastStepFactor
Sets length of single raycast step. Describes the percentage of voxel length that is skipped per march.
setRaycastStepFactor(val: number): void;valinput value.
getRaycastStepFactor
Returns length of single raycast step. Describes the percentage of voxel length that is skipped per march.
getRaycastStepFactor(): number;The number result.
setVolumePose
Sets volume pose.
setVolumePose(val: Mat): void;valinput value.
getVolumePose
Sets volume pose.
getVolumePose(val: Mat): void;valOutput destination, filled by the native operation. output value.
setVolumeResolution
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.
setVolumeResolution(val: Mat): void;valinput value.
getVolumeResolution
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.
getVolumeResolution(val: Mat): void;valOutput destination, filled by the native operation. output value.
getVolumeStrides
Returns 3 integers representing strides by x, y and z dimension. Can be used to iterate over raw volume unit data.
getVolumeStrides(val: Mat): void;valOutput destination, filled by the native operation. output value.
setCameraIntegrateIntrinsics
Sets intrinsics of camera for integrations. Format of input: [ fx 0 cx ] [ 0 fy cy ] [ 0 0 1 ] where fx and fy are focus points of Ox and Oy axises, and cx and cy are central points of Ox and Oy axises.
setCameraIntegrateIntrinsics(val: Mat): void;valinput value.
getCameraIntegrateIntrinsics
Returns intrinsics of camera for integrations. Format of output: [ fx 0 cx ] [ 0 fy cy ] [ 0 0 1 ] where fx and fy are focus points of Ox and Oy axises, and cx and cy are central points of Ox and Oy axises.
getCameraIntegrateIntrinsics(val: Mat): void;valOutput destination, filled by the native operation. output value.
setCameraRaycastIntrinsics
Sets camera intrinsics for raycast image which, used when user does not provide them at raycast() call. Format of input: [ fx 0 cx ] [ 0 fy cy ] [ 0 0 1 ] where fx and fy are focus points of Ox and Oy axises, and cx and cy are central points of Ox and Oy axises.
setCameraRaycastIntrinsics(val: Mat): void;valinput value.
getCameraRaycastIntrinsics
Returns camera intrinsics for raycast image, used when user does not provide them at raycast() call. Format of output: [ fx 0 cx ] [ 0 fy cy ] [ 0 0 1 ] where fx and fy are focus points of Ox and Oy axises, and cx and cy are central points of Ox and Oy axises.
getCameraRaycastIntrinsics(val: Mat): void;valOutput destination, filled by the native operation. output value.
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.