@spec getCameraIntegrateIntrinsics(Keyword.t()) :: any() | {:error, String.t()}

@spec getCameraIntegrateIntrinsics(t()) :: Evision.Mat.t() | {:error, String.t()}

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.

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• val: Evision.Mat.t().

  output value.

Python prototype (for reference only):

getCameraIntegrateIntrinsics([, val]) -> val

@spec getCameraIntegrateIntrinsics(t(), [{atom(), term()}, ...] | nil) ::
  Evision.Mat.t() | {:error, String.t()}

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.

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• val: Evision.Mat.t().

  output value.

Python prototype (for reference only):

getCameraIntegrateIntrinsics([, val]) -> val

@spec getCameraRaycastIntrinsics(Keyword.t()) :: any() | {:error, String.t()}

@spec getCameraRaycastIntrinsics(t()) :: Evision.Mat.t() | {:error, String.t()}

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.

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• val: Evision.Mat.t().

  output value.

Python prototype (for reference only):

getCameraRaycastIntrinsics([, val]) -> val

@spec getCameraRaycastIntrinsics(t(), [{atom(), term()}, ...] | nil) ::
  Evision.Mat.t() | {:error, String.t()}

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.

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• val: Evision.Mat.t().

  output value.

Python prototype (for reference only):

getCameraRaycastIntrinsics([, val]) -> val

@spec getDepthFactor(Keyword.t()) :: any() | {:error, String.t()}

@spec getDepthFactor(t()) :: number() | {:error, String.t()}

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

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• retval: float

Python prototype (for reference only):

getDepthFactor() -> retval

@spec getIntegrateHeight(Keyword.t()) :: any() | {:error, String.t()}

@spec getIntegrateHeight(t()) :: integer() | {:error, String.t()}

Returns the height of the image for integration.

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• retval: integer()

Python prototype (for reference only):

getIntegrateHeight() -> retval

@spec getIntegrateWidth(Keyword.t()) :: any() | {:error, String.t()}

@spec getIntegrateWidth(t()) :: integer() | {:error, String.t()}

Returns the width of the image for integration.

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• retval: integer()

Python prototype (for reference only):

getIntegrateWidth() -> retval

@spec getMaxDepth(Keyword.t()) :: any() | {:error, String.t()}

@spec getMaxDepth(t()) :: number() | {:error, String.t()}

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

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• retval: float

Python prototype (for reference only):

getMaxDepth() -> retval

@spec getMaxWeight(Keyword.t()) :: any() | {:error, String.t()}

@spec getMaxWeight(t()) :: integer() | {:error, String.t()}

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.

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• retval: integer()

Python prototype (for reference only):

getMaxWeight() -> retval

@spec getRaycastHeight(Keyword.t()) :: any() | {:error, String.t()}

@spec getRaycastHeight(t()) :: integer() | {:error, String.t()}

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

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• retval: integer()

Python prototype (for reference only):

getRaycastHeight() -> retval

@spec getRaycastStepFactor(Keyword.t()) :: any() | {:error, String.t()}

@spec getRaycastStepFactor(t()) :: number() | {:error, String.t()}

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

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• retval: float

Python prototype (for reference only):

getRaycastStepFactor() -> retval

@spec getRaycastWidth(Keyword.t()) :: any() | {:error, String.t()}

@spec getRaycastWidth(t()) :: integer() | {:error, String.t()}

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

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• retval: integer()

Python prototype (for reference only):

getRaycastWidth() -> retval

@spec getTsdfTruncateDistance(Keyword.t()) :: any() | {:error, String.t()}

@spec getTsdfTruncateDistance(t()) :: number() | {:error, String.t()}

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

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• retval: float

Python prototype (for reference only):

getTsdfTruncateDistance() -> retval

@spec getVolumePose(Keyword.t()) :: any() | {:error, String.t()}

@spec getVolumePose(t()) :: Evision.Mat.t() | {:error, String.t()}

Sets volume pose.

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• val: Evision.Mat.t().

  output value.

Python prototype (for reference only):

getVolumePose([, val]) -> val

@spec getVolumePose(t(), [{atom(), term()}, ...] | nil) ::
  Evision.Mat.t() | {:error, String.t()}

Sets volume pose.

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• val: Evision.Mat.t().

  output value.

Python prototype (for reference only):

getVolumePose([, val]) -> val

@spec getVolumeResolution(Keyword.t()) :: any() | {:error, String.t()}

@spec getVolumeResolution(t()) :: Evision.Mat.t() | {:error, String.t()}

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.

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• val: Evision.Mat.t().

  output value.

Python prototype (for reference only):

getVolumeResolution([, val]) -> val

@spec getVolumeResolution(t(), [{atom(), term()}, ...] | nil) ::
  Evision.Mat.t() | {:error, String.t()}

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.

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• val: Evision.Mat.t().

  output value.

Python prototype (for reference only):

getVolumeResolution([, val]) -> val

@spec getVolumeStrides(Keyword.t()) :: any() | {:error, String.t()}

@spec getVolumeStrides(t()) :: Evision.Mat.t() | {:error, String.t()}

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

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• val: Evision.Mat.t().

  output value.

Python prototype (for reference only):

getVolumeStrides([, val]) -> val

@spec getVolumeStrides(t(), [{atom(), term()}, ...] | nil) ::
  Evision.Mat.t() | {:error, String.t()}

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

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• val: Evision.Mat.t().

  output value.

Python prototype (for reference only):

getVolumeStrides([, val]) -> val

@spec getVoxelSize(Keyword.t()) :: any() | {:error, String.t()}

@spec getVoxelSize(t()) :: number() | {:error, String.t()}

Returns the size of voxel.

Positional Arguments

• self: Evision.VolumeSettings.t()

Return

• retval: float

Python prototype (for reference only):

getVoxelSize() -> retval

@spec setCameraIntegrateIntrinsics(t(), Evision.Mat.maybe_mat_in()) ::
  t() | {:error, String.t()}

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.

Positional Arguments

• self: Evision.VolumeSettings.t()

• val: Evision.Mat.

  input value.

Python prototype (for reference only):

setCameraIntegrateIntrinsics(val) -> None

@spec setCameraRaycastIntrinsics(t(), Evision.Mat.maybe_mat_in()) ::
  t() | {:error, String.t()}

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.

Positional Arguments

• self: Evision.VolumeSettings.t()

• val: Evision.Mat.

  input value.

Python prototype (for reference only):

setCameraRaycastIntrinsics(val) -> None

@spec setDepthFactor(t(), number()) :: t() | {:error, String.t()}

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

Positional Arguments

• self: Evision.VolumeSettings.t()

• val: float.

  input value.

Python prototype (for reference only):

setDepthFactor(val) -> None

@spec setIntegrateHeight(t(), integer()) :: t() | {:error, String.t()}

Sets the height of the image for integration.

Positional Arguments

• self: Evision.VolumeSettings.t()

• val: integer().

  input value.

Python prototype (for reference only):

setIntegrateHeight(val) -> None

@spec setIntegrateWidth(t(), integer()) :: t() | {:error, String.t()}

Sets the width of the image for integration.

Positional Arguments

• self: Evision.VolumeSettings.t()

• val: integer().

  input value.

Python prototype (for reference only):

setIntegrateWidth(val) -> None

@spec setMaxDepth(t(), number()) :: t() | {:error, String.t()}

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

Positional Arguments

• self: Evision.VolumeSettings.t()

• val: float.

  input value.

Python prototype (for reference only):

setMaxDepth(val) -> None

@spec setMaxWeight(t(), integer()) :: t() | {:error, String.t()}

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.

Positional Arguments

• self: Evision.VolumeSettings.t()

• val: integer().

  input value.

Python prototype (for reference only):

setMaxWeight(val) -> None

@spec setRaycastHeight(t(), integer()) :: t() | {:error, String.t()}

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

Positional Arguments

• self: Evision.VolumeSettings.t()

• val: integer().

  input value.

Python prototype (for reference only):

setRaycastHeight(val) -> None

@spec setRaycastStepFactor(t(), number()) :: t() | {:error, String.t()}

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

Positional Arguments

• self: Evision.VolumeSettings.t()

• val: float.

  input value.

Python prototype (for reference only):

setRaycastStepFactor(val) -> None

@spec setRaycastWidth(t(), integer()) :: t() | {:error, String.t()}

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

Positional Arguments

• self: Evision.VolumeSettings.t()

• val: integer().

  input value.

Python prototype (for reference only):

setRaycastWidth(val) -> None

@spec setTsdfTruncateDistance(t(), number()) :: t() | {:error, String.t()}

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

Positional Arguments

• self: Evision.VolumeSettings.t()

• val: float.

  input value.

Python prototype (for reference only):

setTsdfTruncateDistance(val) -> None

@spec setVolumePose(t(), Evision.Mat.maybe_mat_in()) :: t() | {:error, String.t()}

Sets volume pose.

Positional Arguments

• self: Evision.VolumeSettings.t()

• val: Evision.Mat.

  input value.

Python prototype (for reference only):

setVolumePose(val) -> None

@spec setVolumeResolution(t(), Evision.Mat.maybe_mat_in()) ::
  t() | {:error, String.t()}

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.

Positional Arguments

• self: Evision.VolumeSettings.t()

• val: Evision.Mat.

  input value.

Python prototype (for reference only):

setVolumeResolution(val) -> None

@spec setVoxelSize(t(), number()) :: t() | {:error, String.t()}

Sets the size of voxel.

Positional Arguments

• self: Evision.VolumeSettings.t()

• val: float.

  input value.

Python prototype (for reference only):

setVoxelSize(val) -> None

@spec volumeSettings() :: t() | {:error, String.t()}

Constructor of settings for custom Volume type.

Keyword Arguments

• volumeType: VolumeType.

  volume type.

Return

• self: Evision.VolumeSettings.t()

Python prototype (for reference only):

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

@spec volumeSettings(Keyword.t()) :: any() | {:error, String.t()}

@spec volumeSettings([{:volumeType, term()}] | nil) :: t() | {:error, String.t()}

Constructor of settings for custom Volume type.

Keyword Arguments

• volumeType: VolumeType.

  volume type.

Return

• self: Evision.VolumeSettings.t()

Python prototype (for reference only):

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