Class cv::VolumeSettings#

Collaboration diagram for cv::VolumeSettings:

Constructor & Destructor Documentation#

VolumeSettings()#

cv::VolumeSettings::VolumeSettings(const VolumeSettings & vs)

Python:

cv.VolumeSettings([, volumeType]) -> <VolumeSettings object>

VolumeSettings()#

cv::VolumeSettings::VolumeSettings(VolumeType volumeType = VolumeType::TSDF)

Python:

cv.VolumeSettings([, volumeType]) -> <VolumeSettings object>

Constructor of settings for custom Volume type.

Parameters

  • volumeType — volume type.

~VolumeSettings()#

cv::VolumeSettings::~VolumeSettings()

Member Function Documentation#

getCameraIntegrateIntrinsics()#

void cv::VolumeSettings::getCameraIntegrateIntrinsics(OutputArray val)

Python:

cv.VolumeSettings.getCameraIntegrateIntrinsics([, val]) -> 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 cv::VolumeSettings::getCameraRaycastIntrinsics(OutputArray val)

Python:

cv.VolumeSettings.getCameraRaycastIntrinsics([, val]) -> 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 cv::VolumeSettings::getDepthFactor()

Python:

cv.VolumeSettings.getDepthFactor() -> retval

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

getIntegrateHeight()#

int cv::VolumeSettings::getIntegrateHeight()

Python:

cv.VolumeSettings.getIntegrateHeight() -> retval

Returns the height of the image for integration.

getIntegrateWidth()#

int cv::VolumeSettings::getIntegrateWidth()

Python:

cv.VolumeSettings.getIntegrateWidth() -> retval

Returns the width of the image for integration.

getMaxDepth()#

float cv::VolumeSettings::getMaxDepth()

Python:

cv.VolumeSettings.getMaxDepth() -> retval

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

getMaxWeight()#

int cv::VolumeSettings::getMaxWeight()

Python:

cv.VolumeSettings.getMaxWeight() -> retval

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.

getRaycastHeight()#

int cv::VolumeSettings::getRaycastHeight()

Python:

cv.VolumeSettings.getRaycastHeight() -> retval

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

getRaycastStepFactor()#

float cv::VolumeSettings::getRaycastStepFactor()

Python:

cv.VolumeSettings.getRaycastStepFactor() -> retval

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

getRaycastWidth()#

int cv::VolumeSettings::getRaycastWidth()

Python:

cv.VolumeSettings.getRaycastWidth() -> retval

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

getTsdfTruncateDistance()#

float cv::VolumeSettings::getTsdfTruncateDistance()

Python:

cv.VolumeSettings.getTsdfTruncateDistance() -> retval

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

getVolumePose()#

void cv::VolumeSettings::getVolumePose(OutputArray val)

Python:

cv.VolumeSettings.getVolumePose([, val]) -> val

Sets volume pose.

Parameters

  • val — output value.

getVolumeResolution()#

void cv::VolumeSettings::getVolumeResolution(OutputArray val)

Python:

cv.VolumeSettings.getVolumeResolution([, val]) -> 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 cv::VolumeSettings::getVolumeStrides(OutputArray val)

Python:

cv.VolumeSettings.getVolumeStrides([, val]) -> 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 cv::VolumeSettings::getVoxelSize()

Python:

cv.VolumeSettings.getVoxelSize() -> retval

Returns the size of voxel.

operator=()#

VolumeSettings & cv::VolumeSettings::operator=(const VolumeSettings &)

setCameraIntegrateIntrinsics()#

void cv::VolumeSettings::setCameraIntegrateIntrinsics(InputArray val)

Python:

cv.VolumeSettings.setCameraIntegrateIntrinsics(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 cv::VolumeSettings::setCameraRaycastIntrinsics(InputArray val)

Python:

cv.VolumeSettings.setCameraRaycastIntrinsics(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 cv::VolumeSettings::setDepthFactor(float val)

Python:

cv.VolumeSettings.setDepthFactor(val)

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

Parameters

  • val — input value.

setIntegrateHeight()#

void cv::VolumeSettings::setIntegrateHeight(int val)

Python:

cv.VolumeSettings.setIntegrateHeight(val)

Sets the height of the image for integration.

Parameters

  • val — input value.

setIntegrateWidth()#

void cv::VolumeSettings::setIntegrateWidth(int val)

Python:

cv.VolumeSettings.setIntegrateWidth(val)

Sets the width of the image for integration.

Parameters

  • val — input value.

setMaxDepth()#

void cv::VolumeSettings::setMaxDepth(float val)

Python:

cv.VolumeSettings.setMaxDepth(val)

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

Parameters

  • val — input value.

setMaxWeight()#

void cv::VolumeSettings::setMaxWeight(int val)

Python:

cv.VolumeSettings.setMaxWeight(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 cv::VolumeSettings::setRaycastHeight(int val)

Python:

cv.VolumeSettings.setRaycastHeight(val)

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

Parameters

  • val — input value.

setRaycastStepFactor()#

void cv::VolumeSettings::setRaycastStepFactor(float val)

Python:

cv.VolumeSettings.setRaycastStepFactor(val)

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

Parameters

  • val — input value.

setRaycastWidth()#

void cv::VolumeSettings::setRaycastWidth(int val)

Python:

cv.VolumeSettings.setRaycastWidth(val)

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

Parameters

  • val — input value.

setTsdfTruncateDistance()#

void cv::VolumeSettings::setTsdfTruncateDistance(float val)

Python:

cv.VolumeSettings.setTsdfTruncateDistance(val)

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

Parameters

  • val — input value.

setVolumePose()#

void cv::VolumeSettings::setVolumePose(InputArray val)

Python:

cv.VolumeSettings.setVolumePose(val)

Sets volume pose.

Parameters

  • val — input value.

setVolumeResolution()#

void cv::VolumeSettings::setVolumeResolution(InputArray val)

Python:

cv.VolumeSettings.setVolumeResolution(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 cv::VolumeSettings::setVoxelSize(float val)

Python:

cv.VolumeSettings.setVoxelSize(val)

Sets the size of voxel.

Parameters

  • val — input value.

Member Data Documentation#

impl#

Ptr< Impl > cv::VolumeSettings::impl

Source file#

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