OpenCVForUnity.PtcloudModule.VolumeSettings Class Reference

Public Member Functions
	VolumeSettings ()
	Constructor of settings for custom Volume type.
	VolumeSettings (int volumeType)
	Constructor of settings for custom Volume type.
void	getCameraIntegrateIntrinsics (Mat val)
	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.
void	getCameraRaycastIntrinsics (Mat val)
	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.
float	getDepthFactor ()
	Returns depth factor, witch is the number for depth scaling.
int	getIntegrateHeight ()
	Returns the height of the image for integration.
int	getIntegrateWidth ()
	Returns the width of the image for integration.
float	getMaxDepth ()
	Returns threshold for depth truncation in meters. Truncates the depth greater than threshold to 0.
int	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.
IntPtr	getNativeObjAddr ()
int	getRaycastHeight ()
	Returns the height of the raycasted image, used when user does not provide it at raycast() call.
float	getRaycastStepFactor ()
	Returns length of single raycast step. Describes the percentage of voxel length that is skipped per march.
int	getRaycastWidth ()
	Returns the width of the raycasted image, used when user does not provide it at raycast() call.
float	getTsdfTruncateDistance ()
	Returns TSDF truncation distance. Distances greater than value from surface will be truncated to 1.0.
void	getVolumePose (Mat val)
	Sets volume pose.
void	getVolumeResolution (Mat val)
	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.
void	getVolumeStrides (Mat val)
	Returns 3 integers representing strides by x, y and z dimension. Can be used to iterate over raw volume unit data.
float	getVoxelSize ()
	Returns the size of voxel.
void	setCameraIntegrateIntrinsics (Mat val)
	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.
void	setCameraRaycastIntrinsics (Mat val)
	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.
void	setDepthFactor (float val)
	Sets depth factor, witch is the number for depth scaling.
void	setIntegrateHeight (int val)
	Sets the height of the image for integration.
void	setIntegrateWidth (int val)
	Sets the width of the image for integration.
void	setMaxDepth (float val)
	Sets threshold for depth truncation in meters. Truncates the depth greater than threshold to 0.
void	setMaxWeight (int val)
	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.
void	setRaycastHeight (int val)
	Sets the height of the raycasted image, used when user does not provide it at raycast() call.
void	setRaycastStepFactor (float val)
	Sets length of single raycast step. Describes the percentage of voxel length that is skipped per march.
void	setRaycastWidth (int val)
	Sets the width of the raycasted image, used when user does not provide it at raycast() call.
void	setTsdfTruncateDistance (float val)
	Sets TSDF truncation distance. Distances greater than value from surface will be truncated to 1.0.
void	setVolumePose (Mat val)
	Sets volume pose.
void	setVolumeResolution (Mat val)
	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.
void	setVoxelSize (float val)
	Sets the size of voxel.
Public Member Functions inherited from OpenCVForUnity.DisposableObject
void	Dispose ()
	Releases resources used by this object.
void	ThrowIfDisposed ()
	Throws ObjectDisposedException if this object has been disposed.

Static Public Member Functions
static VolumeSettings	__fromPtr__ (IntPtr addr)
Static Public Member Functions inherited from OpenCVForUnity.DisposableObject
static IntPtr	ThrowIfNullIntPtr (IntPtr ptr)
	Returns the native pointer, or throws CoreModule.CvException if it is zero.

Protected Member Functions
override void	Dispose (bool disposing)
Protected Member Functions inherited from OpenCVForUnity.DisposableOpenCVObject
	DisposableOpenCVObject ()
	Initializes a new instance with a zero native pointer and dispose enabled.
	DisposableOpenCVObject (bool isEnabledDispose)
	Initializes a new instance with a zero native pointer.
	DisposableOpenCVObject (IntPtr ptr)
	Initializes a new instance with the specified native pointer and dispose enabled.
	DisposableOpenCVObject (IntPtr ptr, bool isEnabledDispose)
	Initializes a new instance with the specified native pointer.
Protected Member Functions inherited from OpenCVForUnity.DisposableObject
	DisposableObject ()
	Initializes a new instance with dispose enabled.
	DisposableObject (bool isEnabledDispose)
	Initializes a new instance.

Additional Inherited Members
Package Attributes inherited from OpenCVForUnity.DisposableOpenCVObject
Properties inherited from OpenCVForUnity.DisposableObject
bool	IsDisposed [get, protected set]
bool	IsEnabledDispose [get, set]

Constructor & Destructor Documentation

VolumeSettings() [1/2]

OpenCVForUnity.PtcloudModule.VolumeSettings.VolumeSettings

(

int

volumeType

)

Constructor of settings for custom Volume type.

Parameters

volumeType

volume type.

VolumeSettings() [2/2]

OpenCVForUnity.PtcloudModule.VolumeSettings.VolumeSettings

(

)

Constructor of settings for custom Volume type.

Parameters

volumeType

volume type.

Member Function Documentation

__fromPtr__()

static VolumeSettings OpenCVForUnity.PtcloudModule.VolumeSettings.__fromPtr__ ( IntPtr addr )

static

Dispose()

override void OpenCVForUnity.PtcloudModule.VolumeSettings.Dispose ( bool disposing )

protectedvirtual

Reimplemented from OpenCVForUnity.DisposableOpenCVObject.

getCameraIntegrateIntrinsics()

void OpenCVForUnity.PtcloudModule.VolumeSettings.getCameraIntegrateIntrinsics

(

Mat

val

)

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.

Parameters

val	output value.

getCameraRaycastIntrinsics()

void OpenCVForUnity.PtcloudModule.VolumeSettings.getCameraRaycastIntrinsics

(

Mat

val

)

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.

Parameters

val	output value.

getDepthFactor()

float OpenCVForUnity.PtcloudModule.VolumeSettings.getDepthFactor

(

)

Returns depth factor, witch is the number for depth scaling.

getIntegrateHeight()

int OpenCVForUnity.PtcloudModule.VolumeSettings.getIntegrateHeight

(

)

Returns the height of the image for integration.

getIntegrateWidth()

int OpenCVForUnity.PtcloudModule.VolumeSettings.getIntegrateWidth

(

)

Returns the width of the image for integration.

getMaxDepth()

float OpenCVForUnity.PtcloudModule.VolumeSettings.getMaxDepth

(

)

Returns threshold for depth truncation in meters. Truncates the depth greater than threshold to 0.

getMaxWeight()

int OpenCVForUnity.PtcloudModule.VolumeSettings.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.

getNativeObjAddr()

IntPtr OpenCVForUnity.PtcloudModule.VolumeSettings.getNativeObjAddr

(

)

getRaycastHeight()

int OpenCVForUnity.PtcloudModule.VolumeSettings.getRaycastHeight

(

)

Returns the height of the raycasted image, used when user does not provide it at raycast() call.

getRaycastStepFactor()

float OpenCVForUnity.PtcloudModule.VolumeSettings.getRaycastStepFactor

(

)

Returns length of single raycast step. Describes the percentage of voxel length that is skipped per march.

getRaycastWidth()

int OpenCVForUnity.PtcloudModule.VolumeSettings.getRaycastWidth

(

)

Returns the width of the raycasted image, used when user does not provide it at raycast() call.

getTsdfTruncateDistance()

float OpenCVForUnity.PtcloudModule.VolumeSettings.getTsdfTruncateDistance

(

)

Returns TSDF truncation distance. Distances greater than value from surface will be truncated to 1.0.

getVolumePose()

void OpenCVForUnity.PtcloudModule.VolumeSettings.getVolumePose

(

Mat

val

)

Sets volume pose.

Parameters

val	output value.

getVolumeResolution()

void OpenCVForUnity.PtcloudModule.VolumeSettings.getVolumeResolution

(

Mat

val

)

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.

Parameters

val	output value.

getVolumeStrides()

void OpenCVForUnity.PtcloudModule.VolumeSettings.getVolumeStrides

(

Mat

val

)

Returns 3 integers representing strides by x, y and z dimension. Can be used to iterate over raw volume unit data.

Parameters

val	output value.

getVoxelSize()

float OpenCVForUnity.PtcloudModule.VolumeSettings.getVoxelSize

(

)

Returns the size of voxel.

setCameraIntegrateIntrinsics()

void OpenCVForUnity.PtcloudModule.VolumeSettings.setCameraIntegrateIntrinsics

(

Mat

val

)

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.

Parameters

val	input value.

setCameraRaycastIntrinsics()

void OpenCVForUnity.PtcloudModule.VolumeSettings.setCameraRaycastIntrinsics

(

Mat

val

)

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.

Parameters

val	input value.

setDepthFactor()

void OpenCVForUnity.PtcloudModule.VolumeSettings.setDepthFactor

(

float

val

)

Sets depth factor, witch is the number for depth scaling.

Parameters

val	input value.

setIntegrateHeight()

void OpenCVForUnity.PtcloudModule.VolumeSettings.setIntegrateHeight

(

int

val

)

Sets the height of the image for integration.

Parameters

val	input value.

setIntegrateWidth()

void OpenCVForUnity.PtcloudModule.VolumeSettings.setIntegrateWidth

(

int

val

)

Sets the width of the image for integration.

Parameters

val	input value.

setMaxDepth()

void OpenCVForUnity.PtcloudModule.VolumeSettings.setMaxDepth

(

float

val

)

Sets threshold for depth truncation in meters. Truncates the depth greater than threshold to 0.

Parameters

val	input value.

setMaxWeight()

void OpenCVForUnity.PtcloudModule.VolumeSettings.setMaxWeight

(

int

val

)

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.

Parameters

val	input value.

setRaycastHeight()

void OpenCVForUnity.PtcloudModule.VolumeSettings.setRaycastHeight

(

int

val

)

Sets the height of the raycasted image, used when user does not provide it at raycast() call.

Parameters

val	input value.

setRaycastStepFactor()

void OpenCVForUnity.PtcloudModule.VolumeSettings.setRaycastStepFactor

(

float

val

)

Sets length of single raycast step. Describes the percentage of voxel length that is skipped per march.

Parameters

val	input value.

setRaycastWidth()

void OpenCVForUnity.PtcloudModule.VolumeSettings.setRaycastWidth

(

int

val

)

Sets the width of the raycasted image, used when user does not provide it at raycast() call.

Parameters

val	input value.

setTsdfTruncateDistance()

void OpenCVForUnity.PtcloudModule.VolumeSettings.setTsdfTruncateDistance

(

float

val

)

Sets TSDF truncation distance. Distances greater than value from surface will be truncated to 1.0.

Parameters

val	input value.

setVolumePose()

void OpenCVForUnity.PtcloudModule.VolumeSettings.setVolumePose

(

Mat

val

)

Sets volume pose.

Parameters

val	input value.

setVolumeResolution()

void OpenCVForUnity.PtcloudModule.VolumeSettings.setVolumeResolution

(

Mat

val

)

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.

Parameters

val	input value.

setVoxelSize()

void OpenCVForUnity.PtcloudModule.VolumeSettings.setVoxelSize

(

float

val

)

Sets the size of voxel.

Parameters

val	input value.

---

The documentation for this class was generated from the following file:

• OpenCVForUnity/Assets/OpenCVForUnity/Scripts/Core/org/opencv/ptcloud/VolumeSettings.cs