SpatialLocationCalculatorData

This message is an output from the SpatialLocationCalculator node.

Examples of functionality

• Spatial location calculator

Reference

Python

C++

class depthai.SpatialLocationCalculatorData

SpatialLocationCalculatorData message. Carries spatial information (X,Y,Z) and their configuration parameters

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.SpatialLocationCalculatorData) → int

Retrieves image sequence number

getSpatialLocations(self: depthai.SpatialLocationCalculatorData) → List[depthai.SpatialLocations]

Retrieve configuration data for SpatialLocationCalculatorData.

Returns

Vector of spatial location data, carrying spatial information (X,Y,Z)

getTimestamp(self: depthai.SpatialLocationCalculatorData) → datetime.timedelta

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

getTimestampDevice(self: depthai.SpatialLocationCalculatorData) → datetime.timedelta

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

setData(*args, **kwargs)

Overloaded function.

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

Parameter data:

Copies data to internal buffer

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

Parameter data:

Copies data to internal buffer

setSequenceNum(self: depthai.SpatialLocationCalculatorData, arg0: int) → depthai.SpatialLocationCalculatorData

Retrieves image sequence number

setTimestamp(self: depthai.SpatialLocationCalculatorData, arg0: datetime.timedelta) → depthai.SpatialLocationCalculatorData

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

setTimestampDevice(self: depthai.SpatialLocationCalculatorData, arg0: datetime.timedelta) → depthai.SpatialLocationCalculatorData

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

class dai::SpatialLocationCalculatorData : public dai::Buffer

SpatialLocationCalculatorData message. Carries spatial information (X,Y,Z) and their configuration parameters

Public Functions

SpatialLocationCalculatorData()

Construct SpatialLocationCalculatorData message.

SpatialLocationCalculatorData(std::shared_ptr<RawSpatialLocations> ptr)

~SpatialLocationCalculatorData() = default

std::vector<SpatialLocations> &getSpatialLocations() const

Retrieve configuration data for SpatialLocationCalculatorData.

Return

Vector of spatial location data, carrying spatial information (X,Y,Z)

std::chrono::time_point<std::chrono::steady_clock, std::chrono::steady_clock::duration> getTimestamp() const

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

std::chrono::time_point<std::chrono::steady_clock, std::chrono::steady_clock::duration> getTimestampDevice() const

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

int64_t getSequenceNum() const

Retrieves image sequence number

SpatialLocationCalculatorData &setTimestamp(std::chrono::time_point<std::chrono::steady_clock, std::chrono::steady_clock::duration> timestamp)

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

SpatialLocationCalculatorData &setTimestampDevice(std::chrono::time_point<std::chrono::steady_clock, std::chrono::steady_clock::duration> timestamp)

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

SpatialLocationCalculatorData &setSequenceNum(int64_t sequenceNum)

Retrieves image sequence number

Public Members

std::vector<SpatialLocations> &spatialLocations

Private Functions

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

Private Members

RawSpatialLocations &rawdata

Got questions?

We’re always happy to help with code or other questions you might have.

Community Discord

Discussion Forum

Email Support