SpatialLocationCalculatorConfig

This message is used to configure the SpatialLocationCalculator node.

Examples of functionality

Reference

class depthai.SpatialLocationCalculatorConfig

SpatialLocationCalculatorConfig message. Carries ROI (region of interest) and threshold for depth calculation

addROI(self: depthai.SpatialLocationCalculatorConfig, ROI: depthai.SpatialLocationCalculatorConfigData)None

Add a new ROI to configuration data.

Parameter roi:

Configuration parameters for ROI (region of interest)

get(self: depthai.SpatialLocationCalculatorConfig) → dai::RawSpatialLocationCalculatorConfig

Retrieve configuration data for SpatialLocationCalculator.

Returns

config for SpatialLocationCalculator

getConfigData(self: depthai.SpatialLocationCalculatorConfig) → List[depthai.SpatialLocationCalculatorConfigData]

Retrieve configuration data for SpatialLocationCalculator

Returns

Vector of configuration parameters for ROIs (region of interests)

getData(self: object) → numpy.ndarray[numpy.uint8]

Get non-owning reference to internal buffer

Returns

Reference to internal buffer

getRaw(self: depthai.ADatatype)depthai.RawBuffer
getSequenceNum(self: depthai.Buffer)int

Retrieves sequence number

getTimestamp(self: depthai.Buffer)datetime.timedelta

Retrieves timestamp related to dai::Clock::now()

getTimestampDevice(self: depthai.Buffer)datetime.timedelta

Retrieves timestamp directly captured from device’s monotonic clock, not synchronized to host time. Used mostly for debugging

set(self: depthai.SpatialLocationCalculatorConfig, config: dai::RawSpatialLocationCalculatorConfig)depthai.SpatialLocationCalculatorConfig

Set explicit configuration.

Parameter config:

Explicit configuration

setData(*args, **kwargs)

Overloaded function.

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

Parameter data:

Copies data to internal buffer

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

Parameter data:

Copies data to internal buffer

setROIs(self: depthai.SpatialLocationCalculatorConfig, ROIs: List[depthai.SpatialLocationCalculatorConfigData])None

Set a vector of ROIs as configuration data.

Parameter ROIs:

Vector of configuration parameters for ROIs (region of interests)

setSequenceNum(self: depthai.Buffer, arg0: int)depthai.Buffer

Retrieves sequence number

setTimestamp(self: depthai.Buffer, arg0: datetime.timedelta)depthai.Buffer

Sets timestamp related to dai::Clock::now()

setTimestampDevice(self: depthai.Buffer, arg0: datetime.timedelta)depthai.Buffer

Sets timestamp related to dai::Clock::now()

class dai::SpatialLocationCalculatorConfig : public dai::Buffer

SpatialLocationCalculatorConfig message. Carries ROI (region of interest) and threshold for depth calculation

Public Functions

SpatialLocationCalculatorConfig()

Construct SpatialLocationCalculatorConfig message.

SpatialLocationCalculatorConfig(std::shared_ptr<RawSpatialLocationCalculatorConfig> ptr)
~SpatialLocationCalculatorConfig() = default
void setROIs(std::vector<SpatialLocationCalculatorConfigData> ROIs)

Set a vector of ROIs as configuration data.

Parameters
  • ROIs: Vector of configuration parameters for ROIs (region of interests)

void addROI(SpatialLocationCalculatorConfigData &ROI)

Add a new ROI to configuration data.

Parameters
  • roi: Configuration parameters for ROI (region of interest)

std::vector<SpatialLocationCalculatorConfigData> getConfigData() const

Retrieve configuration data for SpatialLocationCalculator

Return

Vector of configuration parameters for ROIs (region of interests)

SpatialLocationCalculatorConfig &set(dai::RawSpatialLocationCalculatorConfig config)

Set explicit configuration.

Parameters
  • config: Explicit configuration

dai::RawSpatialLocationCalculatorConfig get() const

Retrieve configuration data for SpatialLocationCalculator.

Return

config for SpatialLocationCalculator

Private Functions

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

Got questions?

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