ToFConfig

This message is used to configure the ToF node.

Examples of functionality

Reference

Python

C++

class depthai.ToFConfig
get(self: depthai.ToFConfig) → depthai.RawToFConfig
getData(self: object) → numpy.ndarray[numpy.uint8]
getRaw(self: depthai.ADatatype) → depthai.RawBuffer
getSequenceNum(self: depthai.Buffer) → int
getTimestamp(self: depthai.Buffer) → datetime.timedelta
getTimestampDevice(self: depthai.Buffer) → datetime.timedelta
set(self: depthai.ToFConfig, config: depthai.RawToFConfig) → depthai.ToFConfig
setAvgPhaseShuffle(self: depthai.ToFConfig, arg0: bool) → depthai.ToFConfig
setData(*args, **kwargs)

Overloaded function.

  1. setData(self: depthai.Buffer, arg0: List[int]) -> None

  2. setData(self: depthai.Buffer, arg0: numpy.ndarray[numpy.uint8]) -> None

setDepthParams(self: depthai.ToFConfig, config: depthai.RawToFConfig.DepthParams) → depthai.ToFConfig
setFreqModUsed(self: depthai.ToFConfig, arg0: depthai.RawToFConfig.DepthParams.TypeFMod) → depthai.ToFConfig
setMedianFilter(self: depthai.ToFConfig, arg0: depthai.MedianFilter) → depthai.ToFConfig
setMinAmplitude(self: depthai.ToFConfig, arg0: float) → depthai.ToFConfig
setSequenceNum(self: depthai.Buffer, arg0: int) → depthai.Buffer
setTimestamp(self: depthai.Buffer, arg0: datetime.timedelta) → depthai.Buffer
setTimestampDevice(self: depthai.Buffer, arg0: datetime.timedelta) → depthai.Buffer
class dai::ToFConfig : public dai::Buffer

ToFConfig message. Carries config for feature tracking algorithm

Public Types

using DepthParams = RawToFConfig::DepthParams

Public Functions

ToFConfig()

Construct ToFConfig message.

ToFConfig(std::shared_ptr<RawToFConfig> ptr)
~ToFConfig() = default
ToFConfig &setDepthParams(dai::ToFConfig::DepthParams config)
ToFConfig &setFreqModUsed(dai::ToFConfig::DepthParams::TypeFMod fmod)
ToFConfig &setAvgPhaseShuffle(bool enable)
ToFConfig &setMinAmplitude(float minamp)
ToFConfig &setMedianFilter(MedianFilter median)

Parameters

  • median: Set kernel size for median filtering, or disable

ToFConfig &set(dai::RawToFConfig config)

Set explicit configuration.

Parameters

  • config: Explicit configuration

dai::RawToFConfig get() const

Retrieve configuration data for ToF.

Return

config for feature tracking algorithm

Private Functions

std::shared_ptr<RawBuffer> serialize() const override

Private Members

RawToFConfig &cfg

Got questions?

Head over to Discussion Forum for technical support or any other questions you might have.