Python API Reference¶

Classes:

`ADatatype`
`AprilTag`
`AprilTagConfig`
`AprilTagProperties`
`AprilTags`
`Asset`
`AssetManager`
`BoardConfig`
`Buffer`
`CalibrationHandler`
`CameraBoardSocket`	Members:
`CameraControl`
`CameraExposureOffset`	Members:
`CameraFeatures`
`CameraImageOrientation`	Members:
`CameraInfo`
`CameraModel`	Members:
`CameraProperties`
`CameraSensorConfig`
`CameraSensorType`	Members:
`CastProperties`
`ChipTemperature`
`Clock`
`ColorCameraProperties`
`Colormap`	Members:
`CpuUsage`
`CrashDump`
`DataInputQueue`
`DataOutputQueue`
`DatatypeEnum`	Members:
`DetectionNetworkProperties`
`DetectionNetworkType`	Members:
`DetectionParserOptions`
`DetectionParserProperties`
`Device`
`DeviceBase`
`DeviceBootloader`
`DeviceDesc`
`DeviceInfo`
`EdgeDetectorConfig`
`EdgeDetectorConfigData`
`EdgeDetectorProperties`
`EepromData`
`EncodedFrame`
`Extrinsics`
`FeatureTrackerConfig`
`FeatureTrackerProperties`
`FrameEvent`	Members:
`GlobalProperties`
`IMUData`
`IMUPacket`
`IMUProperties`
`IMUReport`
`IMUReportAccelerometer`
`IMUReportGyroscope`
`IMUReportMagneticField`
`IMUReportRotationVectorWAcc`
`IMUSensor`	Members:
`IMUSensorConfig`
`ImageAlignConfig`
`ImageAlignProperties`
`ImageManipConfig`
`ImgDetection`
`ImgDetections`
`ImgFrame`
`Interpolation`	Members:
`LogLevel`	Members:
`LogMessage`
`MedianFilter`	Members:
`MemoryInfo`
`MessageDemuxProperties`
`MessageGroup`
`MonoCameraProperties`
`NNData`
`NeuralNetworkProperties`
`Node`
`ObjectTrackerProperties`
`OpenVINO`
`Pipeline`
`Point2f`
`Point3f`
`PointCloudConfig`
`PointCloudData`
`PointCloudProperties`
`ProcessorType`	Members:
`ProfilingData`
`Properties`
`RawAprilTagConfig`
`RawBuffer`
`RawCameraControl`
`RawEdgeDetectorConfig`
`RawEncodedFrame`
`RawFeatureTrackerConfig`
`RawIMUData`
`RawImageAlignConfig`
`RawImageManipConfig`
`RawImgDetections`
`RawImgFrame`
`RawMessageGroup`
`RawNNData`
`RawPointCloudConfig`
`RawPointCloudData`
`RawSpatialImgDetections`
`RawStereoDepthConfig`
`RawSystemInformation`
`RawToFConfig`
`RawTrackedFeatures`
`RawTracklets`
`Rect`
`RotatedRect`
`SPIInProperties`
`SPIOutProperties`
`ScriptProperties`
`SerializationType`	Members:
`Size2f`
`SpatialDetectionNetworkProperties`
`SpatialImgDetection`
`SpatialImgDetections`
`SpatialLocationCalculatorAlgorithm`	Members:
`SpatialLocationCalculatorConfig`
`SpatialLocationCalculatorConfigData`
`SpatialLocationCalculatorConfigThresholds`
`SpatialLocationCalculatorData`
`SpatialLocationCalculatorProperties`
`SpatialLocations`
`StereoDepthConfig`
`StereoDepthProperties`
`StereoPair`
`StereoRectification`
`SyncProperties`
`SystemInformation`
`SystemLoggerProperties`
`TensorInfo`
`Timestamp`
`ToFConfig`
`ToFProperties`
`TrackedFeature`
`TrackedFeatures`
`TrackerIdAssignmentPolicy`	Members:
`TrackerType`	Members:
`Tracklet`
`Tracklets`
`UVCProperties`
`UsbSpeed`	Members:
`Version`
`VideoEncoderProperties`
`WarpProperties`
`XLinkConnection`
`XLinkDeviceState`	Members:
`XLinkError_t`	Members:
`XLinkInProperties`
`XLinkOutProperties`
`XLinkPlatform`	Members:
`XLinkProtocol`	Members:
`connectionInterface`	Members:

Exceptions:

`EepromError`
`XLinkError`
`XLinkReadError`
`XLinkWriteError`

Functions:

isDatatypeSubclassOf(arg0, arg1)

class depthai.ADatatype¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getRaw`(self)

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getRaw(self: depthai.ADatatype) → depthai.RawBuffer ¶

class depthai.AprilTag¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`bottomLeft`
`bottomRight`
`decisionMargin`
`hamming`
`id`
`topLeft`
`topRight`

__init__(self: depthai.AprilTag) → None ¶

property bottomLeft¶

property bottomRight¶

property decisionMargin¶

property hamming¶

property id¶

property topLeft¶

property topRight¶

class depthai.AprilTagConfig¶

Bases: depthai.Buffer

Classes:

`Family`	Members:
`QuadThresholds`

Methods:

`__init__`(self)
`get`(self)
`set`(self, arg0)
`setFamily`(self, family)

class Family¶

Bases: pybind11_builtins.pybind11_object

Members:

TAG_36H11

TAG_36H10

TAG_25H9

TAG_16H5

TAG_CIR21H7

TAG_STAND41H12

Attributes:

`TAG_16H5`
`TAG_25H9`
`TAG_36H10`
`TAG_36H11`
`TAG_CIR21H7`
`TAG_STAND41H12`
`name`
`value`

Methods:

__init__(self, value)

TAG_16H5 = <Family.TAG_16H5: 3>¶

TAG_25H9 = <Family.TAG_25H9: 2>¶

TAG_36H10 = <Family.TAG_36H10: 1>¶

TAG_36H11 = <Family.TAG_36H11: 0>¶

TAG_CIR21H7 = <Family.TAG_CIR21H7: 4>¶

TAG_STAND41H12 = <Family.TAG_STAND41H12: 5>¶

__init__(self: depthai.RawAprilTagConfig.Family, value: int) → None ¶

property name¶

property value¶

class QuadThresholds¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`criticalDegree`
`deglitch`
`maxLineFitMse`
`maxNmaxima`
`minClusterPixels`
`minWhiteBlackDiff`

__init__(self: depthai.RawAprilTagConfig.QuadThresholds) → None ¶

property criticalDegree¶

property deglitch¶

property maxLineFitMse¶

property maxNmaxima¶

property minClusterPixels¶

property minWhiteBlackDiff¶

__init__(self: depthai.AprilTagConfig) → None ¶

get(self: depthai.AprilTagConfig) → depthai.RawAprilTagConfig ¶

set(self: depthai.AprilTagConfig, arg0: depthai.RawAprilTagConfig) → depthai.AprilTagConfig ¶

setFamily(self: depthai.AprilTagConfig, family: depthai.RawAprilTagConfig.Family) → depthai.AprilTagConfig ¶

class depthai.AprilTagProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`initialConfig`
`inputConfigSync`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property initialConfig¶

property inputConfigSync¶

class depthai.AprilTags¶

Bases: depthai.Buffer

Methods:

`__init__`(self)
`getSequenceNum`(self)
`getTimestamp`(self)
`getTimestampDevice`(self)
`setSequenceNum`(self, arg0)
`setTimestamp`(self, arg0)
`setTimestampDevice`(self, arg0)

Attributes:

aprilTags

__init__(self: depthai.AprilTags) → None ¶

property aprilTags¶

getSequenceNum(self: depthai.AprilTags) → int ¶

getTimestamp(self: depthai.AprilTags) → datetime.timedelta ¶

getTimestampDevice(self: depthai.AprilTags) → datetime.timedelta ¶

setSequenceNum(self: depthai.AprilTags, arg0: int) → depthai.AprilTags ¶

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

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

class depthai.Asset¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Overloaded function.

Attributes:

`alignment`
`data`
`key`

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.Asset) -> None
__init__(self: depthai.Asset, arg0: str) -> None

property alignment¶

property data¶

property key¶

class depthai.AssetManager¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(self)
`addExisting`(self, assets)
`get`(args, *kwargs)	Overloaded function.
`getAll`(args, *kwargs)	Overloaded function.
`remove`(self, key)
`set`(args, *kwargs)	Overloaded function.
`size`(self)

__init__(self: depthai.AssetManager) → None ¶

addExisting(self: depthai.AssetManager, assets: list[depthai.Asset]) → None ¶

get(*args, **kwargs)¶

Overloaded function.

get(self: depthai.AssetManager, key: str) -> depthai.Asset
get(self: depthai.AssetManager, key: str) -> depthai.Asset

getAll(*args, **kwargs)¶

Overloaded function.

getAll(self: depthai.AssetManager) -> list[depthai.Asset]
getAll(self: depthai.AssetManager) -> list[depthai.Asset]

remove(self: depthai.AssetManager, key: str) → None ¶

set(*args, **kwargs)¶

Overloaded function.

set(self: depthai.AssetManager, asset: depthai.Asset) -> depthai.Asset
set(self: depthai.AssetManager, key: str, asset: depthai.Asset) -> depthai.Asset
set(self: depthai.AssetManager, key: str, path: Path, alignment: int = 64) -> depthai.Asset
set(self: depthai.AssetManager, key: str, data: list[int], alignment: int = 64) -> depthai.Asset

size(self: depthai.AssetManager) → int ¶

class depthai.BoardConfig¶

Bases: pybind11_builtins.pybind11_object

Classes:

`GPIO`
`GPIOMap`
`ItemsView`
`KeysView`
`Network`
`UART`
`UARTMap`
`USB`
`UVC`
`ValuesView`

Methods:

__init__(self)

Attributes:

`emmc`
`gpio`
`logDevicePrints`
`logPath`
`logSizeMax`
`logVerbosity`
`mipi4LaneRgb`
`network`
`pcieInternalClock`
`sysctl`
`uart`
`usb`
`usb3PhyInternalClock`
`uvc`
`watchdogInitialDelayMs`
`watchdogTimeoutMs`

class GPIO¶

Bases: pybind11_builtins.pybind11_object

Attributes:

Classes:

`Direction`	Members:
`Drive`	Members:
`Level`	Members:
`Mode`	Members:
`Pull`	Members:

Methods:

__init__(*args, **kwargs)

Overloaded function.

ALT_MODE_0 = <Mode.ALT_MODE_0: 0>¶

ALT_MODE_1 = <Mode.ALT_MODE_1: 1>¶

ALT_MODE_2 = <Mode.ALT_MODE_2: 2>¶

ALT_MODE_3 = <Mode.ALT_MODE_3: 3>¶

ALT_MODE_4 = <Mode.ALT_MODE_4: 4>¶

ALT_MODE_5 = <Mode.ALT_MODE_5: 5>¶

ALT_MODE_6 = <Mode.ALT_MODE_6: 6>¶

BUS_KEEPER = <Pull.BUS_KEEPER: 3>¶

DIRECT = <Mode.DIRECT: 7>¶

class Direction¶

Bases: pybind11_builtins.pybind11_object

Members:

INPUT

OUTPUT

Attributes:

`INPUT`
`OUTPUT`
`name`
`value`

Methods:

__init__(self, value)

INPUT = <Direction.INPUT: 0>¶

OUTPUT = <Direction.OUTPUT: 1>¶

__init__(self: depthai.BoardConfig.GPIO.Direction, value: int) → None ¶

property name¶

property value¶

class Drive¶

Bases: pybind11_builtins.pybind11_object

Members:

MA_2

MA_4

MA_8

MA_12

Attributes:

`MA_12`
`MA_2`
`MA_4`
`MA_8`
`name`
`value`

Methods:

__init__(self, value)

MA_12 = <Drive.MA_12: 12>¶

MA_2 = <Drive.MA_2: 2>¶

MA_4 = <Drive.MA_4: 4>¶

MA_8 = <Drive.MA_8: 8>¶

__init__(self: depthai.BoardConfig.GPIO.Drive, value: int) → None ¶

property name¶

property value¶

HIGH = <Level.HIGH: 1>¶

INPUT = <Direction.INPUT: 0>¶

LOW = <Level.LOW: 0>¶

class Level¶

Bases: pybind11_builtins.pybind11_object

Members:

LOW

HIGH

Attributes:

`HIGH`
`LOW`
`name`
`value`

Methods:

__init__(self, value)

HIGH = <Level.HIGH: 1>¶

LOW = <Level.LOW: 0>¶

__init__(self: depthai.BoardConfig.GPIO.Level, value: int) → None ¶

property name¶

property value¶

MA_12 = <Drive.MA_12: 12>¶

MA_2 = <Drive.MA_2: 2>¶

MA_4 = <Drive.MA_4: 4>¶

MA_8 = <Drive.MA_8: 8>¶

class Mode¶

Bases: pybind11_builtins.pybind11_object

Members:

ALT_MODE_0

ALT_MODE_1

ALT_MODE_2

ALT_MODE_3

ALT_MODE_4

ALT_MODE_5

ALT_MODE_6

DIRECT

Attributes:

`ALT_MODE_0`
`ALT_MODE_1`
`ALT_MODE_2`
`ALT_MODE_3`
`ALT_MODE_4`
`ALT_MODE_5`
`ALT_MODE_6`
`DIRECT`
`name`
`value`

Methods:

__init__(self, value)

ALT_MODE_0 = <Mode.ALT_MODE_0: 0>¶

ALT_MODE_1 = <Mode.ALT_MODE_1: 1>¶

ALT_MODE_2 = <Mode.ALT_MODE_2: 2>¶

ALT_MODE_3 = <Mode.ALT_MODE_3: 3>¶

ALT_MODE_4 = <Mode.ALT_MODE_4: 4>¶

ALT_MODE_5 = <Mode.ALT_MODE_5: 5>¶

ALT_MODE_6 = <Mode.ALT_MODE_6: 6>¶

DIRECT = <Mode.DIRECT: 7>¶

__init__(self: depthai.BoardConfig.GPIO.Mode, value: int) → None ¶

property name¶

property value¶

NO_PULL = <Pull.NO_PULL: 0>¶

OUTPUT = <Direction.OUTPUT: 1>¶

PULL_DOWN = <Pull.PULL_DOWN: 2>¶

PULL_UP = <Pull.PULL_UP: 1>¶

class Pull¶

Bases: pybind11_builtins.pybind11_object

Members:

NO_PULL

PULL_UP

PULL_DOWN

BUS_KEEPER

Attributes:

`BUS_KEEPER`
`NO_PULL`
`PULL_DOWN`
`PULL_UP`
`name`
`value`

Methods:

__init__(self, value)

BUS_KEEPER = <Pull.BUS_KEEPER: 3>¶

NO_PULL = <Pull.NO_PULL: 0>¶

PULL_DOWN = <Pull.PULL_DOWN: 2>¶

PULL_UP = <Pull.PULL_UP: 1>¶

__init__(self: depthai.BoardConfig.GPIO.Pull, value: int) → None ¶

property name¶

property value¶

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.BoardConfig.GPIO) -> None
__init__(self: depthai.BoardConfig.GPIO, arg0: depthai.BoardConfig.GPIO.Direction) -> None
__init__(self: depthai.BoardConfig.GPIO, arg0: depthai.BoardConfig.GPIO.Direction, arg1: depthai.BoardConfig.GPIO.Level) -> None
__init__(self: depthai.BoardConfig.GPIO, arg0: depthai.BoardConfig.GPIO.Direction, arg1: depthai.BoardConfig.GPIO.Level, arg2: depthai.BoardConfig.GPIO.Pull) -> None
__init__(self: depthai.BoardConfig.GPIO, arg0: depthai.BoardConfig.GPIO.Direction, arg1: depthai.BoardConfig.GPIO.Mode) -> None
__init__(self: depthai.BoardConfig.GPIO, arg0: depthai.BoardConfig.GPIO.Direction, arg1: depthai.BoardConfig.GPIO.Mode, arg2: depthai.BoardConfig.GPIO.Pull) -> None

property direction¶

property drive¶

property level¶

property mode¶

property pull¶

property schmitt¶

property slewFast¶

class GPIOMap¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(self)
`items`(self)
`keys`(self)
`values`(self)

__init__(self: depthai.BoardConfig.GPIOMap) → None ¶

items(self: depthai.BoardConfig.GPIOMap) → depthai.BoardConfig.ItemsView ¶

keys(self: depthai.BoardConfig.GPIOMap) → depthai.BoardConfig.KeysView ¶

values(self: depthai.BoardConfig.GPIOMap) → depthai.BoardConfig.ValuesView ¶

class ItemsView¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

class KeysView¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

class Network¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`mtu`
`xlinkTcpNoDelay`

__init__(self: depthai.BoardConfig.Network) → None ¶

property mtu¶

property xlinkTcpNoDelay¶

class UART¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

tmp

__init__(self: depthai.BoardConfig.UART) → None ¶

property tmp¶

class UARTMap¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(self)
`items`(self)
`keys`(self)
`values`(self)

__init__(self: depthai.BoardConfig.UARTMap) → None ¶

items(self: depthai.BoardConfig.UARTMap) → depthai.BoardConfig.ItemsView ¶

keys(self: depthai.BoardConfig.UARTMap) → depthai.BoardConfig.KeysView ¶

values(self: depthai.BoardConfig.UARTMap) → depthai.BoardConfig.ValuesView ¶

class USB¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`flashBootedPid`
`flashBootedVid`
`manufacturer`
`maxSpeed`
`pid`
`productName`
`vid`

__init__(self: depthai.BoardConfig.USB) → None ¶

property flashBootedPid¶

property flashBootedVid¶

property manufacturer¶

property maxSpeed¶

property pid¶

property productName¶

property vid¶

class UVC¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Overloaded function.

Attributes:

`cameraName`
`enable`
`frameType`
`height`
`width`

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.BoardConfig.UVC) -> None
__init__(self: depthai.BoardConfig.UVC, arg0: int, arg1: int) -> None

property cameraName¶

property enable¶

property frameType¶

property height¶

property width¶

class ValuesView¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

__init__(self: depthai.BoardConfig) → None ¶

property emmc¶

property gpio¶

property logDevicePrints¶

property logPath¶

property logSizeMax¶

property logVerbosity¶

property mipi4LaneRgb¶

property network¶

property pcieInternalClock¶

property sysctl¶

property uart¶

property usb¶

property usb3PhyInternalClock¶

property uvc¶

property watchdogInitialDelayMs¶

property watchdogTimeoutMs¶

class depthai.Buffer¶

Bases: depthai.ADatatype

Methods:

`__init__`(self)
`getData`(self)
`getSequenceNum`(self)
`getTimestamp`(self)
`getTimestampDevice`(self)
`setData`(args, *kwargs)	Overloaded function.
`setSequenceNum`(self, arg0)
`setTimestamp`(self, arg0)
`setTimestampDevice`(self, arg0)

__init__(self: depthai.Buffer) → None ¶

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

getSequenceNum(self: depthai.Buffer) → int ¶

getTimestamp(self: depthai.Buffer) → datetime.timedelta ¶

getTimestampDevice(self: depthai.Buffer) → datetime.timedelta ¶

setData(*args, **kwargs)¶

Overloaded function.

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

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 depthai.CalibrationHandler¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(args, *kwargs)	Overloaded function.
`eepromToJson`(self)
`eepromToJsonFile`(self, destPath)
`fromJson`(arg0)
`getBaselineDistance`(self, cam1, cam2, …)
`getCameraExtrinsics`(self, srcCamera, …)
`getCameraIntrinsics`(args, *kwargs)	Overloaded function.
`getCameraToImuExtrinsics`(self, cameraId, …)
`getCameraTranslationVector`(self, srcCamera, …)
`getDefaultIntrinsics`(self, cameraId)
`getDistortionCoefficients`(self, cameraId)
`getDistortionModel`(self, cameraId)
`getEepromData`(self)
`getFov`(self, cameraId, useSpec)
`getImuToCameraExtrinsics`(self, cameraId, …)
`getLensPosition`(self, cameraId)
`getStereoLeftCameraId`(self)
`getStereoLeftRectificationRotation`(self)
`getStereoRightCameraId`(self)
`getStereoRightRectificationRotation`(self)
`setBoardInfo`(args, *kwargs)	Overloaded function.
`setCameraExtrinsics`(self, srcCameraId, …)
`setCameraIntrinsics`(args, *kwargs)	Overloaded function.
`setCameraType`(self, cameraId, cameraModel)
`setDeviceName`(self, deviceName)
`setDistortionCoefficients`(self, cameraId, …)
`setFov`(self, cameraId, hfov)
`setImuExtrinsics`(self, destCameraId, …)
`setLensPosition`(self, cameraId, lensPosition)
`setProductName`(self, productName)
`setStereoLeft`(self, cameraId, rectifiedRotation)
`setStereoRight`(self, cameraId, rectifiedRotation)

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.CalibrationHandler) -> None
__init__(self: depthai.CalibrationHandler, arg0: Path) -> None
__init__(self: depthai.CalibrationHandler, arg0: Path, arg1: Path) -> None
__init__(self: depthai.CalibrationHandler, arg0: depthai.EepromData) -> None

eepromToJson(self: depthai.CalibrationHandler) → json¶

eepromToJsonFile(self: depthai.CalibrationHandler, destPath: Path) → bool ¶

static fromJson(arg0: json) → depthai.CalibrationHandler ¶

getBaselineDistance(self: depthai.CalibrationHandler, cam1: depthai.CameraBoardSocket = <CameraBoardSocket.???: 2>, cam2: depthai.CameraBoardSocket = <CameraBoardSocket.???: 1>, useSpecTranslation: bool = True) → float ¶

getCameraExtrinsics(self: depthai.CalibrationHandler, srcCamera: depthai.CameraBoardSocket, dstCamera: depthai.CameraBoardSocket, useSpecTranslation: bool = False) → list[list[float]]¶

getCameraIntrinsics(*args, **kwargs)¶

Overloaded function.

getCameraIntrinsics(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, resizeWidth: int = -1, resizeHeight: int = -1, topLeftPixelId: depthai.Point2f = <depthai.Point2f object at 0x7f56c0239170>, bottomRightPixelId: depthai.Point2f = <depthai.Point2f object at 0x7f56c023a4f0>, keepAspectRatio: bool = True) -> list[list[float]]
getCameraIntrinsics(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, destShape: depthai.Size2f, topLeftPixelId: depthai.Point2f = <depthai.Point2f object at 0x7f56c0237e30>, bottomRightPixelId: depthai.Point2f = <depthai.Point2f object at 0x7f56c02393f0>, keepAspectRatio: bool = True) -> list[list[float]]
getCameraIntrinsics(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, destShape: tuple[int, int], topLeftPixelId: depthai.Point2f = <depthai.Point2f object at 0x7f56c02370b0>, bottomRightPixelId: depthai.Point2f = <depthai.Point2f object at 0x7f56c0237df0>, keepAspectRatio: bool = True) -> list[list[float]]

getCameraToImuExtrinsics(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, useSpecTranslation: bool = False) → list[list[float]]¶

getCameraTranslationVector(self: depthai.CalibrationHandler, srcCamera: depthai.CameraBoardSocket, dstCamera: depthai.CameraBoardSocket, useSpecTranslation: bool = True) → list[float]¶

getDefaultIntrinsics(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket) → tuple[list[list[float]], int, int]¶

getDistortionCoefficients(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket) → list[float]¶

getDistortionModel(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket) → depthai.CameraModel ¶

getEepromData(self: depthai.CalibrationHandler) → depthai.EepromData ¶

getFov(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, useSpec: bool = True) → float ¶

getImuToCameraExtrinsics(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, useSpecTranslation: bool = False) → list[list[float]]¶

getLensPosition(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket) → int ¶

getStereoLeftCameraId(self: depthai.CalibrationHandler) → depthai.CameraBoardSocket ¶

getStereoLeftRectificationRotation(self: depthai.CalibrationHandler) → list[list[float]]¶

getStereoRightCameraId(self: depthai.CalibrationHandler) → depthai.CameraBoardSocket ¶

getStereoRightRectificationRotation(self: depthai.CalibrationHandler) → list[list[float]]¶

setBoardInfo(*args, **kwargs)¶

Overloaded function.

setBoardInfo(self: depthai.CalibrationHandler, boardName: str, boardRev: str) -> None
setBoardInfo(self: depthai.CalibrationHandler, productName: str, boardName: str, boardRev: str, boardConf: str, hardwareConf: str, batchName: str, batchTime: int, boardOptions: int, boardCustom: str = ‘’) -> None
setBoardInfo(self: depthai.CalibrationHandler, deviceName: str, productName: str, boardName: str, boardRev: str, boardConf: str, hardwareConf: str, batchName: str, batchTime: int, boardOptions: int, boardCustom: str = ‘’) -> None

setCameraExtrinsics(self: depthai.CalibrationHandler, srcCameraId: depthai.CameraBoardSocket, destCameraId: depthai.CameraBoardSocket, rotationMatrix: list[list[float]], translation: list[float], specTranslation: list[float] = [0.0, 0.0, 0.0]) → None ¶

setCameraIntrinsics(*args, **kwargs)¶

Overloaded function.

setCameraIntrinsics(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, intrinsics: list[list[float]], frameSize: depthai.Size2f) -> None
setCameraIntrinsics(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, intrinsics: list[list[float]], width: int, height: int) -> None
setCameraIntrinsics(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, intrinsics: list[list[float]], frameSize: tuple[int, int]) -> None

setCameraType(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, cameraModel: depthai.CameraModel) → None ¶

setDeviceName(self: depthai.CalibrationHandler, deviceName: str) → None ¶

setDistortionCoefficients(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, distortionCoefficients: list[float]) → None ¶

setFov(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, hfov: float) → None ¶

setImuExtrinsics(self: depthai.CalibrationHandler, destCameraId: depthai.CameraBoardSocket, rotationMatrix: list[list[float]], translation: list[float], specTranslation: list[float] = [0.0, 0.0, 0.0]) → None ¶

setLensPosition(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, lensPosition: int) → None ¶

setProductName(self: depthai.CalibrationHandler, productName: str) → None ¶

setStereoLeft(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, rectifiedRotation: list[list[float]]) → None ¶

setStereoRight(self: depthai.CalibrationHandler, cameraId: depthai.CameraBoardSocket, rectifiedRotation: list[list[float]]) → None ¶

class depthai.CameraBoardSocket¶

Bases: pybind11_builtins.pybind11_object

Members:

AUTO

CAM_A

CAM_B

CAM_C

CAM_D

CAM_E

CAM_F

CAM_G

CAM_H

RGB : Deprecated: Use CAM_A or address camera by name instead

LEFT : Deprecated: Use CAM_B or address camera by name instead

RIGHT : Deprecated: Use CAM_C or address camera by name instead

CENTER : Deprecated: Use CAM_A or address camera by name instead

Attributes:

`AUTO`
`CAM_A`
`CAM_B`
`CAM_C`
`CAM_D`
`CAM_E`
`CAM_F`
`CAM_G`
`CAM_H`
`CENTER`
`LEFT`
`RGB`
`RIGHT`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <CameraBoardSocket.AUTO: -1>¶

CAM_A = <CameraBoardSocket.CAM_A: 0>¶

CAM_B = <CameraBoardSocket.CAM_B: 1>¶

CAM_C = <CameraBoardSocket.CAM_C: 2>¶

CAM_D = <CameraBoardSocket.CAM_D: 3>¶

CAM_E = <CameraBoardSocket.CAM_E: 4>¶

CAM_F = <CameraBoardSocket.CAM_F: 5>¶

CAM_G = <CameraBoardSocket.CAM_G: 6>¶

CAM_H = <CameraBoardSocket.CAM_H: 7>¶

CENTER = <CameraBoardSocket.CAM_A: 0>¶

LEFT = <CameraBoardSocket.CAM_B: 1>¶

RGB = <CameraBoardSocket.CAM_A: 0>¶

RIGHT = <CameraBoardSocket.CAM_C: 2>¶

__init__(self: depthai.CameraBoardSocket, value: int) → None ¶

property name¶

property value¶

class depthai.CameraControl¶

Bases: depthai.Buffer

Classes:

`AntiBandingMode`	Members:
`AutoFocusMode`	Members:
`AutoWhiteBalanceMode`	Members:
`CaptureIntent`	Members:
`Command`	Members:
`ControlMode`	Members:
`EffectMode`	Members:
`FrameSyncMode`	Members:
`SceneMode`	Members:

Methods:

`__init__`(self)
`get`(self)
`getCaptureStill`(self)
`getExposureTime`(self)
`getLensPosition`(self)
`getLensPositionRaw`(self)
`getSensitivity`(self)
`set`(self, config)
`setAntiBandingMode`(self, mode)
`setAutoExposureCompensation`(self, compensation)
`setAutoExposureEnable`(self)
`setAutoExposureLimit`(args, *kwargs)	Overloaded function.
`setAutoExposureLock`(self, lock)
`setAutoExposureRegion`(self, startX, startY, …)
`setAutoFocusLensRange`(self, …)
`setAutoFocusMode`(self, mode)
`setAutoFocusRegion`(self, startX, startY, …)
`setAutoFocusTrigger`(self)
`setAutoWhiteBalanceLock`(self, lock)
`setAutoWhiteBalanceMode`(self, mode)
`setBrightness`(self, value)
`setCaptureIntent`(self, mode)
`setCaptureStill`(self, capture)
`setChromaDenoise`(self, value)
`setContrast`(self, value)
`setControlMode`(self, mode)
`setEffectMode`(self, mode)
`setExternalTrigger`(self, numFramesBurst, …)
`setFrameSyncMode`(self, mode)
`setLumaDenoise`(self, value)
`setManualExposure`(args, *kwargs)	Overloaded function.
`setManualFocus`(self, lensPosition)
`setManualFocusRaw`(self, lensPositionRaw)
`setManualWhiteBalance`(self, colorTemperatureK)
`setSaturation`(self, value)
`setSceneMode`(self, mode)
`setSharpness`(self, value)
`setStartStreaming`(self)
`setStopStreaming`(self)
`setStrobeDisable`(self)
`setStrobeExternal`(self, gpioNumber, activeLevel)
`setStrobeSensor`(self, activeLevel)

class AntiBandingMode¶

Bases: pybind11_builtins.pybind11_object

Members:

OFF

MAINS_50_HZ

MAINS_60_HZ

AUTO

Attributes:

`AUTO`
`MAINS_50_HZ`
`MAINS_60_HZ`
`OFF`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <AntiBandingMode.AUTO: 3>¶

MAINS_50_HZ = <AntiBandingMode.MAINS_50_HZ: 1>¶

MAINS_60_HZ = <AntiBandingMode.MAINS_60_HZ: 2>¶

OFF = <AntiBandingMode.OFF: 0>¶

__init__(self: depthai.RawCameraControl.AntiBandingMode, value: int) → None ¶

property name¶

property value¶

class AutoFocusMode¶

Bases: pybind11_builtins.pybind11_object

Members:

OFF

AUTO

MACRO

CONTINUOUS_VIDEO

CONTINUOUS_PICTURE

EDOF

Attributes:

`AUTO`
`CONTINUOUS_PICTURE`
`CONTINUOUS_VIDEO`
`EDOF`
`MACRO`
`OFF`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <AutoFocusMode.AUTO: 1>¶

CONTINUOUS_PICTURE = <AutoFocusMode.CONTINUOUS_PICTURE: 4>¶

CONTINUOUS_VIDEO = <AutoFocusMode.CONTINUOUS_VIDEO: 3>¶

EDOF = <AutoFocusMode.EDOF: 5>¶

MACRO = <AutoFocusMode.MACRO: 2>¶

OFF = <AutoFocusMode.OFF: 0>¶

__init__(self: depthai.RawCameraControl.AutoFocusMode, value: int) → None ¶

property name¶

property value¶

class AutoWhiteBalanceMode¶

Bases: pybind11_builtins.pybind11_object

Members:

OFF

AUTO

INCANDESCENT

FLUORESCENT

WARM_FLUORESCENT

DAYLIGHT

CLOUDY_DAYLIGHT

TWILIGHT

SHADE

Attributes:

`AUTO`
`CLOUDY_DAYLIGHT`
`DAYLIGHT`
`FLUORESCENT`
`INCANDESCENT`
`OFF`
`SHADE`
`TWILIGHT`
`WARM_FLUORESCENT`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <AutoWhiteBalanceMode.AUTO: 1>¶

CLOUDY_DAYLIGHT = <AutoWhiteBalanceMode.CLOUDY_DAYLIGHT: 6>¶

DAYLIGHT = <AutoWhiteBalanceMode.DAYLIGHT: 5>¶

FLUORESCENT = <AutoWhiteBalanceMode.FLUORESCENT: 3>¶

INCANDESCENT = <AutoWhiteBalanceMode.INCANDESCENT: 2>¶

OFF = <AutoWhiteBalanceMode.OFF: 0>¶

SHADE = <AutoWhiteBalanceMode.SHADE: 8>¶

TWILIGHT = <AutoWhiteBalanceMode.TWILIGHT: 7>¶

WARM_FLUORESCENT = <AutoWhiteBalanceMode.WARM_FLUORESCENT: 4>¶

__init__(self: depthai.RawCameraControl.AutoWhiteBalanceMode, value: int) → None ¶

property name¶

property value¶

class CaptureIntent¶

Bases: pybind11_builtins.pybind11_object

Members:

CUSTOM

PREVIEW

STILL_CAPTURE

VIDEO_RECORD

VIDEO_SNAPSHOT

ZERO_SHUTTER_LAG

Attributes:

`CUSTOM`
`PREVIEW`
`STILL_CAPTURE`
`VIDEO_RECORD`
`VIDEO_SNAPSHOT`
`ZERO_SHUTTER_LAG`
`name`
`value`

Methods:

__init__(self, value)

CUSTOM = <CaptureIntent.CUSTOM: 0>¶

PREVIEW = <CaptureIntent.PREVIEW: 1>¶

STILL_CAPTURE = <CaptureIntent.STILL_CAPTURE: 2>¶

VIDEO_RECORD = <CaptureIntent.VIDEO_RECORD: 3>¶

VIDEO_SNAPSHOT = <CaptureIntent.VIDEO_SNAPSHOT: 4>¶

ZERO_SHUTTER_LAG = <CaptureIntent.ZERO_SHUTTER_LAG: 5>¶

__init__(self: depthai.RawCameraControl.CaptureIntent, value: int) → None ¶

property name¶

property value¶

class Command¶

Bases: pybind11_builtins.pybind11_object

Members:

START_STREAM

STOP_STREAM

STILL_CAPTURE

MOVE_LENS

AF_TRIGGER

AE_MANUAL

AE_AUTO

AWB_MODE

SCENE_MODE

ANTIBANDING_MODE

EXPOSURE_COMPENSATION

AE_LOCK

AE_TARGET_FPS_RANGE

AWB_LOCK

CAPTURE_INTENT

CONTROL_MODE

FRAME_DURATION

SENSITIVITY

EFFECT_MODE

AF_MODE

NOISE_REDUCTION_STRENGTH

SATURATION

BRIGHTNESS

STREAM_FORMAT

RESOLUTION

SHARPNESS

CUSTOM_USECASE

CUSTOM_CAPT_MODE

CUSTOM_EXP_BRACKETS

CUSTOM_CAPTURE

CONTRAST

AE_REGION

AF_REGION

LUMA_DENOISE

CHROMA_DENOISE

WB_COLOR_TEMP

Attributes:

Methods:

__init__(self, value)

AE_AUTO = <Command.AE_AUTO: 7>¶

AE_LOCK = <Command.AE_LOCK: 13>¶

AE_MANUAL = <Command.AE_MANUAL: 6>¶

AE_REGION = <Command.AE_REGION: 45>¶

AE_TARGET_FPS_RANGE = <Command.AE_TARGET_FPS_RANGE: 14>¶

AF_MODE = <Command.AF_MODE: 26>¶

AF_REGION = <Command.AF_REGION: 46>¶

AF_TRIGGER = <Command.AF_TRIGGER: 5>¶

ANTIBANDING_MODE = <Command.ANTIBANDING_MODE: 10>¶

AWB_LOCK = <Command.AWB_LOCK: 16>¶

AWB_MODE = <Command.AWB_MODE: 8>¶

BRIGHTNESS = <Command.BRIGHTNESS: 31>¶

CAPTURE_INTENT = <Command.CAPTURE_INTENT: 17>¶

CHROMA_DENOISE = <Command.CHROMA_DENOISE: 48>¶

CONTRAST = <Command.CONTRAST: 44>¶

CONTROL_MODE = <Command.CONTROL_MODE: 18>¶

CUSTOM_CAPTURE = <Command.CUSTOM_CAPTURE: 43>¶

CUSTOM_CAPT_MODE = <Command.CUSTOM_CAPT_MODE: 41>¶

CUSTOM_EXP_BRACKETS = <Command.CUSTOM_EXP_BRACKETS: 42>¶

CUSTOM_USECASE = <Command.CUSTOM_USECASE: 40>¶

EFFECT_MODE = <Command.EFFECT_MODE: 24>¶

EXPOSURE_COMPENSATION = <Command.EXPOSURE_COMPENSATION: 11>¶

FRAME_DURATION = <Command.FRAME_DURATION: 21>¶

LUMA_DENOISE = <Command.LUMA_DENOISE: 47>¶

MOVE_LENS = <Command.MOVE_LENS: 4>¶

NOISE_REDUCTION_STRENGTH = <Command.NOISE_REDUCTION_STRENGTH: 27>¶

RESOLUTION = <Command.RESOLUTION: 34>¶

SATURATION = <Command.SATURATION: 28>¶

SCENE_MODE = <Command.SCENE_MODE: 9>¶

SENSITIVITY = <Command.SENSITIVITY: 23>¶

SHARPNESS = <Command.SHARPNESS: 35>¶

START_STREAM = <Command.START_STREAM: 1>¶

STILL_CAPTURE = <Command.STILL_CAPTURE: 3>¶

STOP_STREAM = <Command.STOP_STREAM: 2>¶

STREAM_FORMAT = <Command.STREAM_FORMAT: 33>¶

WB_COLOR_TEMP = <Command.WB_COLOR_TEMP: 49>¶

__init__(self: depthai.RawCameraControl.Command, value: int) → None ¶

property name¶

property value¶

class ControlMode¶

Bases: pybind11_builtins.pybind11_object

Members:

OFF

AUTO

USE_SCENE_MODE

Attributes:

`AUTO`
`OFF`
`USE_SCENE_MODE`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <ControlMode.AUTO: 1>¶

OFF = <ControlMode.OFF: 0>¶

USE_SCENE_MODE = <ControlMode.USE_SCENE_MODE: 2>¶

__init__(self: depthai.RawCameraControl.ControlMode, value: int) → None ¶

property name¶

property value¶

class EffectMode¶

Bases: pybind11_builtins.pybind11_object

Members:

OFF

MONO

NEGATIVE

SOLARIZE

SEPIA

POSTERIZE

WHITEBOARD

BLACKBOARD

AQUA

Attributes:

`AQUA`
`BLACKBOARD`
`MONO`
`NEGATIVE`
`OFF`
`POSTERIZE`
`SEPIA`
`SOLARIZE`
`WHITEBOARD`
`name`
`value`

Methods:

__init__(self, value)

AQUA = <EffectMode.AQUA: 8>¶

BLACKBOARD = <EffectMode.BLACKBOARD: 7>¶

MONO = <EffectMode.MONO: 1>¶

NEGATIVE = <EffectMode.NEGATIVE: 2>¶

OFF = <EffectMode.OFF: 0>¶

POSTERIZE = <EffectMode.POSTERIZE: 5>¶

SEPIA = <EffectMode.SEPIA: 4>¶

SOLARIZE = <EffectMode.SOLARIZE: 3>¶

WHITEBOARD = <EffectMode.WHITEBOARD: 6>¶

__init__(self: depthai.RawCameraControl.EffectMode, value: int) → None ¶

property name¶

property value¶

class FrameSyncMode¶

Bases: pybind11_builtins.pybind11_object

Members:

OFF

OUTPUT

INPUT

Attributes:

`INPUT`
`OFF`
`OUTPUT`
`name`
`value`

Methods:

__init__(self, value)

INPUT = <FrameSyncMode.INPUT: 2>¶

OFF = <FrameSyncMode.OFF: 0>¶

OUTPUT = <FrameSyncMode.OUTPUT: 1>¶

__init__(self: depthai.RawCameraControl.FrameSyncMode, value: int) → None ¶

property name¶

property value¶

class SceneMode¶

Bases: pybind11_builtins.pybind11_object

Members:

UNSUPPORTED

FACE_PRIORITY

ACTION

PORTRAIT

LANDSCAPE

NIGHT

NIGHT_PORTRAIT

THEATRE

BEACH

SNOW

SUNSET

STEADYPHOTO

FIREWORKS

SPORTS

PARTY

CANDLELIGHT

BARCODE

Attributes:

`ACTION`
`BARCODE`
`BEACH`
`CANDLELIGHT`
`FACE_PRIORITY`
`FIREWORKS`
`LANDSCAPE`
`NIGHT`
`NIGHT_PORTRAIT`
`PARTY`
`PORTRAIT`
`SNOW`
`SPORTS`
`STEADYPHOTO`
`SUNSET`
`THEATRE`
`UNSUPPORTED`
`name`
`value`

Methods:

__init__(self, value)

ACTION = <SceneMode.ACTION: 2>¶

BARCODE = <SceneMode.BARCODE: 16>¶

BEACH = <SceneMode.BEACH: 8>¶

CANDLELIGHT = <SceneMode.CANDLELIGHT: 15>¶

FACE_PRIORITY = <SceneMode.FACE_PRIORITY: 1>¶

FIREWORKS = <SceneMode.FIREWORKS: 12>¶

LANDSCAPE = <SceneMode.LANDSCAPE: 4>¶

NIGHT = <SceneMode.NIGHT: 5>¶

NIGHT_PORTRAIT = <SceneMode.NIGHT_PORTRAIT: 6>¶

PARTY = <SceneMode.PARTY: 14>¶

PORTRAIT = <SceneMode.PORTRAIT: 3>¶

SNOW = <SceneMode.SNOW: 9>¶

SPORTS = <SceneMode.SPORTS: 13>¶

STEADYPHOTO = <SceneMode.STEADYPHOTO: 11>¶

SUNSET = <SceneMode.SUNSET: 10>¶

THEATRE = <SceneMode.THEATRE: 7>¶

UNSUPPORTED = <SceneMode.UNSUPPORTED: 0>¶

__init__(self: depthai.RawCameraControl.SceneMode, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.CameraControl) → None ¶

get(self: depthai.CameraControl) → depthai.RawCameraControl ¶

getCaptureStill(self: depthai.CameraControl) → bool ¶

getExposureTime(self: depthai.CameraControl) → datetime.timedelta ¶

getLensPosition(self: depthai.CameraControl) → int ¶

getLensPositionRaw(self: depthai.CameraControl) → float ¶

getSensitivity(self: depthai.CameraControl) → int ¶

set(self: depthai.CameraControl, config: depthai.RawCameraControl) → depthai.CameraControl ¶

setAntiBandingMode(self: depthai.CameraControl, mode: depthai.RawCameraControl.AntiBandingMode) → depthai.CameraControl ¶

setAutoExposureCompensation(self: depthai.CameraControl, compensation: int) → depthai.CameraControl ¶

setAutoExposureEnable(self: depthai.CameraControl) → depthai.CameraControl ¶

setAutoExposureLimit(*args, **kwargs)¶

Overloaded function.

setAutoExposureLimit(self: depthai.CameraControl, maxExposureTimeUs: int) -> depthai.CameraControl
setAutoExposureLimit(self: depthai.CameraControl, maxExposureTime: datetime.timedelta) -> depthai.CameraControl

setAutoExposureLock(self: depthai.CameraControl, lock: bool) → depthai.CameraControl ¶

setAutoExposureRegion(self: depthai.CameraControl, startX: int, startY: int, width: int, height: int) → depthai.CameraControl ¶

setAutoFocusLensRange(self: depthai.CameraControl, infinityPosition: int, macroPosition: int) → depthai.CameraControl ¶

setAutoFocusMode(self: depthai.CameraControl, mode: depthai.RawCameraControl.AutoFocusMode) → depthai.CameraControl ¶

setAutoFocusRegion(self: depthai.CameraControl, startX: int, startY: int, width: int, height: int) → depthai.CameraControl ¶

setAutoFocusTrigger(self: depthai.CameraControl) → depthai.CameraControl ¶

setAutoWhiteBalanceLock(self: depthai.CameraControl, lock: bool) → depthai.CameraControl ¶

setAutoWhiteBalanceMode(self: depthai.CameraControl, mode: depthai.RawCameraControl.AutoWhiteBalanceMode) → depthai.CameraControl ¶

setBrightness(self: depthai.CameraControl, value: int) → depthai.CameraControl ¶

setCaptureIntent(self: depthai.CameraControl, mode: depthai.RawCameraControl.CaptureIntent) → depthai.CameraControl ¶

setCaptureStill(self: depthai.CameraControl, capture: bool) → depthai.CameraControl ¶

setChromaDenoise(self: depthai.CameraControl, value: int) → depthai.CameraControl ¶

setContrast(self: depthai.CameraControl, value: int) → depthai.CameraControl ¶

setControlMode(self: depthai.CameraControl, mode: depthai.RawCameraControl.ControlMode) → depthai.CameraControl ¶

setEffectMode(self: depthai.CameraControl, mode: depthai.RawCameraControl.EffectMode) → depthai.CameraControl ¶

setExternalTrigger(self: depthai.CameraControl, numFramesBurst: int, numFramesDiscard: int) → depthai.CameraControl ¶

setFrameSyncMode(self: depthai.CameraControl, mode: depthai.RawCameraControl.FrameSyncMode) → depthai.CameraControl ¶

setLumaDenoise(self: depthai.CameraControl, value: int) → depthai.CameraControl ¶

setManualExposure(*args, **kwargs)¶

Overloaded function.

setManualExposure(self: depthai.CameraControl, exposureTimeUs: int, sensitivityIso: int) -> depthai.CameraControl
setManualExposure(self: depthai.CameraControl, exposureTime: datetime.timedelta, sensitivityIso: int) -> depthai.CameraControl

setManualFocus(self: depthai.CameraControl, lensPosition: int) → depthai.CameraControl ¶

setManualFocusRaw(self: depthai.CameraControl, lensPositionRaw: float) → depthai.CameraControl ¶

setManualWhiteBalance(self: depthai.CameraControl, colorTemperatureK: int) → depthai.CameraControl ¶

setSaturation(self: depthai.CameraControl, value: int) → depthai.CameraControl ¶

setSceneMode(self: depthai.CameraControl, mode: depthai.RawCameraControl.SceneMode) → depthai.CameraControl ¶

setSharpness(self: depthai.CameraControl, value: int) → depthai.CameraControl ¶

setStartStreaming(self: depthai.CameraControl) → depthai.CameraControl ¶

setStopStreaming(self: depthai.CameraControl) → depthai.CameraControl ¶

setStrobeDisable(self: depthai.CameraControl) → depthai.CameraControl ¶

setStrobeExternal(self: depthai.CameraControl, gpioNumber: int, activeLevel: int) → depthai.CameraControl ¶

setStrobeSensor(self: depthai.CameraControl, activeLevel: int) → depthai.CameraControl ¶

class depthai.CameraExposureOffset¶

Bases: pybind11_builtins.pybind11_object

Members:

START

MIDDLE

END

Attributes:

`END`
`MIDDLE`
`START`
`name`
`value`

Methods:

__init__(self, value)

END = <CameraExposureOffset.END: 2>¶

MIDDLE = <CameraExposureOffset.MIDDLE: 1>¶

START = <CameraExposureOffset.START: 0>¶

__init__(self: depthai.CameraExposureOffset, value: int) → None ¶

property name¶

property value¶

class depthai.CameraFeatures¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`calibrationResolution`
`configs`
`hasAutofocus`
`hasAutofocusIC`
`height`
`name`
`orientation`
`sensorName`
`socket`
`supportedTypes`
`width`

__init__(self: depthai.CameraFeatures) → None ¶

property calibrationResolution¶

property configs¶

property hasAutofocus¶

property hasAutofocusIC¶

property height¶

property name¶

property orientation¶

property sensorName¶

property socket¶

property supportedTypes¶

property width¶

class depthai.CameraImageOrientation¶

Bases: pybind11_builtins.pybind11_object

Members:

AUTO

NORMAL

HORIZONTAL_MIRROR

VERTICAL_FLIP

ROTATE_180_DEG

Attributes:

`AUTO`
`HORIZONTAL_MIRROR`
`NORMAL`
`ROTATE_180_DEG`
`VERTICAL_FLIP`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <CameraImageOrientation.AUTO: -1>¶

HORIZONTAL_MIRROR = <CameraImageOrientation.HORIZONTAL_MIRROR: 1>¶

NORMAL = <CameraImageOrientation.NORMAL: 0>¶

ROTATE_180_DEG = <CameraImageOrientation.ROTATE_180_DEG: 3>¶

VERTICAL_FLIP = <CameraImageOrientation.VERTICAL_FLIP: 2>¶

__init__(self: depthai.CameraImageOrientation, value: int) → None ¶

property name¶

property value¶

class depthai.CameraInfo¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`cameraType`
`distortionCoeff`
`extrinsics`
`height`
`intrinsicMatrix`
`specHfovDeg`
`width`

__init__(self: depthai.CameraInfo) → None ¶

property cameraType¶

property distortionCoeff¶

property extrinsics¶

property height¶

property intrinsicMatrix¶

property specHfovDeg¶

property width¶

class depthai.CameraModel¶

Bases: pybind11_builtins.pybind11_object

Members:

Perspective

Fisheye

Equirectangular

RadialDivision

Attributes:

`Equirectangular`
`Fisheye`
`Perspective`
`RadialDivision`
`name`
`value`

Methods:

__init__(self, value)

Equirectangular = <CameraModel.Equirectangular: 2>¶

Fisheye = <CameraModel.Fisheye: 1>¶

Perspective = <CameraModel.Perspective: 0>¶

RadialDivision = <CameraModel.RadialDivision: 3>¶

__init__(self: depthai.CameraModel, value: int) → None ¶

property name¶

property value¶

class depthai.CameraProperties¶

Bases: pybind11_builtins.pybind11_object

Classes:

`ColorOrder`	Members:
`WarpMeshSource`	Members:

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

class ColorOrder¶

Bases: pybind11_builtins.pybind11_object

Members:

BGR

RGB

Attributes:

`BGR`
`RGB`
`name`
`value`

Methods:

__init__(self, value)

BGR = <ColorOrder.BGR: 0>¶

RGB = <ColorOrder.RGB: 1>¶

__init__(self: depthai.CameraProperties.ColorOrder, value: int) → None ¶

property name¶

property value¶

class WarpMeshSource¶

Bases: pybind11_builtins.pybind11_object

Members:

AUTO

NONE

CALIBRATION

URI

Attributes:

`AUTO`
`CALIBRATION`
`NONE`
`URI`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <WarpMeshSource.AUTO: -1>¶

CALIBRATION = <WarpMeshSource.CALIBRATION: 1>¶

NONE = <WarpMeshSource.NONE: 0>¶

URI = <WarpMeshSource.URI: 2>¶

__init__(self: depthai.CameraProperties.WarpMeshSource, value: int) → None ¶

property name¶

property value¶

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property boardSocket¶

property calibAlpha¶

property cameraName¶

property colorOrder¶

property fp16¶

property fps¶

property imageOrientation¶

property initialControl¶

property interleaved¶

property isp3aFps¶

property ispScale¶

property numFramesPoolIsp¶

property numFramesPoolPreview¶

property numFramesPoolRaw¶

property numFramesPoolStill¶

property numFramesPoolVideo¶

property previewHeight¶

property previewKeepAspectRatio¶

property previewWidth¶

property rawPacked¶

property resolutionHeight¶

property resolutionWidth¶

property sensorCropX¶

property sensorCropY¶

property sensorType¶

property stillHeight¶

property stillWidth¶

property videoHeight¶

property videoWidth¶

property warpMeshHeight¶

property warpMeshSource¶

property warpMeshStepHeight¶

property warpMeshStepWidth¶

property warpMeshUri¶

property warpMeshWidth¶

class depthai.CameraSensorConfig¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`fov`
`height`
`maxFps`
`minFps`
`type`
`width`

__init__(self: depthai.CameraSensorConfig) → None ¶

property fov¶

property height¶

property maxFps¶

property minFps¶

property type¶

property width¶

class depthai.CameraSensorType¶

Bases: pybind11_builtins.pybind11_object

Members:

COLOR

MONO

TOF

THERMAL

Attributes:

`COLOR`
`MONO`
`THERMAL`
`TOF`
`name`
`value`

Methods:

__init__(self, value)

COLOR = <CameraSensorType.COLOR: 0>¶

MONO = <CameraSensorType.MONO: 1>¶

THERMAL = <CameraSensorType.THERMAL: 3>¶

TOF = <CameraSensorType.TOF: 2>¶

__init__(self: depthai.CameraSensorType, value: int) → None ¶

property name¶

property value¶

class depthai.CastProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`numFramesPool`
`offset`
`outputType`
`scale`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property numFramesPool¶

property offset¶

property outputType¶

property scale¶

class depthai.ChipTemperature¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`average`
`css`
`dss`
`mss`
`upa`

__init__(self: depthai.ChipTemperature) → None ¶

property average¶

property css¶

property dss¶

property mss¶

property upa¶

class depthai.Clock¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(args, *kwargs)	Initialize self.
`now`()

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

now() → datetime.timedelta ¶

class depthai.ColorCameraProperties¶

Bases: pybind11_builtins.pybind11_object

Classes:

`ColorOrder`	Members:
`SensorResolution`	Members:

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

class ColorOrder¶

Bases: pybind11_builtins.pybind11_object

Members:

BGR

RGB

Attributes:

`BGR`
`RGB`
`name`
`value`

Methods:

__init__(self, value)

BGR = <ColorOrder.BGR: 0>¶

RGB = <ColorOrder.RGB: 1>¶

__init__(self: depthai.ColorCameraProperties.ColorOrder, value: int) → None ¶

property name¶

property value¶

class SensorResolution¶

Bases: pybind11_builtins.pybind11_object

Members:

THE_1080_P

THE_1200_P

THE_4_K

THE_5_MP

THE_12_MP

THE_4000X3000

THE_13_MP

THE_5312X6000

THE_48_MP

THE_720_P

THE_800_P

THE_1440X1080

THE_1352X1012

THE_2024X1520

Attributes:

`THE_1080_P`
`THE_1200_P`
`THE_12_MP`
`THE_1352X1012`
`THE_13_MP`
`THE_1440X1080`
`THE_2024X1520`
`THE_4000X3000`
`THE_48_MP`
`THE_4_K`
`THE_5312X6000`
`THE_5_MP`
`THE_720_P`
`THE_800_P`
`name`
`value`

Methods:

__init__(self, value)

THE_1080_P = <SensorResolution.THE_1080_P: 0>¶

THE_1200_P = <SensorResolution.THE_1200_P: 6>¶

THE_12_MP = <SensorResolution.THE_12_MP: 2>¶

THE_1352X1012 = <SensorResolution.THE_1352X1012: 12>¶

THE_13_MP = <SensorResolution.THE_13_MP: 3>¶

THE_1440X1080 = <SensorResolution.THE_1440X1080: 11>¶

THE_2024X1520 = <SensorResolution.THE_2024X1520: 13>¶

THE_4000X3000 = <SensorResolution.THE_4000X3000: 8>¶

THE_48_MP = <SensorResolution.THE_48_MP: 10>¶

THE_4_K = <SensorResolution.THE_4_K: 1>¶

THE_5312X6000 = <SensorResolution.THE_5312X6000: 9>¶

THE_5_MP = <SensorResolution.THE_5_MP: 7>¶

THE_720_P = <SensorResolution.THE_720_P: 4>¶

THE_800_P = <SensorResolution.THE_800_P: 5>¶

__init__(self: depthai.ColorCameraProperties.SensorResolution, value: int) → None ¶

property name¶

property value¶

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property boardSocket¶

property colorOrder¶

property eventFilter¶

property fp16¶

property fps¶

property imageOrientation¶

property initialControl¶

property interleaved¶

property isp3aFps¶

property ispScale¶

property numFramesPoolIsp¶

property numFramesPoolPreview¶

property numFramesPoolRaw¶

property numFramesPoolStill¶

property numFramesPoolVideo¶

property previewHeight¶

property previewKeepAspectRatio¶

property previewWidth¶

property resolution¶

property sensorCropX¶

property sensorCropY¶

property stillHeight¶

property stillWidth¶

property videoHeight¶

property videoWidth¶

class depthai.Colormap¶

Bases: pybind11_builtins.pybind11_object

Members:

NONE

JET

TURBO

STEREO_JET

STEREO_TURBO

Attributes:

`JET`
`NONE`
`STEREO_JET`
`STEREO_TURBO`
`TURBO`
`name`
`value`

Methods:

__init__(self, value)

JET = <Colormap.JET: 2>¶

NONE = <Colormap.NONE: 0>¶

STEREO_JET = <Colormap.STEREO_JET: 4>¶

STEREO_TURBO = <Colormap.STEREO_TURBO: 3>¶

TURBO = <Colormap.TURBO: 1>¶

__init__(self: depthai.Colormap, value: int) → None ¶

property name¶

property value¶

class depthai.CpuUsage¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`average`
`msTime`

__init__(self: depthai.CpuUsage) → None ¶

property average¶

property msTime¶

class depthai.CrashDump¶

Bases: pybind11_builtins.pybind11_object

Classes:

CrashReport

Methods:

`__init__`(self)
`serializeToJson`(self)

Attributes:

`crashReports`
`depthaiCommitHash`
`deviceId`

class CrashReport¶

Bases: pybind11_builtins.pybind11_object

Classes:

`ErrorSourceInfo`
`ThreadCallstack`

Methods:

__init__(self)

Attributes:

`crashedThreadId`
`errorSource`
`processor`
`threadCallstack`

class ErrorSourceInfo¶

Bases: pybind11_builtins.pybind11_object

Classes:

`AssertContext`
`TrapContext`

Methods:

__init__(self)

Attributes:

`assertContext`
`errorId`
`trapContext`

class AssertContext¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`fileName`
`functionName`
`line`

__init__(self: depthai.CrashDump.CrashReport.ErrorSourceInfo.AssertContext) → None ¶

property fileName¶

property functionName¶

property line¶

class TrapContext¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`trapAddress`
`trapName`
`trapNumber`

__init__(self: depthai.CrashDump.CrashReport.ErrorSourceInfo.TrapContext) → None ¶

property trapAddress¶

property trapName¶

property trapNumber¶

__init__(self: depthai.CrashDump.CrashReport.ErrorSourceInfo) → None ¶

property assertContext¶

property errorId¶

property trapContext¶

class ThreadCallstack¶

Bases: pybind11_builtins.pybind11_object

Classes:

CallstackContext

Methods:

__init__(self)

Attributes:

`callStack`
`instructionPointer`
`stackBottom`
`stackPointer`
`stackTop`
`threadId`
`threadName`
`threadStatus`

class CallstackContext¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`callSite`
`calledTarget`
`context`
`framePointer`

__init__(self: depthai.CrashDump.CrashReport.ThreadCallstack.CallstackContext) → None ¶

property callSite¶

property calledTarget¶

property context¶

property framePointer¶

__init__(self: depthai.CrashDump.CrashReport.ThreadCallstack) → None ¶

property callStack¶

property instructionPointer¶

property stackBottom¶

property stackPointer¶

property stackTop¶

property threadId¶

property threadName¶

property threadStatus¶

__init__(self: depthai.CrashDump.CrashReport) → None ¶

property crashedThreadId¶

property errorSource¶

property processor¶

property threadCallstack¶

__init__(self: depthai.CrashDump) → None ¶

property crashReports¶

property depthaiCommitHash¶

property deviceId¶

serializeToJson(self: depthai.CrashDump) → json¶

class depthai.DataInputQueue¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(args, *kwargs)	Initialize self.
`close`(self)
`getBlocking`(self)
`getMaxSize`(self)
`getName`(self)
`isClosed`(self)
`send`(args, *kwargs)	Overloaded function.
`setBlocking`(self, blocking)
`setMaxSize`(self, maxSize)

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

close(self: depthai.DataInputQueue) → None ¶

getBlocking(self: depthai.DataInputQueue) → bool ¶

getMaxSize(self: depthai.DataInputQueue) → int ¶

getName(self: depthai.DataInputQueue) → str ¶

isClosed(self: depthai.DataInputQueue) → bool ¶

send(*args, **kwargs)¶

Overloaded function.

send(self: depthai.DataInputQueue, msg: depthai.ADatatype) -> None
send(self: depthai.DataInputQueue, rawMsg: depthai.RawBuffer) -> None

setBlocking(self: depthai.DataInputQueue, blocking: bool) → None ¶

setMaxSize(self: depthai.DataInputQueue, maxSize: int) → None ¶

class depthai.DataOutputQueue¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(args, *kwargs)	Initialize self.
`addCallback`(args, *kwargs)	Overloaded function.
`close`(self)
`get`(self)
`getAll`(self)
`getBlocking`(self)
`getMaxSize`(self)
`getName`(self)
`has`(self)
`isClosed`(self)
`removeCallback`(self, callbackId)
`setBlocking`(self, blocking)
`setMaxSize`(self, maxSize)
`tryGet`(self)
`tryGetAll`(self)

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

addCallback(*args, **kwargs)¶

Overloaded function.

addCallback(self: depthai.DataOutputQueue, callback: Callable) -> int
addCallback(self: depthai.DataOutputQueue, callback: Callable) -> int
addCallback(self: depthai.DataOutputQueue, callback: Callable) -> int

close(self: depthai.DataOutputQueue) → None ¶

get(self: depthai.DataOutputQueue) → depthai.ADatatype ¶

getAll(self: depthai.DataOutputQueue) → list[depthai.ADatatype]¶

getBlocking(self: depthai.DataOutputQueue) → bool ¶

getMaxSize(self: depthai.DataOutputQueue) → int ¶

getName(self: depthai.DataOutputQueue) → str ¶

has(self: depthai.DataOutputQueue) → bool ¶

isClosed(self: depthai.DataOutputQueue) → bool ¶

removeCallback(self: depthai.DataOutputQueue, callbackId: int) → bool ¶

setBlocking(self: depthai.DataOutputQueue, blocking: bool) → None ¶

setMaxSize(self: depthai.DataOutputQueue, maxSize: int) → None ¶

tryGet(self: depthai.DataOutputQueue) → depthai.ADatatype ¶

tryGetAll(self: depthai.DataOutputQueue) → list[depthai.ADatatype]¶

class depthai.DatatypeEnum¶

Bases: pybind11_builtins.pybind11_object

Members:

Buffer

ImgFrame

EncodedFrame

NNData

ImageManipConfig

CameraControl

ImgDetections

SpatialImgDetections

SystemInformation

SpatialLocationCalculatorConfig

SpatialLocationCalculatorData

EdgeDetectorConfig

AprilTagConfig

AprilTags

Tracklets

IMUData

StereoDepthConfig

FeatureTrackerConfig

TrackedFeatures

PointCloudConfig

PointCloudData

Attributes:

Methods:

__init__(self, value)

AprilTagConfig = <DatatypeEnum.AprilTagConfig: 12>¶

AprilTags = <DatatypeEnum.AprilTags: 13>¶

Buffer = <DatatypeEnum.Buffer: 0>¶

CameraControl = <DatatypeEnum.CameraControl: 5>¶

EdgeDetectorConfig = <DatatypeEnum.EdgeDetectorConfig: 11>¶

EncodedFrame = <DatatypeEnum.EncodedFrame: 2>¶

FeatureTrackerConfig = <DatatypeEnum.FeatureTrackerConfig: 17>¶

IMUData = <DatatypeEnum.IMUData: 15>¶

ImageManipConfig = <DatatypeEnum.ImageManipConfig: 4>¶

ImgDetections = <DatatypeEnum.ImgDetections: 6>¶

ImgFrame = <DatatypeEnum.ImgFrame: 1>¶

NNData = <DatatypeEnum.NNData: 3>¶

PointCloudConfig = <DatatypeEnum.PointCloudConfig: 20>¶

PointCloudData = <DatatypeEnum.PointCloudData: 21>¶

SpatialImgDetections = <DatatypeEnum.SpatialImgDetections: 7>¶

SpatialLocationCalculatorConfig = <DatatypeEnum.SpatialLocationCalculatorConfig: 9>¶

SpatialLocationCalculatorData = <DatatypeEnum.SpatialLocationCalculatorData: 10>¶

StereoDepthConfig = <DatatypeEnum.StereoDepthConfig: 16>¶

SystemInformation = <DatatypeEnum.SystemInformation: 8>¶

TrackedFeatures = <DatatypeEnum.TrackedFeatures: 22>¶

Tracklets = <DatatypeEnum.Tracklets: 14>¶

__init__(self: depthai.DatatypeEnum, value: int) → None ¶

property name¶

property value¶

class depthai.DetectionNetworkProperties¶

Bases: depthai.NeuralNetworkProperties

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

parser

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property parser¶

class depthai.DetectionNetworkType¶

Bases: pybind11_builtins.pybind11_object

Members:

YOLO

MOBILENET

Attributes:

`MOBILENET`
`YOLO`
`name`
`value`

Methods:

__init__(self, value)

MOBILENET = <DetectionNetworkType.MOBILENET: 1>¶

YOLO = <DetectionNetworkType.YOLO: 0>¶

__init__(self: depthai.DetectionNetworkType, value: int) → None ¶

property name¶

property value¶

class depthai.DetectionParserOptions¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`anchorMasks`
`anchors`
`classes`
`confidenceThreshold`
`coordinates`
`iouThreshold`
`nnFamily`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property anchorMasks¶

property anchors¶

property classes¶

property confidenceThreshold¶

property coordinates¶

property iouThreshold¶

property nnFamily¶

class depthai.DetectionParserProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

parser

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property parser¶

class depthai.Device¶

Bases: depthai.DeviceBase

Classes:

Config

Methods:

`__init__`(args, *kwargs)	Overloaded function.
`getInputQueue`(args, *kwargs)	Overloaded function.
`getInputQueueNames`(self)
`getOutputQueue`(args, *kwargs)	Overloaded function.
`getOutputQueueNames`(self)
`getQueueEvent`(args, *kwargs)	Overloaded function.
`getQueueEvents`(args, *kwargs)	Overloaded function.

class Config¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`board`
`logLevel`
`nonExclusiveMode`
`outputLogLevel`
`version`

__init__(self: depthai.Device.Config) → None ¶

property board¶

property logLevel¶

property nonExclusiveMode¶

property outputLogLevel¶

property version¶

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.Device, pipeline: depthai.Pipeline) -> None
__init__(self: depthai.Device, pipeline: depthai.Pipeline, usb2Mode: bool) -> None
__init__(self: depthai.Device, pipeline: depthai.Pipeline, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.Device, pipeline: depthai.Pipeline, pathToCmd: Path) -> None
__init__(self: depthai.Device, pipeline: depthai.Pipeline, devInfo: depthai.DeviceInfo, usb2Mode: bool = False) -> None
__init__(self: depthai.Device, pipeline: depthai.Pipeline, deviceInfo: depthai.DeviceInfo, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.Device, pipeline: depthai.Pipeline, devInfo: depthai.DeviceInfo, pathToCmd: Path) -> None
__init__(self: depthai.Device, pipeline: depthai.Pipeline, deviceInfo: depthai.DeviceInfo) -> None
__init__(self: depthai.Device, version: depthai.OpenVINO.Version = <Version.???: 7>) -> None
__init__(self: depthai.Device, version: depthai.OpenVINO.Version, usb2Mode: bool = False) -> None
__init__(self: depthai.Device, version: depthai.OpenVINO.Version, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.Device, version: depthai.OpenVINO.Version, pathToCmd: Path) -> None
__init__(self: depthai.Device, version: depthai.OpenVINO.Version, deviceInfo: depthai.DeviceInfo, usb2Mode: bool = False) -> None
__init__(self: depthai.Device, version: depthai.OpenVINO.Version, deviceInfo: depthai.DeviceInfo, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.Device, version: depthai.OpenVINO.Version, deviceDesc: depthai.DeviceInfo, pathToCmd: Path) -> None
__init__(self: depthai.Device, config: depthai.Device.Config) -> None
__init__(self: depthai.Device, config: depthai.Device.Config, deviceInfo: depthai.DeviceInfo) -> None
__init__(self: depthai.Device, deviceInfo: depthai.DeviceInfo) -> None
__init__(self: depthai.Device, deviceInfo: depthai.DeviceInfo, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.Device, nameOrDeviceId: str) -> None
__init__(self: depthai.Device, nameOrDeviceId: str, maxUsbSpeed: depthai.UsbSpeed) -> None

getInputQueue(*args, **kwargs)¶

Overloaded function.

getInputQueue(self: depthai.Device, name: str) -> depthai.DataInputQueue
getInputQueue(self: depthai.Device, name: str, maxSize: int, blocking: bool = True) -> depthai.DataInputQueue

getInputQueueNames(self: depthai.Device) → list[str]¶

getOutputQueue(*args, **kwargs)¶

Overloaded function.

getOutputQueue(self: depthai.Device, name: str) -> depthai.DataOutputQueue
getOutputQueue(self: depthai.Device, name: str, maxSize: int, blocking: bool = True) -> depthai.DataOutputQueue

getOutputQueueNames(self: depthai.Device) → list[str]¶

getQueueEvent(*args, **kwargs)¶

Overloaded function.

getQueueEvent(self: depthai.Device, queueNames: list[str], timeout: datetime.timedelta = datetime.timedelta(days=-1, seconds=86399, microseconds=999999)) -> str
getQueueEvent(self: depthai.Device, queueName: str, timeout: datetime.timedelta = datetime.timedelta(days=-1, seconds=86399, microseconds=999999)) -> str
getQueueEvent(self: depthai.Device, timeout: datetime.timedelta = datetime.timedelta(days=-1, seconds=86399, microseconds=999999)) -> str

getQueueEvents(*args, **kwargs)¶

Overloaded function.

getQueueEvents(self: depthai.Device, queueNames: list[str], maxNumEvents: int = 18446744073709551615, timeout: datetime.timedelta = datetime.timedelta(days=-1, seconds=86399, microseconds=999999)) -> list[str]
getQueueEvents(self: depthai.Device, queueName: str, maxNumEvents: int = 18446744073709551615, timeout: datetime.timedelta = datetime.timedelta(days=-1, seconds=86399, microseconds=999999)) -> list[str]
getQueueEvents(self: depthai.Device, maxNumEvents: int = 18446744073709551615, timeout: datetime.timedelta = datetime.timedelta(days=-1, seconds=86399, microseconds=999999)) -> list[str]

class depthai.DeviceBase¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(args, *kwargs)	Overloaded function.
`addLogCallback`(self, callback, None])
`close`(self)	Closes the connection to device.
`factoryResetCalibration`(self)
`flashCalibration`(self, calibrationDataHandler)
`flashCalibration2`(self, arg0)
`flashEepromClear`(self)
`flashFactoryCalibration`(self, arg0)
`flashFactoryEepromClear`(self)
`getAllAvailableDevices`()
`getAllConnectedDevices`()
`getAnyAvailableDevice`(args, *kwargs)	Overloaded function.
`getAvailableStereoPairs`(self)
`getBootloaderVersion`(self)
`getCameraSensorNames`(self)
`getChipTemperature`(self)
`getCmxMemoryUsage`(self)
`getConnectedCameraFeatures`(self)
`getConnectedCameras`(self)
`getConnectedIMU`(self)
`getConnectionInterfaces`(self)
`getCrashDump`(self, clearCrashDump)
`getDdrMemoryUsage`(self)
`getDeviceByMxId`(mxId)
`getDeviceInfo`(self)
`getDeviceName`(self)
`getEmbeddedDeviceBinary`(args, *kwargs)	Overloaded function.
`getEmbeddedIMUFirmwareVersion`(self)
`getFirstAvailableDevice`(skipInvalidDevices)
`getGlobalProfilingData`()
`getIMUFirmwareUpdateStatus`(self)
`getIMUFirmwareVersion`(self)
`getIrDrivers`(self)
`getLeonCssCpuUsage`(self)
`getLeonCssHeapUsage`(self)
`getLeonMssCpuUsage`(self)
`getLeonMssHeapUsage`(self)
`getLogLevel`(self)
`getLogOutputLevel`(self)
`getMxId`(self)
`getProductName`(self)
`getProfilingData`(self)
`getStereoPairs`(self)
`getSystemInformationLoggingRate`(self)
`getUsbSpeed`(self)
`getXLinkChunkSize`(self)
`hasCrashDump`(self)
`isClosed`(self)
`isEepromAvailable`(self)
`isPipelineRunning`(self)
`readCalibration`(self)
`readCalibration2`(self)
`readCalibrationOrDefault`(self)
`readCalibrationRaw`(self)
`readFactoryCalibration`(self)
`readFactoryCalibrationOrDefault`(self)
`readFactoryCalibrationRaw`(self)
`removeLogCallback`(self, callbackId)
`setIrFloodLightBrightness`(self, mA, mask)
`setIrFloodLightIntensity`(self, intensity, mask)
`setIrLaserDotProjectorBrightness`(self, mA, mask)
`setIrLaserDotProjectorIntensity`(self, …)
`setLogLevel`(self, level)
`setLogOutputLevel`(self, level)
`setSystemInformationLoggingRate`(self, rateHz)
`setTimesync`(args, *kwargs)	Overloaded function.
`setXLinkChunkSize`(self, sizeBytes)
`startIMUFirmwareUpdate`(self, forceUpdate)
`startPipeline`(args, *kwargs)	Overloaded function.

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.DeviceBase, pipeline: depthai.Pipeline) -> None
__init__(self: depthai.DeviceBase, pipeline: depthai.Pipeline, usb2Mode: bool) -> None
__init__(self: depthai.DeviceBase, pipeline: depthai.Pipeline, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.DeviceBase, pipeline: depthai.Pipeline, pathToCmd: Path) -> None
__init__(self: depthai.DeviceBase, pipeline: depthai.Pipeline, devInfo: depthai.DeviceInfo, usb2Mode: bool = False) -> None
__init__(self: depthai.DeviceBase, pipeline: depthai.Pipeline, deviceInfo: depthai.DeviceInfo, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.DeviceBase, pipeline: depthai.Pipeline, devInfo: depthai.DeviceInfo, pathToCmd: Path) -> None
__init__(self: depthai.DeviceBase, pipeline: depthai.Pipeline, deviceInfo: depthai.DeviceInfo) -> None
__init__(self: depthai.DeviceBase, version: depthai.OpenVINO.Version = <Version.???: 7>) -> None
__init__(self: depthai.DeviceBase, version: depthai.OpenVINO.Version, usb2Mode: bool = False) -> None
__init__(self: depthai.DeviceBase, version: depthai.OpenVINO.Version, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.DeviceBase, version: depthai.OpenVINO.Version, pathToCmd: Path) -> None
__init__(self: depthai.DeviceBase, version: depthai.OpenVINO.Version, deviceInfo: depthai.DeviceInfo, usb2Mode: bool = False) -> None
__init__(self: depthai.DeviceBase, version: depthai.OpenVINO.Version, deviceInfo: depthai.DeviceInfo, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.DeviceBase, version: depthai.OpenVINO.Version, deviceDesc: depthai.DeviceInfo, pathToCmd: Path) -> None
__init__(self: depthai.DeviceBase, config: depthai.Device.Config) -> None
__init__(self: depthai.DeviceBase, config: depthai.Device.Config, deviceInfo: depthai.DeviceInfo) -> None
__init__(self: depthai.DeviceBase, deviceInfo: depthai.DeviceInfo) -> None
__init__(self: depthai.DeviceBase, deviceInfo: depthai.DeviceInfo, maxUsbSpeed: depthai.UsbSpeed) -> None
__init__(self: depthai.DeviceBase, nameOrDeviceId: str) -> None
__init__(self: depthai.DeviceBase, nameOrDeviceId: str, maxUsbSpeed: depthai.UsbSpeed) -> None

addLogCallback(self: depthai.DeviceBase, callback: Callable[[depthai.LogMessage], None]) → int ¶

close(self: depthai.DeviceBase) → None ¶: Closes the connection to device. Better alternative is the usage of context manager: with depthai.Device(pipeline) as device:

factoryResetCalibration(self: depthai.DeviceBase) → None ¶

flashCalibration(self: depthai.DeviceBase, calibrationDataHandler: depthai.CalibrationHandler) → bool ¶

flashCalibration2(self: depthai.DeviceBase, arg0: depthai.CalibrationHandler) → None ¶

flashEepromClear(self: depthai.DeviceBase) → None ¶

flashFactoryCalibration(self: depthai.DeviceBase, arg0: depthai.CalibrationHandler) → None ¶

flashFactoryEepromClear(self: depthai.DeviceBase) → None ¶

static getAllAvailableDevices() → list[depthai.DeviceInfo]¶

static getAllConnectedDevices() → list[depthai.DeviceInfo]¶

static getAnyAvailableDevice(*args, **kwargs)¶

Overloaded function.

getAnyAvailableDevice(timeout: datetime.timedelta) -> tuple[bool, depthai.DeviceInfo]
getAnyAvailableDevice() -> tuple[bool, depthai.DeviceInfo]

getAvailableStereoPairs(self: depthai.DeviceBase) → list[depthai.StereoPair]¶

getBootloaderVersion(self: depthai.DeviceBase) → Optional[depthai.Version]¶

getCameraSensorNames(self: depthai.DeviceBase) → dict[depthai.CameraBoardSocket, str]¶

getChipTemperature(self: depthai.DeviceBase) → depthai.ChipTemperature ¶

getCmxMemoryUsage(self: depthai.DeviceBase) → depthai.MemoryInfo ¶

getConnectedCameraFeatures(self: depthai.DeviceBase) → list[depthai.CameraFeatures]¶

getConnectedCameras(self: depthai.DeviceBase) → list[depthai.CameraBoardSocket]¶

getConnectedIMU(self: depthai.DeviceBase) → str ¶

getConnectionInterfaces(self: depthai.DeviceBase) → list[depthai.connectionInterface]¶

getCrashDump(self: depthai.DeviceBase, clearCrashDump: bool = True) → depthai.CrashDump ¶

getDdrMemoryUsage(self: depthai.DeviceBase) → depthai.MemoryInfo ¶

static getDeviceByMxId(mxId: str) → tuple[bool, depthai.DeviceInfo]¶

getDeviceInfo(self: depthai.DeviceBase) → depthai.DeviceInfo ¶

getDeviceName(self: depthai.DeviceBase) → object ¶

static getEmbeddedDeviceBinary(*args, **kwargs)¶

Overloaded function.

getEmbeddedDeviceBinary(usb2Mode: bool, version: depthai.OpenVINO.Version = <Version.???: 7>) -> list[int]
getEmbeddedDeviceBinary(config: depthai.Device.Config) -> list[int]

getEmbeddedIMUFirmwareVersion(self: depthai.DeviceBase) → depthai.Version ¶

static getFirstAvailableDevice(skipInvalidDevices: bool = True) → tuple[bool, depthai.DeviceInfo]¶

static getGlobalProfilingData() → depthai.ProfilingData ¶

getIMUFirmwareUpdateStatus(self: depthai.DeviceBase) → tuple[bool, int]¶

getIMUFirmwareVersion(self: depthai.DeviceBase) → depthai.Version ¶

getIrDrivers(self: depthai.DeviceBase) → list[tuple[str, int, int]]¶

getLeonCssCpuUsage(self: depthai.DeviceBase) → depthai.CpuUsage ¶

getLeonCssHeapUsage(self: depthai.DeviceBase) → depthai.MemoryInfo ¶

getLeonMssCpuUsage(self: depthai.DeviceBase) → depthai.CpuUsage ¶

getLeonMssHeapUsage(self: depthai.DeviceBase) → depthai.MemoryInfo ¶

getLogLevel(self: depthai.DeviceBase) → depthai.LogLevel ¶

getLogOutputLevel(self: depthai.DeviceBase) → depthai.LogLevel ¶

getMxId(self: depthai.DeviceBase) → str ¶

getProductName(self: depthai.DeviceBase) → object ¶

getProfilingData(self: depthai.DeviceBase) → depthai.ProfilingData ¶

getStereoPairs(self: depthai.DeviceBase) → list[depthai.StereoPair]¶

getSystemInformationLoggingRate(self: depthai.DeviceBase) → float ¶

getUsbSpeed(self: depthai.DeviceBase) → depthai.UsbSpeed ¶

getXLinkChunkSize(self: depthai.DeviceBase) → int ¶

hasCrashDump(self: depthai.DeviceBase) → bool ¶

isClosed(self: depthai.DeviceBase) → bool ¶

isEepromAvailable(self: depthai.DeviceBase) → bool ¶

isPipelineRunning(self: depthai.DeviceBase) → bool ¶

readCalibration(self: depthai.DeviceBase) → depthai.CalibrationHandler ¶

readCalibration2(self: depthai.DeviceBase) → depthai.CalibrationHandler ¶

readCalibrationOrDefault(self: depthai.DeviceBase) → depthai.CalibrationHandler ¶

readCalibrationRaw(self: depthai.DeviceBase) → list[int]¶

readFactoryCalibration(self: depthai.DeviceBase) → depthai.CalibrationHandler ¶

readFactoryCalibrationOrDefault(self: depthai.DeviceBase) → depthai.CalibrationHandler ¶

readFactoryCalibrationRaw(self: depthai.DeviceBase) → list[int]¶

removeLogCallback(self: depthai.DeviceBase, callbackId: int) → bool ¶

setIrFloodLightBrightness(self: depthai.DeviceBase, mA: float, mask: int = - 1) → bool ¶

setIrFloodLightIntensity(self: depthai.DeviceBase, intensity: float, mask: int = - 1) → bool ¶

setIrLaserDotProjectorBrightness(self: depthai.DeviceBase, mA: float, mask: int = - 1) → bool ¶

setIrLaserDotProjectorIntensity(self: depthai.DeviceBase, intensity: float, mask: int = - 1) → bool ¶

setLogLevel(self: depthai.DeviceBase, level: depthai.LogLevel) → None ¶

setLogOutputLevel(self: depthai.DeviceBase, level: depthai.LogLevel) → None ¶

setSystemInformationLoggingRate(self: depthai.DeviceBase, rateHz: float) → None ¶

setTimesync(*args, **kwargs)¶

Overloaded function.

setTimesync(self: depthai.DeviceBase, arg0: datetime.timedelta, arg1: int, arg2: bool) -> None
setTimesync(self: depthai.DeviceBase, enable: bool) -> None

setXLinkChunkSize(self: depthai.DeviceBase, sizeBytes: int) → None ¶

startIMUFirmwareUpdate(self: depthai.DeviceBase, forceUpdate: bool = False) → bool ¶

startPipeline(*args, **kwargs)¶

Overloaded function.

startPipeline(self: depthai.DeviceBase) -> None
startPipeline(self: depthai.DeviceBase, arg0: depthai.Pipeline) -> bool

class depthai.DeviceBootloader¶

Bases: pybind11_builtins.pybind11_object

Classes:

`ApplicationInfo`
`Config`
`Memory`	Members:
`MemoryInfo`
`NetworkConfig`
`Section`	Members:
`Type`	Members:
`UsbConfig`

Methods:

`__init__`(args, *kwargs)	Overloaded function.
`bootMemory`(self, fw)
`bootUsbRomBootloader`(self)
`close`(self)	Closes the connection to device.
`createDepthaiApplicationPackage`(args, *kwargs)	Overloaded function.
`flash`(args, *kwargs)	Overloaded function.
`flashBootHeader`(self, memory, frequency, …)
`flashBootloader`(args, *kwargs)	Overloaded function.
`flashClear`(self, memory)
`flashConfig`(self, config, memory, type)
`flashConfigClear`(self, memory, type)
`flashConfigData`(self, configData, memory, type)
`flashConfigFile`(self, configData, memory, type)
`flashCustom`(args, *kwargs)	Overloaded function.
`flashDepthaiApplicationPackage`(args, *kwargs)	Overloaded function.
`flashFastBootHeader`(self, memory, frequency, …)
`flashGpioModeBootHeader`(self, memory, mode)
`flashUsbRecoveryBootHeader`(self, memory)
`flashUserBootloader`(self, progressCallback, …)
`getAllAvailableDevices`()
`getEmbeddedBootloaderBinary`(arg0)
`getEmbeddedBootloaderVersion`()
`getFirstAvailableDevice`()
`getFlashedVersion`(self)
`getMemoryInfo`(self, arg0)
`getType`(self)
`getVersion`(self)
`isAllowedFlashingBootloader`(self)
`isEmbeddedVersion`(self)
`isUserBootloader`(self)
`isUserBootloaderSupported`(self)
`readApplicationInfo`(self, memory)
`readConfig`(self, memory, type)
`readConfigData`(self, memory, type)
`readCustom`(args, *kwargs)	Overloaded function.
`saveDepthaiApplicationPackage`(args, *kwargs)	Overloaded function.

class ApplicationInfo¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`applicationName`
`firmwareVersion`
`hasApplication`

__init__(self: depthai.DeviceBootloader.ApplicationInfo) → None ¶

property applicationName¶

property firmwareVersion¶

property hasApplication¶

class Config¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(self)
`fromJson`(self)
`getDnsAltIPv4`(self)
`getDnsIPv4`(self)
`getIPv4`(self)
`getIPv4Gateway`(self)
`getIPv4Mask`(self)
`getMacAddress`(self)
`getNetworkTimeout`(self)
`getUsbMaxSpeed`(self)
`getUsbTimeout`(self)
`isStaticIPV4`(self)
`setDnsIPv4`(self, arg0, arg1)
`setDynamicIPv4`(self, arg0, arg1, arg2)
`setMacAddress`(self, arg0)
`setNetworkTimeout`(self, arg0)
`setStaticIPv4`(self, arg0, arg1, arg2)
`setUsbMaxSpeed`(self, arg0)
`setUsbTimeout`(self, arg0)
`toJson`(self)

Attributes:

`appMem`
`network`
`usb`

__init__(self: depthai.DeviceBootloader.Config) → None ¶

property appMem¶

fromJson(self: json) → depthai.DeviceBootloader.Config ¶

getDnsAltIPv4(self: depthai.DeviceBootloader.Config) → str ¶

getDnsIPv4(self: depthai.DeviceBootloader.Config) → str ¶

getIPv4(self: depthai.DeviceBootloader.Config) → str ¶

getIPv4Gateway(self: depthai.DeviceBootloader.Config) → str ¶

getIPv4Mask(self: depthai.DeviceBootloader.Config) → str ¶

getMacAddress(self: depthai.DeviceBootloader.Config) → str ¶

getNetworkTimeout(self: depthai.DeviceBootloader.Config) → datetime.timedelta ¶

getUsbMaxSpeed(self: depthai.DeviceBootloader.Config) → depthai.UsbSpeed ¶

getUsbTimeout(self: depthai.DeviceBootloader.Config) → datetime.timedelta ¶

isStaticIPV4(self: depthai.DeviceBootloader.Config) → bool ¶

property network¶

setDnsIPv4(self: depthai.DeviceBootloader.Config, arg0: str, arg1: str) → None ¶

setDynamicIPv4(self: depthai.DeviceBootloader.Config, arg0: str, arg1: str, arg2: str) → None ¶

setMacAddress(self: depthai.DeviceBootloader.Config, arg0: str) → None ¶

setNetworkTimeout(self: depthai.DeviceBootloader.Config, arg0: datetime.timedelta) → None ¶

setStaticIPv4(self: depthai.DeviceBootloader.Config, arg0: str, arg1: str, arg2: str) → None ¶

setUsbMaxSpeed(self: depthai.DeviceBootloader.Config, arg0: depthai.UsbSpeed) → None ¶

setUsbTimeout(self: depthai.DeviceBootloader.Config, arg0: datetime.timedelta) → None ¶

toJson(self: depthai.DeviceBootloader.Config) → json¶

property usb¶

class Memory¶

Bases: pybind11_builtins.pybind11_object

Members:

AUTO

FLASH

EMMC

Attributes:

`AUTO`
`EMMC`
`FLASH`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <Memory.AUTO: -1>¶

EMMC = <Memory.EMMC: 1>¶

FLASH = <Memory.FLASH: 0>¶

__init__(self: depthai.DeviceBootloader.Memory, value: int) → None ¶

property name¶

property value¶

class MemoryInfo¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`available`
`info`
`size`

__init__(self: depthai.DeviceBootloader.MemoryInfo) → None ¶

property available¶

property info¶

property size¶

class NetworkConfig¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`ipv4`
`ipv4Dns`
`ipv4DnsAlt`
`ipv4Gateway`
`ipv4Mask`
`ipv6`
`ipv6Dns`
`ipv6DnsAlt`
`ipv6Gateway`
`ipv6Prefix`
`mac`
`staticIpv4`
`staticIpv6`
`timeoutMs`

__init__(self: depthai.DeviceBootloader.NetworkConfig) → None ¶

property ipv4¶

property ipv4Dns¶

property ipv4DnsAlt¶

property ipv4Gateway¶

property ipv4Mask¶

property ipv6¶

property ipv6Dns¶

property ipv6DnsAlt¶

property ipv6Gateway¶

property ipv6Prefix¶

property mac¶

property staticIpv4¶

property staticIpv6¶

property timeoutMs¶

class Section¶

Bases: pybind11_builtins.pybind11_object

Members:

AUTO

HEADER

BOOTLOADER

BOOTLOADER_CONFIG

APPLICATION

Attributes:

`APPLICATION`
`AUTO`
`BOOTLOADER`
`BOOTLOADER_CONFIG`
`HEADER`
`name`
`value`

Methods:

__init__(self, value)

APPLICATION = <Section.APPLICATION: 3>¶

AUTO = <Section.AUTO: -1>¶

BOOTLOADER = <Section.BOOTLOADER: 1>¶

BOOTLOADER_CONFIG = <Section.BOOTLOADER_CONFIG: 2>¶

HEADER = <Section.HEADER: 0>¶

__init__(self: depthai.DeviceBootloader.Section, value: int) → None ¶

property name¶

property value¶

class Type¶

Bases: pybind11_builtins.pybind11_object

Members:

AUTO

USB

NETWORK

Attributes:

`AUTO`
`NETWORK`
`USB`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <Type.AUTO: -1>¶

NETWORK = <Type.NETWORK: 1>¶

USB = <Type.USB: 0>¶

__init__(self: depthai.DeviceBootloader.Type, value: int) → None ¶

property name¶

property value¶

class UsbConfig¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`maxUsbSpeed`
`pid`
`timeoutMs`
`vid`

__init__(self: depthai.DeviceBootloader.UsbConfig) → None ¶

property maxUsbSpeed¶

property pid¶

property timeoutMs¶

property vid¶

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.DeviceBootloader, devInfo: depthai.DeviceInfo, allowFlashingBootloader: bool = False) -> None
__init__(self: depthai.DeviceBootloader, devInfo: depthai.DeviceInfo, pathToCmd: Path, allowFlashingBootloader: bool = False) -> None
__init__(self: depthai.DeviceBootloader, nameOrDeviceId: str, allowFlashingBootloader: bool = False) -> None

bootMemory(self: depthai.DeviceBootloader, fw: list[int]) → None ¶

bootUsbRomBootloader(self: depthai.DeviceBootloader) → None ¶

close(self: depthai.DeviceBootloader) → None ¶: Closes the connection to device. Better alternative is the usage of context manager: with depthai.DeviceBootloader(deviceInfo) as bootloader:

static createDepthaiApplicationPackage(*args, **kwargs)¶

Overloaded function.

createDepthaiApplicationPackage(pipeline: depthai.Pipeline, pathToCmd: Path = ‘’, compress: bool = False, applicationName: str = ‘’, checkChecksum: bool = False) -> list[int]
createDepthaiApplicationPackage(pipeline: depthai.Pipeline, compress: bool, applicationName: str = ‘’, checkChecksum: bool = False) -> list[int]

flash(*args, **kwargs)¶

Overloaded function.

flash(self: depthai.DeviceBootloader, progressCallback: Callable[[float], None], pipeline: depthai.Pipeline, compress: bool = False, applicationName: str = ‘’, memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>, checkChecksum: bool = False) -> tuple[bool, str]
flash(self: depthai.DeviceBootloader, pipeline: depthai.Pipeline, compress: bool = False, applicationName: str = ‘’, memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>, checkChecksum: bool = False) -> tuple[bool, str]

flashBootHeader(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory, frequency: int = - 1, location: int = - 1, dummyCycles: int = - 1, offset: int = - 1) → tuple[bool, str]¶

flashBootloader(*args, **kwargs)¶

Overloaded function.

flashBootloader(self: depthai.DeviceBootloader, progressCallback: Callable[[float], None], path: Path = ‘’) -> tuple[bool, str]
flashBootloader(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory, type: depthai.DeviceBootloader.Type, progressCallback: Callable[[float], None], path: Path = ‘’) -> tuple[bool, str]

flashClear(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>) → tuple[bool, str]¶

flashConfig(self: depthai.DeviceBootloader, config: depthai.DeviceBootloader.Config, memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>, type: depthai.DeviceBootloader.Type = <Type.AUTO: -1>) → tuple[bool, str]¶

flashConfigClear(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>, type: depthai.DeviceBootloader.Type = <Type.AUTO: -1>) → tuple[bool, str]¶

flashConfigData(self: depthai.DeviceBootloader, configData: json, memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>, type: depthai.DeviceBootloader.Type = <Type.AUTO: -1>) → tuple[bool, str]¶

flashConfigFile(self: depthai.DeviceBootloader, configData: Path, memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>, type: depthai.DeviceBootloader.Type = <Type.AUTO: -1>) → tuple[bool, str]¶

flashCustom(*args, **kwargs)¶

Overloaded function.

flashCustom(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory, offset: int, data: list[int], progressCallback: Callable[[float], None] = None) -> tuple[bool, str]
flashCustom(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory, offset: int, filename: str, progressCallback: Callable[[float], None] = None) -> tuple[bool, str]

flashDepthaiApplicationPackage(*args, **kwargs)¶

Overloaded function.

flashDepthaiApplicationPackage(self: depthai.DeviceBootloader, progressCallback: Callable[[float], None], package: list[int], memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>) -> tuple[bool, str]
flashDepthaiApplicationPackage(self: depthai.DeviceBootloader, package: list[int], memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>) -> tuple[bool, str]

flashFastBootHeader(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory, frequency: int = - 1, location: int = - 1, dummyCycles: int = - 1, offset: int = - 1) → tuple[bool, str]¶

flashGpioModeBootHeader(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory, mode: int) → tuple[bool, str]¶

flashUsbRecoveryBootHeader(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory) → tuple[bool, str]¶

flashUserBootloader(self: depthai.DeviceBootloader, progressCallback: Callable[[float], None], path: Path = '') → tuple[bool, str]¶

static getAllAvailableDevices() → list[depthai.DeviceInfo]¶

static getEmbeddedBootloaderBinary(arg0: depthai.DeviceBootloader.Type) → list[int]¶

static getEmbeddedBootloaderVersion() → depthai.Version ¶

static getFirstAvailableDevice() → tuple[bool, depthai.DeviceInfo]¶

getFlashedVersion(self: depthai.DeviceBootloader) → Optional[depthai.Version]¶

getMemoryInfo(self: depthai.DeviceBootloader, arg0: depthai.DeviceBootloader.Memory) → depthai.DeviceBootloader.MemoryInfo ¶

getType(self: depthai.DeviceBootloader) → depthai.DeviceBootloader.Type ¶

getVersion(self: depthai.DeviceBootloader) → depthai.Version ¶

isAllowedFlashingBootloader(self: depthai.DeviceBootloader) → bool ¶

isEmbeddedVersion(self: depthai.DeviceBootloader) → bool ¶

isUserBootloader(self: depthai.DeviceBootloader) → bool ¶

isUserBootloaderSupported(self: depthai.DeviceBootloader) → bool ¶

readApplicationInfo(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory) → depthai.DeviceBootloader.ApplicationInfo ¶

readConfig(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>, type: depthai.DeviceBootloader.Type = <Type.AUTO: -1>) → depthai.DeviceBootloader.Config ¶

readConfigData(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory = <Memory.AUTO: -1>, type: depthai.DeviceBootloader.Type = <Type.AUTO: -1>) → json¶

readCustom(*args, **kwargs)¶

Overloaded function.

readCustom(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory, offset: int, size: int, filename: str, progressCallback: Callable[[float], None] = None) -> tuple[bool, str]
readCustom(self: depthai.DeviceBootloader, memory: depthai.DeviceBootloader.Memory, offset: int, size: int, progressCallback: Callable[[float], None] = None) -> tuple[bool, str, list[int]]

static saveDepthaiApplicationPackage(*args, **kwargs)¶

Overloaded function.

saveDepthaiApplicationPackage(path: Path, pipeline: depthai.Pipeline, pathToCmd: Path = ‘’, compress: bool = False, applicationName: str = ‘’, checkChecksum: bool = False) -> None
saveDepthaiApplicationPackage(path: Path, pipeline: depthai.Pipeline, compress: bool, applicationName: str = ‘’, checkChecksum: bool = False) -> None

class depthai.DeviceDesc¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`mxid`
`name`
`platform`
`protocol`
`state`
`status`

__init__(self: depthai.DeviceDesc) → None ¶

property mxid¶

property name¶

property platform¶

property protocol¶

property state¶

property status¶

class depthai.DeviceInfo¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(args, *kwargs)	Overloaded function.
`getMxId`(self)
`getXLinkDeviceDesc`(self)

Attributes:

`desc`
`mxid`
`name`
`platform`
`protocol`
`state`
`status`

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.DeviceInfo) -> None
__init__(self: depthai.DeviceInfo, name: str, mxid: str, state: depthai.XLinkDeviceState, protocol: depthai.XLinkProtocol, platform: depthai.XLinkPlatform, status: depthai.XLinkError_t) -> None
__init__(self: depthai.DeviceInfo, mxidOrName: str) -> None
__init__(self: depthai.DeviceInfo, arg0: depthai.DeviceDesc) -> None

property desc¶

getMxId(self: depthai.DeviceInfo) → str ¶

getXLinkDeviceDesc(self: depthai.DeviceInfo) → depthai.DeviceDesc ¶

property mxid¶

property name¶

property platform¶

property protocol¶

property state¶

property status¶

class depthai.EdgeDetectorConfig¶

Bases: depthai.Buffer

Methods:

`__init__`(self)
`get`(self)
`getConfigData`(self)
`set`(self, config)
`setSobelFilterKernels`(self, …)

__init__(self: depthai.EdgeDetectorConfig) → None ¶

get(self: depthai.EdgeDetectorConfig) → depthai.RawEdgeDetectorConfig ¶

getConfigData(self: depthai.EdgeDetectorConfig) → depthai.EdgeDetectorConfigData ¶

set(self: depthai.EdgeDetectorConfig, config: depthai.RawEdgeDetectorConfig) → depthai.EdgeDetectorConfig ¶

setSobelFilterKernels(self: depthai.EdgeDetectorConfig, horizontalKernel: list[list[int]], verticalKernel: list[list[int]]) → None ¶

class depthai.EdgeDetectorConfigData¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`sobelFilterHorizontalKernel`
`sobelFilterVerticalKernel`

__init__(self: depthai.EdgeDetectorConfigData) → None ¶

property sobelFilterHorizontalKernel¶

property sobelFilterVerticalKernel¶

class depthai.EdgeDetectorProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`initialConfig`
`numFramesPool`
`outputFrameSize`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property initialConfig¶

property numFramesPool¶

property outputFrameSize¶

class depthai.EepromData¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`batchName`
`batchTime`
`boardConf`
`boardCustom`
`boardName`
`boardOptions`
`boardRev`
`cameraData`
`deviceName`
`hardwareConf`
`housingExtrinsics`
`imuExtrinsics`
`miscellaneousData`
`productName`
`stereoEnableDistortionCorrection`
`stereoRectificationData`
`stereoUseSpecTranslation`
`version`
`verticalCameraSocket`

__init__(self: depthai.EepromData) → None ¶

property batchName¶

property batchTime¶

property boardConf¶

property boardCustom¶

property boardName¶

property boardOptions¶

property boardRev¶

property cameraData¶

property deviceName¶

property hardwareConf¶

property housingExtrinsics¶

property imuExtrinsics¶

property miscellaneousData¶

property productName¶

property stereoEnableDistortionCorrection¶

property stereoRectificationData¶

property stereoUseSpecTranslation¶

property version¶

property verticalCameraSocket¶

exception depthai.EepromError¶: Bases: RuntimeError

class depthai.EncodedFrame¶

Bases: depthai.Buffer

Classes:

`FrameType`	Members:
`Profile`	Members:

Methods:

`__init__`(self)
`getBitrate`(self)
`getColorTemperature`(self)
`getExposureTime`(self)
`getFrameType`(self)
`getInstanceNum`(self)
`getLensPosition`(self)
`getLensPositionRaw`(self)
`getLossless`(self)
`getProfile`(self)
`getQuality`(self)
`getSensitivity`(self)
`getSequenceNum`(self)
`getTimestamp`(self)
`getTimestampDevice`(self)
`setBitrate`(self, arg0)
`setFrameType`(self, arg0)
`setLossless`(self, arg0)
`setProfile`(self, arg0)
`setQuality`(self, arg0)
`setSequenceNum`(self, arg0)
`setTimestamp`(self, arg0)
`setTimestampDevice`(self, arg0)

class FrameType¶

Bases: pybind11_builtins.pybind11_object

Members:

I

P

B

Unknown

Attributes:

`B`
`I`
`P`
`Unknown`
`name`
`value`

Methods:

__init__(self, value)

B = <FrameType.B: 2>¶

I = <FrameType.I: 0>¶

P = <FrameType.P: 1>¶

Unknown = <FrameType.Unknown: 3>¶

__init__(self: depthai.RawEncodedFrame.FrameType, value: int) → None ¶

property name¶

property value¶

class Profile¶

Bases: pybind11_builtins.pybind11_object

Members:

JPEG

AVC

HEVC

Attributes:

`AVC`
`HEVC`
`JPEG`
`name`
`value`

Methods:

__init__(self, value)

AVC = <Profile.AVC: 1>¶

HEVC = <Profile.HEVC: 2>¶

JPEG = <Profile.JPEG: 0>¶

__init__(self: depthai.RawEncodedFrame.Profile, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.EncodedFrame) → None ¶

getBitrate(self: depthai.EncodedFrame) → int ¶

getColorTemperature(self: depthai.EncodedFrame) → int ¶

getExposureTime(self: depthai.EncodedFrame) → datetime.timedelta ¶

getFrameType(self: depthai.EncodedFrame) → depthai.RawEncodedFrame.FrameType ¶

getInstanceNum(self: depthai.EncodedFrame) → int ¶

getLensPosition(self: depthai.EncodedFrame) → int ¶

getLensPositionRaw(self: depthai.EncodedFrame) → float ¶

getLossless(self: depthai.EncodedFrame) → bool ¶

getProfile(self: depthai.EncodedFrame) → depthai.RawEncodedFrame.Profile ¶

getQuality(self: depthai.EncodedFrame) → int ¶

getSensitivity(self: depthai.EncodedFrame) → int ¶

getSequenceNum(self: depthai.EncodedFrame) → int ¶

getTimestamp(self: depthai.EncodedFrame) → datetime.timedelta ¶

getTimestampDevice(self: depthai.EncodedFrame) → datetime.timedelta ¶

setBitrate(self: depthai.EncodedFrame, arg0: int) → depthai.EncodedFrame ¶

setFrameType(self: depthai.EncodedFrame, arg0: depthai.RawEncodedFrame.FrameType) → depthai.EncodedFrame ¶

setLossless(self: depthai.EncodedFrame, arg0: bool) → depthai.EncodedFrame ¶

setProfile(self: depthai.EncodedFrame, arg0: depthai.RawEncodedFrame.Profile) → depthai.EncodedFrame ¶

setQuality(self: depthai.EncodedFrame, arg0: int) → depthai.EncodedFrame ¶

setSequenceNum(self: depthai.EncodedFrame, arg0: int) → depthai.EncodedFrame ¶

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

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

class depthai.Extrinsics¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`rotationMatrix`
`specTranslation`
`toCameraSocket`
`translation`

__init__(self: depthai.Extrinsics) → None ¶

property rotationMatrix¶

property specTranslation¶

property toCameraSocket¶

property translation¶

class depthai.FeatureTrackerConfig¶

Bases: depthai.Buffer

Classes:

`CornerDetector`
`FeatureMaintainer`
`MotionEstimator`

Methods:

`__init__`(args, *kwargs)	Overloaded function.
`get`(self)
`set`(self, config)
`setCornerDetector`(args, *kwargs)	Overloaded function.
`setFeatureMaintainer`(args, *kwargs)	Overloaded function.
`setHwMotionEstimation`(self)
`setMotionEstimator`(args, *kwargs)	Overloaded function.
`setNumTargetFeatures`(self, numTargetFeatures)
`setOpticalFlow`(args, *kwargs)	Overloaded function.

class CornerDetector¶

Bases: pybind11_builtins.pybind11_object

Classes:

`Thresholds`
`Type`	Members:

Methods:

__init__(self)

Attributes:

`cellGridDimension`
`enableSobel`
`enableSorting`
`numMaxFeatures`
`numTargetFeatures`
`thresholds`
`type`

class Thresholds¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`decreaseFactor`
`increaseFactor`
`initialValue`
`max`
`min`

__init__(self: depthai.RawFeatureTrackerConfig.CornerDetector.Thresholds) → None ¶

property decreaseFactor¶

property increaseFactor¶

property initialValue¶

property max¶

property min¶

class Type¶

Bases: pybind11_builtins.pybind11_object

Members:

HARRIS

SHI_THOMASI

Attributes:

`HARRIS`
`SHI_THOMASI`
`name`
`value`

Methods:

__init__(self, value)

HARRIS = <Type.HARRIS: 0>¶

SHI_THOMASI = <Type.SHI_THOMASI: 1>¶

__init__(self: depthai.RawFeatureTrackerConfig.CornerDetector.Type, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.RawFeatureTrackerConfig.CornerDetector) → None ¶

property cellGridDimension¶

property enableSobel¶

property enableSorting¶

property numMaxFeatures¶

property numTargetFeatures¶

property thresholds¶

property type¶

class FeatureMaintainer¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`enable`
`lostFeatureErrorThreshold`
`minimumDistanceBetweenFeatures`
`trackedFeatureThreshold`

__init__(self: depthai.RawFeatureTrackerConfig.FeatureMaintainer) → None ¶

property enable¶

property lostFeatureErrorThreshold¶

property minimumDistanceBetweenFeatures¶

property trackedFeatureThreshold¶

class MotionEstimator¶

Bases: pybind11_builtins.pybind11_object

Classes:

`OpticalFlow`
`Type`	Members:

Methods:

__init__(self)

Attributes:

`enable`
`opticalFlow`
`type`

class OpticalFlow¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`epsilon`
`maxIterations`
`pyramidLevels`
`searchWindowHeight`
`searchWindowWidth`

__init__(self: depthai.RawFeatureTrackerConfig.MotionEstimator.OpticalFlow) → None ¶

property epsilon¶

property maxIterations¶

property pyramidLevels¶

property searchWindowHeight¶

property searchWindowWidth¶

class Type¶

Bases: pybind11_builtins.pybind11_object

Members:

LUCAS_KANADE_OPTICAL_FLOW

HW_MOTION_ESTIMATION

Attributes:

`HW_MOTION_ESTIMATION`
`LUCAS_KANADE_OPTICAL_FLOW`
`name`
`value`

Methods:

__init__(self, value)

HW_MOTION_ESTIMATION = <Type.HW_MOTION_ESTIMATION: 1>¶

LUCAS_KANADE_OPTICAL_FLOW = <Type.LUCAS_KANADE_OPTICAL_FLOW: 0>¶

__init__(self: depthai.RawFeatureTrackerConfig.MotionEstimator.Type, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.RawFeatureTrackerConfig.MotionEstimator) → None ¶

property enable¶

property opticalFlow¶

property type¶

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.FeatureTrackerConfig) -> None
__init__(self: depthai.FeatureTrackerConfig, arg0: depthai.RawFeatureTrackerConfig) -> None

get(self: depthai.FeatureTrackerConfig) → depthai.RawFeatureTrackerConfig ¶

set(self: depthai.FeatureTrackerConfig, config: depthai.RawFeatureTrackerConfig) → depthai.FeatureTrackerConfig ¶

setCornerDetector(*args, **kwargs)¶

Overloaded function.

setCornerDetector(self: depthai.FeatureTrackerConfig, cornerDetector: depthai.RawFeatureTrackerConfig.CornerDetector.Type) -> depthai.FeatureTrackerConfig
setCornerDetector(self: depthai.FeatureTrackerConfig, config: depthai.RawFeatureTrackerConfig.CornerDetector) -> depthai.FeatureTrackerConfig

setFeatureMaintainer(*args, **kwargs)¶

Overloaded function.

setFeatureMaintainer(self: depthai.FeatureTrackerConfig, enable: bool) -> depthai.FeatureTrackerConfig
setFeatureMaintainer(self: depthai.FeatureTrackerConfig, config: depthai.RawFeatureTrackerConfig.FeatureMaintainer) -> depthai.FeatureTrackerConfig

setHwMotionEstimation(self: depthai.FeatureTrackerConfig) → depthai.FeatureTrackerConfig ¶

setMotionEstimator(*args, **kwargs)¶

Overloaded function.

setMotionEstimator(self: depthai.FeatureTrackerConfig, enable: bool) -> depthai.FeatureTrackerConfig
setMotionEstimator(self: depthai.FeatureTrackerConfig, config: depthai.RawFeatureTrackerConfig.MotionEstimator) -> depthai.FeatureTrackerConfig

setNumTargetFeatures(self: depthai.FeatureTrackerConfig, numTargetFeatures: int) → depthai.FeatureTrackerConfig ¶

setOpticalFlow(*args, **kwargs)¶

Overloaded function.

setOpticalFlow(self: depthai.FeatureTrackerConfig) -> depthai.FeatureTrackerConfig
setOpticalFlow(self: depthai.FeatureTrackerConfig, config: depthai.RawFeatureTrackerConfig.MotionEstimator.OpticalFlow) -> depthai.FeatureTrackerConfig

class depthai.FeatureTrackerProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`initialConfig`
`numMemorySlices`
`numShaves`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property initialConfig¶

property numMemorySlices¶

property numShaves¶

class depthai.FrameEvent¶

Bases: pybind11_builtins.pybind11_object

Members:

NONE

READOUT_START

READOUT_END

Attributes:

`NONE`
`READOUT_END`
`READOUT_START`
`name`
`value`

Methods:

__init__(self, value)

NONE = <FrameEvent.NONE: 0>¶

READOUT_END = <FrameEvent.READOUT_END: 2>¶

READOUT_START = <FrameEvent.READOUT_START: 1>¶

__init__(self: depthai.FrameEvent, value: int) → None ¶

property name¶

property value¶

class depthai.GlobalProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`cameraTuningBlobSize`
`cameraTuningBlobUri`
`leonOsFrequencyHz`
`leonRtFrequencyHz`
`pipelineName`
`pipelineVersion`
`sippBufferSize`
`sippDmaBufferSize`
`xlinkChunkSize`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property cameraTuningBlobSize¶

property cameraTuningBlobUri¶

property leonOsFrequencyHz¶

property leonRtFrequencyHz¶

property pipelineName¶

property pipelineVersion¶

property sippBufferSize¶

property sippDmaBufferSize¶

property xlinkChunkSize¶

class depthai.IMUData¶

Bases: depthai.Buffer

Methods:

__init__(self)

Attributes:

packets

__init__(self: depthai.IMUData) → None ¶

property packets¶

class depthai.IMUPacket¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`acceleroMeter`
`gyroscope`
`magneticField`
`rotationVector`

__init__(self: depthai.IMUPacket) → None ¶

property acceleroMeter¶

property gyroscope¶

property magneticField¶

property rotationVector¶

class depthai.IMUProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`batchReportThreshold`
`enableFirmwareUpdate`
`imuSensors`
`maxBatchReports`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property batchReportThreshold¶

property enableFirmwareUpdate¶

property imuSensors¶

property maxBatchReports¶

class depthai.IMUReport¶

Bases: pybind11_builtins.pybind11_object

Classes:

Accuracy

Members:

Methods:

`__init__`(self)
`getSequenceNum`(self)
`getTimestamp`(self)
`getTimestampDevice`(self)

Attributes:

`accuracy`
`sequence`
`timestamp`
`tsDevice`

class Accuracy¶

Bases: pybind11_builtins.pybind11_object

Members:

UNRELIABLE

LOW

MEDIUM

HIGH

Attributes:

`HIGH`
`LOW`
`MEDIUM`
`UNRELIABLE`
`name`
`value`

Methods:

__init__(self, value)

HIGH = <Accuracy.HIGH: 3>¶

LOW = <Accuracy.LOW: 1>¶

MEDIUM = <Accuracy.MEDIUM: 2>¶

UNRELIABLE = <Accuracy.UNRELIABLE: 0>¶

__init__(self: depthai.IMUReport.Accuracy, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.IMUReport) → None ¶

property accuracy¶

getSequenceNum(self: depthai.IMUReport) → int ¶

getTimestamp(self: depthai.IMUReport) → datetime.timedelta ¶

getTimestampDevice(self: depthai.IMUReport) → datetime.timedelta ¶

property sequence¶

property timestamp¶

property tsDevice¶

class depthai.IMUReportAccelerometer¶

Bases: depthai.IMUReport

Methods:

__init__(self)

Attributes:

`x`
`y`
`z`

__init__(self: depthai.IMUReportAccelerometer) → None ¶

property x¶

property y¶

property z¶

class depthai.IMUReportGyroscope¶

Bases: depthai.IMUReport

Methods:

__init__(self)

Attributes:

`x`
`y`
`z`

__init__(self: depthai.IMUReportGyroscope) → None ¶

property x¶

property y¶

property z¶

class depthai.IMUReportMagneticField¶

Bases: depthai.IMUReport

Methods:

__init__(self)

Attributes:

`x`
`y`
`z`

__init__(self: depthai.IMUReportMagneticField) → None ¶

property x¶

property y¶

property z¶

class depthai.IMUReportRotationVectorWAcc¶

Bases: depthai.IMUReport

Methods:

__init__(self)

Attributes:

`i`
`j`
`k`
`real`
`rotationVectorAccuracy`

__init__(self: depthai.IMUReportRotationVectorWAcc) → None ¶

property i¶

property j¶

property k¶

property real¶

property rotationVectorAccuracy¶

class depthai.IMUSensor¶

Bases: pybind11_builtins.pybind11_object

Members:

ACCELEROMETER_RAW

ACCELEROMETER

LINEAR_ACCELERATION

GRAVITY

GYROSCOPE_RAW

GYROSCOPE_CALIBRATED

GYROSCOPE_UNCALIBRATED

MAGNETOMETER_RAW

MAGNETOMETER_CALIBRATED

MAGNETOMETER_UNCALIBRATED

ROTATION_VECTOR

GAME_ROTATION_VECTOR

GEOMAGNETIC_ROTATION_VECTOR

ARVR_STABILIZED_ROTATION_VECTOR

ARVR_STABILIZED_GAME_ROTATION_VECTOR

Attributes:

`ACCELEROMETER`
`ACCELEROMETER_RAW`
`ARVR_STABILIZED_GAME_ROTATION_VECTOR`
`ARVR_STABILIZED_ROTATION_VECTOR`
`GAME_ROTATION_VECTOR`
`GEOMAGNETIC_ROTATION_VECTOR`
`GRAVITY`
`GYROSCOPE_CALIBRATED`
`GYROSCOPE_RAW`
`GYROSCOPE_UNCALIBRATED`
`LINEAR_ACCELERATION`
`MAGNETOMETER_CALIBRATED`
`MAGNETOMETER_RAW`
`MAGNETOMETER_UNCALIBRATED`
`ROTATION_VECTOR`
`name`
`value`

Methods:

__init__(self, value)

ACCELEROMETER = <IMUSensor.ACCELEROMETER: 1>¶

ACCELEROMETER_RAW = <IMUSensor.ACCELEROMETER_RAW: 20>¶

ARVR_STABILIZED_GAME_ROTATION_VECTOR = <IMUSensor.ARVR_STABILIZED_GAME_ROTATION_VECTOR: 41>¶

ARVR_STABILIZED_ROTATION_VECTOR = <IMUSensor.ARVR_STABILIZED_ROTATION_VECTOR: 40>¶

GAME_ROTATION_VECTOR = <IMUSensor.GAME_ROTATION_VECTOR: 8>¶

GEOMAGNETIC_ROTATION_VECTOR = <IMUSensor.GEOMAGNETIC_ROTATION_VECTOR: 9>¶

GRAVITY = <IMUSensor.GRAVITY: 6>¶

GYROSCOPE_CALIBRATED = <IMUSensor.GYROSCOPE_CALIBRATED: 2>¶

GYROSCOPE_RAW = <IMUSensor.GYROSCOPE_RAW: 21>¶

GYROSCOPE_UNCALIBRATED = <IMUSensor.GYROSCOPE_UNCALIBRATED: 7>¶

LINEAR_ACCELERATION = <IMUSensor.LINEAR_ACCELERATION: 4>¶

MAGNETOMETER_CALIBRATED = <IMUSensor.MAGNETOMETER_CALIBRATED: 3>¶

MAGNETOMETER_RAW = <IMUSensor.MAGNETOMETER_RAW: 22>¶

MAGNETOMETER_UNCALIBRATED = <IMUSensor.MAGNETOMETER_UNCALIBRATED: 15>¶

ROTATION_VECTOR = <IMUSensor.ROTATION_VECTOR: 5>¶

__init__(self: depthai.IMUSensor, value: int) → None ¶

property name¶

property value¶

class depthai.IMUSensorConfig¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`changeSensitivity`
`reportRate`
`sensitivityEnabled`
`sensitivityRelative`
`sensorId`

__init__(self: depthai.IMUSensorConfig) → None ¶

property changeSensitivity¶

property reportRate¶

property sensitivityEnabled¶

property sensitivityRelative¶

property sensorId¶

class depthai.ImageAlignConfig¶

Bases: depthai.Buffer

Methods:

`__init__`(self)
`get`(self)
`set`(self, config)

__init__(self: depthai.ImageAlignConfig) → None ¶

get(self: depthai.ImageAlignConfig) → depthai.RawImageAlignConfig ¶

set(self: depthai.ImageAlignConfig, config: depthai.RawImageAlignConfig) → depthai.ImageAlignConfig ¶

class depthai.ImageAlignProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`alignHeight`
`alignWidth`
`initialConfig`
`interpolation`
`numFramesPool`
`numShaves`
`outKeepAspectRatio`
`warpHwIds`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property alignHeight¶

property alignWidth¶

property initialConfig¶

property interpolation¶

property numFramesPool¶

property numShaves¶

property outKeepAspectRatio¶

property warpHwIds¶

class depthai.ImageManipConfig¶

Bases: depthai.Buffer

Methods:

`__init__`(self)
`get`(self)
`getColormap`(self)
`getCropConfig`(self)
`getCropXMax`(self)
`getCropXMin`(self)
`getCropYMax`(self)
`getCropYMin`(self)
`getFormatConfig`(self)
`getInterpolation`(self)
`getResizeConfig`(self)
`getResizeHeight`(self)
`getResizeWidth`(self)
`isResizeThumbnail`(self)
`set`(self, config)
`setCenterCrop`(self, ratio, whRatio)
`setColormap`(args, *kwargs)	Overloaded function.
`setCropRect`(args, *kwargs)	Overloaded function.
`setCropRotatedRect`(self, rr, normalizedCoords)
`setFrameType`(self, type)
`setHorizontalFlip`(self, flip)
`setInterpolation`(self, interpolation)
`setKeepAspectRatio`(self, keep)
`setResize`(args, *kwargs)	Overloaded function.
`setResizeThumbnail`(args, *kwargs)	Overloaded function.
`setReusePreviousImage`(self, reuse)
`setRotationDegrees`(self, deg)
`setRotationRadians`(self, rad)
`setSkipCurrentImage`(self, skip)
`setVerticalFlip`(self, flip)
`setWarpBorderFillColor`(self, red, green, blue)
`setWarpBorderReplicatePixels`(self)
`setWarpTransformFourPoints`(self, pt, …)
`setWarpTransformMatrix3x3`(self, mat)

__init__(self: depthai.ImageManipConfig) → None ¶

get(self: depthai.ImageManipConfig) → depthai.RawImageManipConfig ¶

getColormap(self: depthai.ImageManipConfig) → depthai.Colormap ¶

getCropConfig(self: depthai.ImageManipConfig) → depthai.RawImageManipConfig.CropConfig ¶

getCropXMax(self: depthai.ImageManipConfig) → float ¶

getCropXMin(self: depthai.ImageManipConfig) → float ¶

getCropYMax(self: depthai.ImageManipConfig) → float ¶

getCropYMin(self: depthai.ImageManipConfig) → float ¶

getFormatConfig(self: depthai.ImageManipConfig) → depthai.RawImageManipConfig.FormatConfig ¶

getInterpolation(self: depthai.ImageManipConfig) → depthai.Interpolation ¶

getResizeConfig(self: depthai.ImageManipConfig) → depthai.RawImageManipConfig.ResizeConfig ¶

getResizeHeight(self: depthai.ImageManipConfig) → int ¶

getResizeWidth(self: depthai.ImageManipConfig) → int ¶

isResizeThumbnail(self: depthai.ImageManipConfig) → bool ¶

set(self: depthai.ImageManipConfig, config: depthai.RawImageManipConfig) → depthai.ImageManipConfig ¶

setCenterCrop(self: depthai.ImageManipConfig, ratio: float, whRatio: float = 1.0) → depthai.ImageManipConfig ¶

setColormap(*args, **kwargs)¶

Overloaded function.

setColormap(self: depthai.ImageManipConfig, colormap: depthai.Colormap, min: int, max: int) -> depthai.ImageManipConfig
setColormap(self: depthai.ImageManipConfig, colormap: depthai.Colormap, max: int = 255) -> depthai.ImageManipConfig
setColormap(self: depthai.ImageManipConfig, colormap: depthai.Colormap, max: float = 255.0) -> depthai.ImageManipConfig

setCropRect(*args, **kwargs)¶

Overloaded function.

setCropRect(self: depthai.ImageManipConfig, xmin: float, ymin: float, xmax: float, ymax: float) -> depthai.ImageManipConfig
setCropRect(self: depthai.ImageManipConfig, coordinates: tuple[float, float, float, float]) -> depthai.ImageManipConfig

setCropRotatedRect(self: depthai.ImageManipConfig, rr: depthai.RotatedRect, normalizedCoords: bool = True) → depthai.ImageManipConfig ¶

setFrameType(self: depthai.ImageManipConfig, type: depthai.RawImgFrame.Type) → depthai.ImageManipConfig ¶

setHorizontalFlip(self: depthai.ImageManipConfig, flip: bool) → depthai.ImageManipConfig ¶

setInterpolation(self: depthai.ImageManipConfig, interpolation: depthai.Interpolation) → depthai.ImageManipConfig ¶

setKeepAspectRatio(self: depthai.ImageManipConfig, keep: bool) → depthai.ImageManipConfig ¶

setResize(*args, **kwargs)¶

Overloaded function.

setResize(self: depthai.ImageManipConfig, w: int, h: int) -> depthai.ImageManipConfig
setResize(self: depthai.ImageManipConfig, size: tuple[int, int]) -> depthai.ImageManipConfig

setResizeThumbnail(*args, **kwargs)¶

Overloaded function.

setResizeThumbnail(self: depthai.ImageManipConfig, w: int, h: int, bgRed: int = 0, bgGreen: int = 0, bgBlue: int = 0) -> depthai.ImageManipConfig
setResizeThumbnail(self: depthai.ImageManipConfig, size: tuple[int, int], bgRed: int = 0, bgGreen: int = 0, bgBlue: int = 0) -> depthai.ImageManipConfig

setReusePreviousImage(self: depthai.ImageManipConfig, reuse: bool) → depthai.ImageManipConfig ¶

setRotationDegrees(self: depthai.ImageManipConfig, deg: float) → depthai.ImageManipConfig ¶

setRotationRadians(self: depthai.ImageManipConfig, rad: float) → depthai.ImageManipConfig ¶

setSkipCurrentImage(self: depthai.ImageManipConfig, skip: bool) → depthai.ImageManipConfig ¶

setVerticalFlip(self: depthai.ImageManipConfig, flip: bool) → None ¶

setWarpBorderFillColor(self: depthai.ImageManipConfig, red: int, green: int, blue: int) → depthai.ImageManipConfig ¶

setWarpBorderReplicatePixels(self: depthai.ImageManipConfig) → depthai.ImageManipConfig ¶

setWarpTransformFourPoints(self: depthai.ImageManipConfig, pt: list[depthai.Point2f], normalizedCoords: bool) → depthai.ImageManipConfig ¶

setWarpTransformMatrix3x3(self: depthai.ImageManipConfig, mat: list[float]) → depthai.ImageManipConfig ¶

class depthai.ImgDetection¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`confidence`
`label`
`xmax`
`xmin`
`ymax`
`ymin`

__init__(self: depthai.ImgDetection) → None ¶

property confidence¶

property label¶

property xmax¶

property xmin¶

property ymax¶

property ymin¶

class depthai.ImgDetections¶

Bases: depthai.Buffer

Methods:

`__init__`(self)
`getSequenceNum`(self)
`getTimestamp`(self)
`getTimestampDevice`(self)
`setSequenceNum`(self, arg0)
`setTimestamp`(self, arg0)
`setTimestampDevice`(self, arg0)

Attributes:

detections

__init__(self: depthai.ImgDetections) → None ¶

property detections¶

getSequenceNum(self: depthai.ImgDetections) → int ¶

getTimestamp(self: depthai.ImgDetections) → datetime.timedelta ¶

getTimestampDevice(self: depthai.ImgDetections) → datetime.timedelta ¶

setSequenceNum(self: depthai.ImgDetections, arg0: int) → depthai.ImgDetections ¶

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

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

class depthai.ImgFrame¶

Bases: depthai.Buffer

Classes:

`Specs`
`Type`	Members:

Methods:

`__init__`(self)
`getCategory`(self)
`getColorTemperature`(self)
`getCvFrame`(self)	Returns BGR or grayscale frame compatible with use in other opencv functions
`getExposureTime`(self)
`getFrame`(self, copy)	Returns numpy array with shape as specified by width, height and type
`getHeight`(self)
`getInstanceNum`(self)
`getLensPosition`(self)
`getLensPositionRaw`(self)
`getSensitivity`(self)
`getSequenceNum`(self)
`getTimestamp`(args, *kwargs)	Overloaded function.
`getTimestampDevice`(args, *kwargs)	Overloaded function.
`getType`(self)
`getWidth`(self)
`setCategory`(self, category)
`setFrame`(self, array)	Copies array bytes to ImgFrame buffer
`setHeight`(self, height)
`setInstanceNum`(self, instance)
`setSequenceNum`(self, seq)
`setSize`(args, *kwargs)	Overloaded function.
`setTimestamp`(self, timestamp)
`setTimestampDevice`(self, arg0)
`setType`(self, type)
`setWidth`(self, width)

class Specs¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`bytesPP`
`height`
`p1Offset`
`p2Offset`
`p3Offset`
`stride`
`type`
`width`

__init__(self: depthai.RawImgFrame.Specs) → None ¶

property bytesPP¶

property height¶

property p1Offset¶

property p2Offset¶

property p3Offset¶

property stride¶

property type¶

property width¶

class Type¶

Bases: pybind11_builtins.pybind11_object

Members:

YUV422i

YUV444p

YUV420p

YUV422p

YUV400p

RGBA8888

RGB161616

RGB888p

BGR888p

RGB888i

BGR888i

RGBF16F16F16p

BGRF16F16F16p

RGBF16F16F16i

BGRF16F16F16i

GRAY8

GRAYF16

LUT2

LUT4

LUT16

RAW16

RAW14

RAW12

RAW10

RAW8

PACK10

PACK12

YUV444i

NV12

NV21

BITSTREAM

HDR

NONE

Attributes:

Methods:

__init__(self, value)

BGR888i = <Type.BGR888i: 10>¶

BGR888p = <Type.BGR888p: 8>¶

BGRF16F16F16i = <Type.BGRF16F16F16i: 29>¶

BGRF16F16F16p = <Type.BGRF16F16F16p: 27>¶

BITSTREAM = <Type.BITSTREAM: 24>¶

GRAY8 = <Type.GRAY8: 30>¶

GRAYF16 = <Type.GRAYF16: 31>¶

HDR = <Type.HDR: 25>¶

LUT16 = <Type.LUT16: 13>¶

LUT2 = <Type.LUT2: 11>¶

LUT4 = <Type.LUT4: 12>¶

NONE = <Type.NONE: 32>¶

NV12 = <Type.NV12: 22>¶

NV21 = <Type.NV21: 23>¶

PACK10 = <Type.PACK10: 19>¶

PACK12 = <Type.PACK12: 20>¶

RAW10 = <Type.RAW10: 17>¶

RAW12 = <Type.RAW12: 16>¶

RAW14 = <Type.RAW14: 15>¶

RAW16 = <Type.RAW16: 14>¶

RAW8 = <Type.RAW8: 18>¶

RGB161616 = <Type.RGB161616: 6>¶

RGB888i = <Type.RGB888i: 9>¶

RGB888p = <Type.RGB888p: 7>¶

RGBA8888 = <Type.RGBA8888: 5>¶

RGBF16F16F16i = <Type.RGBF16F16F16i: 28>¶

RGBF16F16F16p = <Type.RGBF16F16F16p: 26>¶

YUV400p = <Type.YUV400p: 4>¶

YUV420p = <Type.YUV420p: 2>¶

YUV422i = <Type.YUV422i: 0>¶

YUV422p = <Type.YUV422p: 3>¶

YUV444i = <Type.YUV444i: 21>¶

YUV444p = <Type.YUV444p: 1>¶

__init__(self: depthai.RawImgFrame.Type, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.ImgFrame) → None ¶

getCategory(self: depthai.ImgFrame) → int ¶

getColorTemperature(self: depthai.ImgFrame) → int ¶

getCvFrame(self: object) → object ¶: Returns BGR or grayscale frame compatible with use in other opencv functions

getExposureTime(self: depthai.ImgFrame) → datetime.timedelta ¶

getFrame(self: object, copy: bool = False) → numpy.ndarray¶: Returns numpy array with shape as specified by width, height and type

getHeight(self: depthai.ImgFrame) → int ¶

getInstanceNum(self: depthai.ImgFrame) → int ¶

getLensPosition(self: depthai.ImgFrame) → int ¶

getLensPositionRaw(self: depthai.ImgFrame) → float ¶

getSensitivity(self: depthai.ImgFrame) → int ¶

getSequenceNum(self: depthai.ImgFrame) → int ¶

getTimestamp(*args, **kwargs)¶

Overloaded function.

getTimestamp(self: depthai.ImgFrame) -> datetime.timedelta
getTimestamp(self: depthai.ImgFrame, offset: depthai.CameraExposureOffset) -> datetime.timedelta

getTimestampDevice(*args, **kwargs)¶

Overloaded function.

getTimestampDevice(self: depthai.ImgFrame) -> datetime.timedelta
getTimestampDevice(self: depthai.ImgFrame, offset: depthai.CameraExposureOffset) -> datetime.timedelta

getType(self: depthai.ImgFrame) → depthai.RawImgFrame.Type ¶

getWidth(self: depthai.ImgFrame) → int ¶

setCategory(self: depthai.ImgFrame, category: int) → depthai.ImgFrame ¶

setFrame(self: depthai.ImgFrame, array: numpy.ndarray) → None ¶: Copies array bytes to ImgFrame buffer

setHeight(self: depthai.ImgFrame, height: int) → depthai.ImgFrame ¶

setInstanceNum(self: depthai.ImgFrame, instance: int) → depthai.ImgFrame ¶

setSequenceNum(self: depthai.ImgFrame, seq: int) → depthai.ImgFrame ¶

setSize(*args, **kwargs)¶

Overloaded function.

setSize(self: depthai.ImgFrame, width: int, height: int) -> depthai.ImgFrame
setSize(self: depthai.ImgFrame, sizer: tuple[int, int]) -> depthai.ImgFrame

setTimestamp(self: depthai.ImgFrame, timestamp: datetime.timedelta) → depthai.ImgFrame ¶

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

setType(self: depthai.ImgFrame, type: depthai.RawImgFrame.Type) → depthai.ImgFrame ¶

setWidth(self: depthai.ImgFrame, width: int) → depthai.ImgFrame ¶

class depthai.Interpolation¶

Bases: pybind11_builtins.pybind11_object

Members:

BILINEAR

BICUBIC

NEAREST_NEIGHBOR

BYPASS

DEFAULT

DEFAULT_DISPARITY_DEPTH

Attributes:

`BICUBIC`
`BILINEAR`
`BYPASS`
`DEFAULT`
`DEFAULT_DISPARITY_DEPTH`
`NEAREST_NEIGHBOR`
`name`
`value`

Methods:

__init__(self, value)

BICUBIC = <Interpolation.BICUBIC: 1>¶

BILINEAR = <Interpolation.BILINEAR: 0>¶

BYPASS = <Interpolation.NEAREST_NEIGHBOR: 2>¶

DEFAULT = <Interpolation.BICUBIC: 1>¶

DEFAULT_DISPARITY_DEPTH = <Interpolation.NEAREST_NEIGHBOR: 2>¶

NEAREST_NEIGHBOR = <Interpolation.NEAREST_NEIGHBOR: 2>¶

__init__(self: depthai.Interpolation, value: int) → None ¶

property name¶

property value¶

class depthai.LogLevel¶

Bases: pybind11_builtins.pybind11_object

Members:

TRACE

DEBUG

INFO

WARN

ERR

CRITICAL

OFF

Attributes:

`CRITICAL`
`DEBUG`
`ERR`
`INFO`
`OFF`
`TRACE`
`WARN`
`name`
`value`

Methods:

__init__(self, value)

CRITICAL = <LogLevel.CRITICAL: 5>¶

DEBUG = <LogLevel.DEBUG: 1>¶

ERR = <LogLevel.ERR: 4>¶

INFO = <LogLevel.INFO: 2>¶

OFF = <LogLevel.OFF: 6>¶

TRACE = <LogLevel.TRACE: 0>¶

WARN = <LogLevel.WARN: 3>¶

__init__(self: depthai.LogLevel, value: int) → None ¶

property name¶

property value¶

class depthai.LogMessage¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`colorRangeEnd`
`colorRangeStart`
`level`
`nodeIdName`
`payload`
`time`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property colorRangeEnd¶

property colorRangeStart¶

property level¶

property nodeIdName¶

property payload¶

property time¶

class depthai.MedianFilter¶

Bases: pybind11_builtins.pybind11_object

Members:

MEDIAN_OFF

KERNEL_3x3

KERNEL_5x5

KERNEL_7x7

Attributes:

`KERNEL_3x3`
`KERNEL_5x5`
`KERNEL_7x7`
`MEDIAN_OFF`
`name`
`value`

Methods:

__init__(self, value)

KERNEL_3x3 = <MedianFilter.KERNEL_3x3: 3>¶

KERNEL_5x5 = <MedianFilter.KERNEL_5x5: 5>¶

KERNEL_7x7 = <MedianFilter.KERNEL_7x7: 7>¶

MEDIAN_OFF = <MedianFilter.MEDIAN_OFF: 0>¶

__init__(self: depthai.MedianFilter, value: int) → None ¶

property name¶

property value¶

class depthai.MemoryInfo¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`remaining`
`total`
`used`

__init__(self: depthai.MemoryInfo) → None ¶

property remaining¶

property total¶

property used¶

class depthai.MessageDemuxProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

class depthai.MessageGroup¶

Bases: depthai.Buffer

Methods:

`__init__`(self)
`getIntervalNs`(self)
`getMessageNames`(self)
`getNumMessages`(self)
`getSequenceNum`(self)
`getTimestamp`(self)
`getTimestampDevice`(self)
`isSynced`(self, arg0)
`setSequenceNum`(self, arg0)
`setTimestamp`(self, arg0)
`setTimestampDevice`(self, arg0)

__init__(self: depthai.MessageGroup) → None ¶

getIntervalNs(self: depthai.MessageGroup) → int ¶

getMessageNames(self: depthai.MessageGroup) → list[str]¶

getNumMessages(self: depthai.MessageGroup) → int ¶

getSequenceNum(self: depthai.MessageGroup) → int ¶

getTimestamp(self: depthai.MessageGroup) → datetime.timedelta ¶

getTimestampDevice(self: depthai.MessageGroup) → datetime.timedelta ¶

isSynced(self: depthai.MessageGroup, arg0: int) → bool ¶

setSequenceNum(self: depthai.MessageGroup, arg0: int) → depthai.MessageGroup ¶

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

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

class depthai.MonoCameraProperties¶

Bases: pybind11_builtins.pybind11_object

Classes:

SensorResolution

Members:

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`boardSocket`
`eventFilter`
`fps`
`initialControl`
`isp3aFps`
`numFramesPool`
`numFramesPoolRaw`
`resolution`

class SensorResolution¶

Bases: pybind11_builtins.pybind11_object

Members:

THE_720_P

THE_800_P

THE_400_P

THE_480_P

THE_1200_P

Attributes:

`THE_1200_P`
`THE_400_P`
`THE_480_P`
`THE_720_P`
`THE_800_P`
`name`
`value`

Methods:

__init__(self, value)

THE_1200_P = <SensorResolution.THE_1200_P: 4>¶

THE_400_P = <SensorResolution.THE_400_P: 2>¶

THE_480_P = <SensorResolution.THE_480_P: 3>¶

THE_720_P = <SensorResolution.THE_720_P: 0>¶

THE_800_P = <SensorResolution.THE_800_P: 1>¶

__init__(self: depthai.MonoCameraProperties.SensorResolution, value: int) → None ¶

property name¶

property value¶

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property boardSocket¶

property eventFilter¶

property fps¶

property initialControl¶

property isp3aFps¶

property numFramesPool¶

property numFramesPoolRaw¶

property resolution¶

class depthai.NNData¶

Bases: depthai.Buffer

Methods:

`__init__`(self)
`getAllLayerNames`(self)
`getAllLayers`(self)
`getFirstLayerFp16`(self)
`getFirstLayerInt32`(self)
`getFirstLayerUInt8`(self)
`getLayer`(self, name, tensor)
`getLayerDatatype`(self, name, datatype)
`getLayerFp16`(self, name)
`getLayerInt32`(self, name)
`getLayerUInt8`(self, name)
`getSequenceNum`(self)
`getTimestamp`(self)
`getTimestampDevice`(self)
`hasLayer`(self, name)
`setLayer`(args, *kwargs)	Overloaded function.
`setSequenceNum`(self, arg0)
`setTimestamp`(self, arg0)
`setTimestampDevice`(self, arg0)

__init__(self: depthai.NNData) → None ¶

getAllLayerNames(self: depthai.NNData) → list[str]¶

getAllLayers(self: depthai.NNData) → list[depthai.TensorInfo]¶

getFirstLayerFp16(self: depthai.NNData) → list[float]¶

getFirstLayerInt32(self: depthai.NNData) → list[int]¶

getFirstLayerUInt8(self: depthai.NNData) → list[int]¶

getLayer(self: depthai.NNData, name: str, tensor: depthai.TensorInfo) → bool ¶

getLayerDatatype(self: depthai.NNData, name: str, datatype: depthai.TensorInfo.DataType) → bool ¶

getLayerFp16(self: depthai.NNData, name: str) → list[float]¶

getLayerInt32(self: depthai.NNData, name: str) → list[int]¶

getLayerUInt8(self: depthai.NNData, name: str) → list[int]¶

getSequenceNum(self: depthai.NNData) → int ¶

getTimestamp(self: depthai.NNData) → datetime.timedelta ¶

getTimestampDevice(self: depthai.NNData) → datetime.timedelta ¶

hasLayer(self: depthai.NNData, name: str) → bool ¶

setLayer(*args, **kwargs)¶

Overloaded function.

setLayer(self: depthai.NNData, name: str, data: numpy.ndarray[numpy.uint8]) -> None
setLayer(self: depthai.NNData, name: str, data: list[int]) -> depthai.NNData
setLayer(self: depthai.NNData, name: str, data: list[float]) -> depthai.NNData
setLayer(self: depthai.NNData, name: str, data: list[float]) -> depthai.NNData

setSequenceNum(self: depthai.NNData, arg0: int) → depthai.NNData ¶

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

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

class depthai.NeuralNetworkProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`blobSize`
`blobUri`
`numFrames`
`numNCEPerThread`
`numThreads`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property blobSize¶

property blobUri¶

property numFrames¶

property numNCEPerThread¶

property numThreads¶

class depthai.Node¶

Bases: pybind11_builtins.pybind11_object

Classes:

`Connection`
`DatatypeHierarchy`
`Id`	Node identificator.
`Input`
`InputMap`
`Output`
`OutputMap`

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getAssetManager`(args, *kwargs)	Overloaded function.
`getInputRefs`(args, *kwargs)	Overloaded function.
`getInputs`(self)
`getName`(self)
`getOutputRefs`(args, *kwargs)	Overloaded function.
`getOutputs`(self)
`getParentPipeline`(args, *kwargs)	Overloaded function.

Attributes:

`id`
`properties`

class Connection¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`inputGroup`
`inputId`
`inputName`
`outputGroup`
`outputId`
`outputName`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property inputGroup¶

property inputId¶

property inputName¶

property outputGroup¶

property outputId¶

property outputName¶

class DatatypeHierarchy¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self, arg0, arg1)

Attributes:

`datatype`
`descendants`

__init__(self: depthai.Node.DatatypeHierarchy, arg0: depthai.DatatypeEnum, arg1: bool) → None ¶

property datatype¶

property descendants¶

class Id¶

Bases: pybind11_builtins.pybind11_object

Node identificator. Unique for every node on a single Pipeline

Methods:

__init__(*args, **kwargs)

Initialize self.

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

class Input¶

Bases: pybind11_builtins.pybind11_object

Classes:

Type

Members:

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getBlocking`(self)
`getParent`(args, *kwargs)	Overloaded function.
`getQueueSize`(self)
`getReusePreviousMessage`(self)
`getWaitForMessage`(self)
`setBlocking`(self, blocking)
`setQueueSize`(self, size)
`setReusePreviousMessage`(self, …)
`setWaitForMessage`(self, waitForMessage)

Attributes:

`group`
`name`
`possibleDatatypes`
`type`
`waitForMessage`

class Type¶

Bases: pybind11_builtins.pybind11_object

Members:

SReceiver

MReceiver

Attributes:

`MReceiver`
`SReceiver`
`name`
`value`

Methods:

__init__(self, value)

MReceiver = <Type.MReceiver: 1>¶

SReceiver = <Type.SReceiver: 0>¶

__init__(self: depthai.Node.Input.Type, value: int) → None ¶

property name¶

property value¶

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getBlocking(self: depthai.Node.Input) → bool ¶

getParent(*args, **kwargs)¶

Overloaded function.

getParent(self: depthai.Node.Input) -> depthai.Node
getParent(self: depthai.Node.Input) -> depthai.Node

getQueueSize(self: depthai.Node.Input) → int ¶

getReusePreviousMessage(self: depthai.Node.Input) → bool ¶

getWaitForMessage(self: depthai.Node.Input) → bool ¶

property group¶

property name¶

property possibleDatatypes¶

setBlocking(self: depthai.Node.Input, blocking: bool) → None ¶

setQueueSize(self: depthai.Node.Input, size: int) → None ¶

setReusePreviousMessage(self: depthai.Node.Input, reusePreviousMessage: bool) → None ¶

setWaitForMessage(self: depthai.Node.Input, waitForMessage: bool) → None ¶

property type¶

property waitForMessage¶

class InputMap¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(args, *kwargs)	Initialize self.
`items`(self)

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

items(self: depthai.Node.InputMap) → Iterator[tuple[str, depthai.Node.Input]]¶

class Output¶

Bases: pybind11_builtins.pybind11_object

Classes:

Type

Members:

Methods:

`__init__`(args, *kwargs)	Initialize self.
`canConnect`(self, input)
`getConnections`(self)
`getParent`(args, *kwargs)	Overloaded function.
`isSamePipeline`(self, input)
`link`(self, input)
`unlink`(self, input)

Attributes:

`group`
`name`
`possibleDatatypes`
`type`

class Type¶

Bases: pybind11_builtins.pybind11_object

Members:

MSender

SSender

Attributes:

`MSender`
`SSender`
`name`
`value`

Methods:

__init__(self, value)

MSender = <Type.MSender: 0>¶

SSender = <Type.SSender: 1>¶

__init__(self: depthai.Node.Output.Type, value: int) → None ¶

property name¶

property value¶

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

canConnect(self: depthai.Node.Output, input: depthai.Node.Input) → bool ¶

getConnections(self: depthai.Node.Output) → list[depthai.Node.Connection]¶

getParent(*args, **kwargs)¶

Overloaded function.

getParent(self: depthai.Node.Output) -> depthai.Node
getParent(self: depthai.Node.Output) -> depthai.Node

property group¶

isSamePipeline(self: depthai.Node.Output, input: depthai.Node.Input) → bool ¶

link(self: depthai.Node.Output, input: depthai.Node.Input) → None ¶

property name¶

property possibleDatatypes¶

property type¶

unlink(self: depthai.Node.Output, input: depthai.Node.Input) → None ¶

class OutputMap¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(args, *kwargs)	Initialize self.
`items`(self)

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

items(self: depthai.Node.OutputMap) → Iterator[tuple[str, depthai.Node.Output]]¶

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getAssetManager(*args, **kwargs)¶

Overloaded function.

getAssetManager(self: depthai.Node) -> depthai.AssetManager
getAssetManager(self: depthai.Node) -> depthai.AssetManager

getInputRefs(*args, **kwargs)¶

Overloaded function.

getInputRefs(self: depthai.Node) -> list[depthai.Node.Input]
getInputRefs(self: depthai.Node) -> list[depthai.Node.Input]

getInputs(self: depthai.Node) → list[depthai.Node.Input]¶

getName(self: depthai.Node) → str ¶

getOutputRefs(*args, **kwargs)¶

Overloaded function.

getOutputRefs(self: depthai.Node) -> list[depthai.Node.Output]
getOutputRefs(self: depthai.Node) -> list[depthai.Node.Output]

getOutputs(self: depthai.Node) → list[depthai.Node.Output]¶

getParentPipeline(*args, **kwargs)¶

Overloaded function.

getParentPipeline(self: depthai.Node) -> depthai.Pipeline
getParentPipeline(self: depthai.Node) -> depthai.Pipeline

property id¶

property properties¶

class depthai.ObjectTrackerProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`detectionLabelsToTrack`
`maxObjectsToTrack`
`trackerIdAssignmentPolicy`
`trackerThreshold`
`trackerType`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property detectionLabelsToTrack¶

property maxObjectsToTrack¶

property trackerIdAssignmentPolicy¶

property trackerThreshold¶

property trackerType¶

class depthai.OpenVINO¶

Bases: pybind11_builtins.pybind11_object

Classes:

`Blob`
`Version`	Members:

Attributes:

`DEFAULT_VERSION`
`VERSION_2020_3`
`VERSION_2020_4`
`VERSION_2021_1`
`VERSION_2021_2`
`VERSION_2021_3`
`VERSION_2021_4`
`VERSION_2022_1`
`VERSION_UNIVERSAL`

Methods:

`__init__`(args, *kwargs)	Initialize self.
`areVersionsBlobCompatible`(v1, v2)
`getBlobLatestSupportedVersion`(majorVersion, …)
`getBlobSupportedVersions`(majorVersion, …)
`getVersionName`(version)
`getVersions`()
`parseVersionName`(versionString)

class Blob¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Overloaded function.

Attributes:

`data`
`networkInputs`
`networkOutputs`
`numShaves`
`numSlices`
`stageCount`
`version`

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.OpenVINO.Blob, arg0: list[int]) -> None
__init__(self: depthai.OpenVINO.Blob, arg0: Path) -> None

property data¶

property networkInputs¶

property networkOutputs¶

property numShaves¶

property numSlices¶

property stageCount¶

property version¶

DEFAULT_VERSION = <Version.VERSION_2022_1: 6>¶

VERSION_2020_3 = <Version.VERSION_2020_3: 0>¶

VERSION_2020_4 = <Version.VERSION_2020_4: 1>¶

VERSION_2021_1 = <Version.VERSION_2021_1: 2>¶

VERSION_2021_2 = <Version.VERSION_2021_2: 3>¶

VERSION_2021_3 = <Version.VERSION_2021_3: 4>¶

VERSION_2021_4 = <Version.VERSION_2021_4: 5>¶

VERSION_2022_1 = <Version.VERSION_2022_1: 6>¶

VERSION_UNIVERSAL = <Version.VERSION_UNIVERSAL: 7>¶

class Version¶

Bases: pybind11_builtins.pybind11_object

Members:

VERSION_2020_3

VERSION_2020_4

VERSION_2021_1

VERSION_2021_2

VERSION_2021_3

VERSION_2021_4

VERSION_2022_1

VERSION_UNIVERSAL

Attributes:

`VERSION_2020_3`
`VERSION_2020_4`
`VERSION_2021_1`
`VERSION_2021_2`
`VERSION_2021_3`
`VERSION_2021_4`
`VERSION_2022_1`
`VERSION_UNIVERSAL`
`name`
`value`

Methods:

__init__(self, value)

VERSION_2020_3 = <Version.VERSION_2020_3: 0>¶

VERSION_2020_4 = <Version.VERSION_2020_4: 1>¶

VERSION_2021_1 = <Version.VERSION_2021_1: 2>¶

VERSION_2021_2 = <Version.VERSION_2021_2: 3>¶

VERSION_2021_3 = <Version.VERSION_2021_3: 4>¶

VERSION_2021_4 = <Version.VERSION_2021_4: 5>¶

VERSION_2022_1 = <Version.VERSION_2022_1: 6>¶

VERSION_UNIVERSAL = <Version.VERSION_UNIVERSAL: 7>¶

__init__(self: depthai.OpenVINO.Version, value: int) → None ¶

property name¶

property value¶

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

static areVersionsBlobCompatible(v1: depthai.OpenVINO.Version, v2: depthai.OpenVINO.Version) → bool ¶

OpenVINO.getBlobLatestSupportedVersion(majorVersion: int, majorVersion: int) -> depthai.OpenVINO.Version

OpenVINO.getBlobSupportedVersions(majorVersion: int, majorVersion: int) -> list[depthai.OpenVINO.Version]

static getVersionName(version: depthai.OpenVINO.Version) → str ¶

static getVersions() → list[depthai.OpenVINO.Version]¶

static parseVersionName(versionString: str) → depthai.OpenVINO.Version ¶

class depthai.Pipeline¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(self)
`create`(self, arg0)
`createAprilTag`(self)
`createCamera`(self)
`createColorCamera`(self)
`createDetectionParser`(self)
`createEdgeDetector`(self)
`createFeatureTracker`(self)
`createIMU`(self)
`createImageManip`(self)
`createMobileNetDetectionNetwork`(self)
`createMobileNetSpatialDetectionNetwork`(self)
`createMonoCamera`(self)
`createNeuralNetwork`(self)
`createObjectTracker`(self)
`createSPIIn`(self)
`createSPIOut`(self)
`createScript`(self)
`createSpatialLocationCalculator`(self)
`createStereoDepth`(self)
`createSystemLogger`(self)
`createUVC`(self)
`createVideoEncoder`(self)
`createWarp`(self)
`createXLinkIn`(self)
`createXLinkOut`(self)
`createYoloDetectionNetwork`(self)
`createYoloSpatialDetectionNetwork`(self)
`getAllNodes`(args, *kwargs)	Overloaded function.
`getAssetManager`(args, *kwargs)	Overloaded function.
`getBoardConfig`(self)
`getCalibrationData`(self)
`getConnectionMap`(self)
`getConnections`(self)
`getDeviceConfig`(self)
`getGlobalProperties`(self)
`getNode`(args, *kwargs)	Overloaded function.
`getNodeMap`(self)
`getOpenVINOVersion`(self)
`getRequiredOpenVINOVersion`(self)
`link`(self, arg0, arg1)
`remove`(self, node)
`serializeToJson`(self)
`setBoardConfig`(self, arg0)
`setCalibrationData`(self, calibrationDataHandler)
`setCameraTuningBlobPath`(self, path)
`setOpenVINOVersion`(self, version)
`setSippBufferSize`(self, sizeBytes)
`setSippDmaBufferSize`(self, sizeBytes)
`setXLinkChunkSize`(self, sizeBytes)
`unlink`(self, arg0, arg1)

__init__(self: depthai.Pipeline) → None ¶

create(self: depthai.Pipeline, arg0: object) → depthai.Node ¶

createAprilTag(self: depthai.Pipeline) → depthai.node.AprilTag ¶

createCamera(self: depthai.Pipeline) → depthai.node.Camera ¶

createColorCamera(self: depthai.Pipeline) → depthai.node.ColorCamera ¶

createDetectionParser(self: depthai.Pipeline) → depthai.node.DetectionParser ¶

createEdgeDetector(self: depthai.Pipeline) → depthai.node.EdgeDetector ¶

createFeatureTracker(self: depthai.Pipeline) → depthai.node.FeatureTracker ¶

createIMU(self: depthai.Pipeline) → depthai.node.IMU ¶

createImageManip(self: depthai.Pipeline) → depthai.node.ImageManip ¶

createMobileNetDetectionNetwork(self: depthai.Pipeline) → depthai.node.MobileNetDetectionNetwork ¶

createMobileNetSpatialDetectionNetwork(self: depthai.Pipeline) → depthai.node.MobileNetSpatialDetectionNetwork ¶

createMonoCamera(self: depthai.Pipeline) → depthai.node.MonoCamera ¶

createNeuralNetwork(self: depthai.Pipeline) → depthai.node.NeuralNetwork ¶

createObjectTracker(self: depthai.Pipeline) → depthai.node.ObjectTracker ¶

createSPIIn(self: depthai.Pipeline) → depthai.node.SPIIn ¶

createSPIOut(self: depthai.Pipeline) → depthai.node.SPIOut ¶

createScript(self: depthai.Pipeline) → depthai.node.Script ¶

createSpatialLocationCalculator(self: depthai.Pipeline) → depthai.node.SpatialLocationCalculator ¶

createStereoDepth(self: depthai.Pipeline) → depthai.node.StereoDepth ¶

createSystemLogger(self: depthai.Pipeline) → depthai.node.SystemLogger ¶

createUVC(self: depthai.Pipeline) → depthai.node.UVC ¶

createVideoEncoder(self: depthai.Pipeline) → depthai.node.VideoEncoder ¶

createWarp(self: depthai.Pipeline) → depthai.node.Warp ¶

createXLinkIn(self: depthai.Pipeline) → depthai.node.XLinkIn ¶

createXLinkOut(self: depthai.Pipeline) → depthai.node.XLinkOut ¶

createYoloDetectionNetwork(self: depthai.Pipeline) → depthai.node.YoloDetectionNetwork ¶

createYoloSpatialDetectionNetwork(self: depthai.Pipeline) → depthai.node.YoloSpatialDetectionNetwork ¶

getAllNodes(*args, **kwargs)¶

Overloaded function.

getAllNodes(self: depthai.Pipeline) -> list[depthai.Node]
getAllNodes(self: depthai.Pipeline) -> list[depthai.Node]

getAssetManager(*args, **kwargs)¶

Overloaded function.

getAssetManager(self: depthai.Pipeline) -> depthai.AssetManager
getAssetManager(self: depthai.Pipeline) -> depthai.AssetManager

getBoardConfig(self: depthai.Pipeline) → depthai.BoardConfig ¶

getCalibrationData(self: depthai.Pipeline) → depthai.CalibrationHandler ¶

getConnectionMap(self: depthai.Pipeline) → dict[int, set[depthai.Node.Connection]]¶

getConnections(self: depthai.Pipeline) → list[depthai.Node.Connection]¶

getDeviceConfig(self: depthai.Pipeline) → depthai.Device.Config ¶

getGlobalProperties(self: depthai.Pipeline) → depthai.GlobalProperties ¶

getNode(*args, **kwargs)¶

Overloaded function.

getNode(self: depthai.Pipeline, arg0: int) -> depthai.Node
getNode(self: depthai.Pipeline, arg0: int) -> depthai.Node

getNodeMap(self: depthai.Pipeline) → dict[int, depthai.Node]¶

getOpenVINOVersion(self: depthai.Pipeline) → depthai.OpenVINO.Version ¶

getRequiredOpenVINOVersion(self: depthai.Pipeline) → Optional[depthai.OpenVINO.Version]¶

link(self: depthai.Pipeline, arg0: depthai.Node.Output, arg1: depthai.Node.Input) → None ¶

remove(self: depthai.Pipeline, node: depthai.Node) → None ¶

serializeToJson(self: depthai.Pipeline) → json¶

setBoardConfig(self: depthai.Pipeline, arg0: depthai.BoardConfig) → None ¶

setCalibrationData(self: depthai.Pipeline, calibrationDataHandler: depthai.CalibrationHandler) → None ¶

setCameraTuningBlobPath(self: depthai.Pipeline, path: Path) → None ¶

setOpenVINOVersion(self: depthai.Pipeline, version: depthai.OpenVINO.Version) → None ¶

setSippBufferSize(self: depthai.Pipeline, sizeBytes: int) → None ¶

setSippDmaBufferSize(self: depthai.Pipeline, sizeBytes: int) → None ¶

setXLinkChunkSize(self: depthai.Pipeline, sizeBytes: int) → None ¶

unlink(self: depthai.Pipeline, arg0: depthai.Node.Output, arg1: depthai.Node.Input) → None ¶

class depthai.Point2f¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Overloaded function.

Attributes:

`x`
`y`

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.Point2f) -> None
__init__(self: depthai.Point2f, arg0: float, arg1: float) -> None

property x¶

property y¶

class depthai.Point3f¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Overloaded function.

Attributes:

`x`
`y`
`z`

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.Point3f) -> None
__init__(self: depthai.Point3f, arg0: float, arg1: float, arg2: float) -> None

property x¶

property y¶

property z¶

class depthai.PointCloudConfig¶

Bases: depthai.Buffer

Methods:

`__init__`(args, *kwargs)	Overloaded function.
`get`(self)
`getSparse`(self)
`getTransformationMatrix`(self)
`set`(self, config)
`setSparse`(self, arg0)
`setTransformationMatrix`(args, *kwargs)	Overloaded function.

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.PointCloudConfig) -> None
__init__(self: depthai.PointCloudConfig, arg0: depthai.RawPointCloudConfig) -> None

get(self: depthai.PointCloudConfig) → depthai.RawPointCloudConfig ¶

getSparse(self: depthai.PointCloudConfig) → bool ¶

getTransformationMatrix(self: depthai.PointCloudConfig) → Annotated[list[Annotated[list[float], FixedSize(4)]], FixedSize(4)]¶

set(self: depthai.PointCloudConfig, config: depthai.RawPointCloudConfig) → depthai.PointCloudConfig ¶

setSparse(self: depthai.PointCloudConfig, arg0: bool) → depthai.PointCloudConfig ¶

setTransformationMatrix(*args, **kwargs)¶

Overloaded function.

setTransformationMatrix(self: depthai.PointCloudConfig, arg0: Annotated[list[Annotated[list[float], FixedSize(3)]], FixedSize(3)]) -> depthai.PointCloudConfig
setTransformationMatrix(self: depthai.PointCloudConfig, arg0: Annotated[list[Annotated[list[float], FixedSize(4)]], FixedSize(4)]) -> depthai.PointCloudConfig

class depthai.PointCloudData¶

Bases: depthai.Buffer

Methods:

`__init__`(self)
`getHeight`(self)
`getInstanceNum`(self)
`getMaxX`(self)
`getMaxY`(self)
`getMaxZ`(self)
`getMinX`(self)
`getMinY`(self)
`getMinZ`(self)
`getPoints`(self)
`getSequenceNum`(self)
`getTimestamp`(self)
`getTimestampDevice`(self)
`getWidth`(self)
`isSparse`(self)
`setHeight`(self, arg0)
`setInstanceNum`(self, arg0)
`setMaxX`(self, arg0)
`setMaxY`(self, arg0)
`setMaxZ`(self, arg0)
`setMinX`(self, arg0)
`setMinY`(self, arg0)
`setMinZ`(self, arg0)
`setSequenceNum`(self, arg0)
`setSize`(args, *kwargs)	Overloaded function.
`setTimestamp`(self, arg0)
`setTimestampDevice`(self, arg0)
`setWidth`(self, arg0)

Attributes:

points

__init__(self: depthai.PointCloudData) → None ¶

getHeight(self: depthai.PointCloudData) → int ¶

getInstanceNum(self: depthai.PointCloudData) → int ¶

getMaxX(self: depthai.PointCloudData) → float ¶

getMaxY(self: depthai.PointCloudData) → float ¶

getMaxZ(self: depthai.PointCloudData) → float ¶

getMinX(self: depthai.PointCloudData) → float ¶

getMinY(self: depthai.PointCloudData) → float ¶

getMinZ(self: depthai.PointCloudData) → float ¶

getPoints(self: object) → numpy.ndarray[numpy.float32]¶

getSequenceNum(self: depthai.PointCloudData) → int ¶

getTimestamp(self: depthai.PointCloudData) → datetime.timedelta ¶

getTimestampDevice(self: depthai.PointCloudData) → datetime.timedelta ¶

getWidth(self: depthai.PointCloudData) → int ¶

isSparse(self: depthai.PointCloudData) → bool ¶

property points¶

setHeight(self: depthai.PointCloudData, arg0: int) → depthai.PointCloudData ¶

setInstanceNum(self: depthai.PointCloudData, arg0: int) → depthai.PointCloudData ¶

setMaxX(self: depthai.PointCloudData, arg0: float) → depthai.PointCloudData ¶

setMaxY(self: depthai.PointCloudData, arg0: float) → depthai.PointCloudData ¶

setMaxZ(self: depthai.PointCloudData, arg0: float) → depthai.PointCloudData ¶

setMinX(self: depthai.PointCloudData, arg0: float) → depthai.PointCloudData ¶

setMinY(self: depthai.PointCloudData, arg0: float) → depthai.PointCloudData ¶

setMinZ(self: depthai.PointCloudData, arg0: float) → depthai.PointCloudData ¶

setSequenceNum(self: depthai.PointCloudData, arg0: int) → depthai.PointCloudData ¶

setSize(*args, **kwargs)¶

Overloaded function.

setSize(self: depthai.PointCloudData, width: int, height: int) -> depthai.PointCloudData
setSize(self: depthai.PointCloudData, size: tuple[int, int]) -> depthai.PointCloudData

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

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

setWidth(self: depthai.PointCloudData, arg0: int) → depthai.PointCloudData ¶

class depthai.PointCloudProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`initialConfig`
`numFramesPool`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property initialConfig¶

property numFramesPool¶

class depthai.ProcessorType¶

Bases: pybind11_builtins.pybind11_object

Members:

LEON_CSS

LEON_MSS

Attributes:

`LEON_CSS`
`LEON_MSS`
`name`
`value`

Methods:

__init__(self, value)

LEON_CSS = <ProcessorType.LEON_CSS: 0>¶

LEON_MSS = <ProcessorType.LEON_MSS: 1>¶

__init__(self: depthai.ProcessorType, value: int) → None ¶

property name¶

property value¶

class depthai.ProfilingData¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`numBytesRead`
`numBytesWritten`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property numBytesRead¶

property numBytesWritten¶

class depthai.Properties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

class depthai.RawAprilTagConfig¶

Bases: depthai.RawBuffer

Classes:

`Family`	Members:
`QuadThresholds`

Methods:

__init__(self)

Attributes:

`decodeSharpening`
`family`
`maxHammingDistance`
`quadDecimate`
`quadSigma`
`quadThresholds`
`refineEdges`

class Family¶

Bases: pybind11_builtins.pybind11_object

Members:

TAG_36H11

TAG_36H10

TAG_25H9

TAG_16H5

TAG_CIR21H7

TAG_STAND41H12

Attributes:

`TAG_16H5`
`TAG_25H9`
`TAG_36H10`
`TAG_36H11`
`TAG_CIR21H7`
`TAG_STAND41H12`
`name`
`value`

Methods:

__init__(self, value)

TAG_16H5 = <Family.TAG_16H5: 3>¶

TAG_25H9 = <Family.TAG_25H9: 2>¶

TAG_36H10 = <Family.TAG_36H10: 1>¶

TAG_36H11 = <Family.TAG_36H11: 0>¶

TAG_CIR21H7 = <Family.TAG_CIR21H7: 4>¶

TAG_STAND41H12 = <Family.TAG_STAND41H12: 5>¶

__init__(self: depthai.RawAprilTagConfig.Family, value: int) → None ¶

property name¶

property value¶

class QuadThresholds¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`criticalDegree`
`deglitch`
`maxLineFitMse`
`maxNmaxima`
`minClusterPixels`
`minWhiteBlackDiff`

__init__(self: depthai.RawAprilTagConfig.QuadThresholds) → None ¶

property criticalDegree¶

property deglitch¶

property maxLineFitMse¶

property maxNmaxima¶

property minClusterPixels¶

property minWhiteBlackDiff¶

__init__(self: depthai.RawAprilTagConfig) → None ¶

property decodeSharpening¶

property family¶

property maxHammingDistance¶

property quadDecimate¶

property quadSigma¶

property quadThresholds¶

property refineEdges¶

class depthai.RawBuffer¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`data`
`sequenceNum`
`ts`
`tsDevice`

__init__(self: depthai.RawBuffer) → None ¶

property data¶

property sequenceNum¶

property ts¶

property tsDevice¶

class depthai.RawCameraControl¶

Bases: depthai.RawBuffer

Classes:

`AntiBandingMode`	Members:
`AutoFocusMode`	Members:
`AutoWhiteBalanceMode`	Members:
`CaptureIntent`	Members:
`Command`	Members:
`ControlMode`	Members:
`EffectMode`	Members:
`FrameSyncMode`	Members:
`SceneMode`	Members:

Methods:

`__init__`(self)
`clearCommand`(self, arg0)
`getCommand`(self, arg0)
`setCommand`(self, arg0, arg1)

Attributes:

class AntiBandingMode¶

Bases: pybind11_builtins.pybind11_object

Members:

OFF

MAINS_50_HZ

MAINS_60_HZ

AUTO

Attributes:

`AUTO`
`MAINS_50_HZ`
`MAINS_60_HZ`
`OFF`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <AntiBandingMode.AUTO: 3>¶

MAINS_50_HZ = <AntiBandingMode.MAINS_50_HZ: 1>¶

MAINS_60_HZ = <AntiBandingMode.MAINS_60_HZ: 2>¶

OFF = <AntiBandingMode.OFF: 0>¶

__init__(self: depthai.RawCameraControl.AntiBandingMode, value: int) → None ¶

property name¶

property value¶

class AutoFocusMode¶

Bases: pybind11_builtins.pybind11_object

Members:

OFF

AUTO

MACRO

CONTINUOUS_VIDEO

CONTINUOUS_PICTURE

EDOF

Attributes:

`AUTO`
`CONTINUOUS_PICTURE`
`CONTINUOUS_VIDEO`
`EDOF`
`MACRO`
`OFF`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <AutoFocusMode.AUTO: 1>¶

CONTINUOUS_PICTURE = <AutoFocusMode.CONTINUOUS_PICTURE: 4>¶

CONTINUOUS_VIDEO = <AutoFocusMode.CONTINUOUS_VIDEO: 3>¶

EDOF = <AutoFocusMode.EDOF: 5>¶

MACRO = <AutoFocusMode.MACRO: 2>¶

OFF = <AutoFocusMode.OFF: 0>¶

__init__(self: depthai.RawCameraControl.AutoFocusMode, value: int) → None ¶

property name¶

property value¶

class AutoWhiteBalanceMode¶

Bases: pybind11_builtins.pybind11_object

Members:

OFF

AUTO

INCANDESCENT

FLUORESCENT

WARM_FLUORESCENT

DAYLIGHT

CLOUDY_DAYLIGHT

TWILIGHT

SHADE

Attributes:

`AUTO`
`CLOUDY_DAYLIGHT`
`DAYLIGHT`
`FLUORESCENT`
`INCANDESCENT`
`OFF`
`SHADE`
`TWILIGHT`
`WARM_FLUORESCENT`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <AutoWhiteBalanceMode.AUTO: 1>¶

CLOUDY_DAYLIGHT = <AutoWhiteBalanceMode.CLOUDY_DAYLIGHT: 6>¶

DAYLIGHT = <AutoWhiteBalanceMode.DAYLIGHT: 5>¶

FLUORESCENT = <AutoWhiteBalanceMode.FLUORESCENT: 3>¶

INCANDESCENT = <AutoWhiteBalanceMode.INCANDESCENT: 2>¶

OFF = <AutoWhiteBalanceMode.OFF: 0>¶

SHADE = <AutoWhiteBalanceMode.SHADE: 8>¶

TWILIGHT = <AutoWhiteBalanceMode.TWILIGHT: 7>¶

WARM_FLUORESCENT = <AutoWhiteBalanceMode.WARM_FLUORESCENT: 4>¶

__init__(self: depthai.RawCameraControl.AutoWhiteBalanceMode, value: int) → None ¶

property name¶

property value¶

class CaptureIntent¶

Bases: pybind11_builtins.pybind11_object

Members:

CUSTOM

PREVIEW

STILL_CAPTURE

VIDEO_RECORD

VIDEO_SNAPSHOT

ZERO_SHUTTER_LAG

Attributes:

`CUSTOM`
`PREVIEW`
`STILL_CAPTURE`
`VIDEO_RECORD`
`VIDEO_SNAPSHOT`
`ZERO_SHUTTER_LAG`
`name`
`value`

Methods:

__init__(self, value)

CUSTOM = <CaptureIntent.CUSTOM: 0>¶

PREVIEW = <CaptureIntent.PREVIEW: 1>¶

STILL_CAPTURE = <CaptureIntent.STILL_CAPTURE: 2>¶

VIDEO_RECORD = <CaptureIntent.VIDEO_RECORD: 3>¶

VIDEO_SNAPSHOT = <CaptureIntent.VIDEO_SNAPSHOT: 4>¶

ZERO_SHUTTER_LAG = <CaptureIntent.ZERO_SHUTTER_LAG: 5>¶

__init__(self: depthai.RawCameraControl.CaptureIntent, value: int) → None ¶

property name¶

property value¶

class Command¶

Bases: pybind11_builtins.pybind11_object

Members:

START_STREAM

STOP_STREAM

STILL_CAPTURE

MOVE_LENS

AF_TRIGGER

AE_MANUAL

AE_AUTO

AWB_MODE

SCENE_MODE

ANTIBANDING_MODE

EXPOSURE_COMPENSATION

AE_LOCK

AE_TARGET_FPS_RANGE

AWB_LOCK

CAPTURE_INTENT

CONTROL_MODE

FRAME_DURATION

SENSITIVITY

EFFECT_MODE

AF_MODE

NOISE_REDUCTION_STRENGTH

SATURATION

BRIGHTNESS

STREAM_FORMAT

RESOLUTION

SHARPNESS

CUSTOM_USECASE

CUSTOM_CAPT_MODE

CUSTOM_EXP_BRACKETS

CUSTOM_CAPTURE

CONTRAST

AE_REGION

AF_REGION

LUMA_DENOISE

CHROMA_DENOISE

WB_COLOR_TEMP

Attributes:

Methods:

__init__(self, value)

AE_AUTO = <Command.AE_AUTO: 7>¶

AE_LOCK = <Command.AE_LOCK: 13>¶

AE_MANUAL = <Command.AE_MANUAL: 6>¶

AE_REGION = <Command.AE_REGION: 45>¶

AE_TARGET_FPS_RANGE = <Command.AE_TARGET_FPS_RANGE: 14>¶

AF_MODE = <Command.AF_MODE: 26>¶

AF_REGION = <Command.AF_REGION: 46>¶

AF_TRIGGER = <Command.AF_TRIGGER: 5>¶

ANTIBANDING_MODE = <Command.ANTIBANDING_MODE: 10>¶

AWB_LOCK = <Command.AWB_LOCK: 16>¶

AWB_MODE = <Command.AWB_MODE: 8>¶

BRIGHTNESS = <Command.BRIGHTNESS: 31>¶

CAPTURE_INTENT = <Command.CAPTURE_INTENT: 17>¶

CHROMA_DENOISE = <Command.CHROMA_DENOISE: 48>¶

CONTRAST = <Command.CONTRAST: 44>¶

CONTROL_MODE = <Command.CONTROL_MODE: 18>¶

CUSTOM_CAPTURE = <Command.CUSTOM_CAPTURE: 43>¶

CUSTOM_CAPT_MODE = <Command.CUSTOM_CAPT_MODE: 41>¶

CUSTOM_EXP_BRACKETS = <Command.CUSTOM_EXP_BRACKETS: 42>¶

CUSTOM_USECASE = <Command.CUSTOM_USECASE: 40>¶

EFFECT_MODE = <Command.EFFECT_MODE: 24>¶

EXPOSURE_COMPENSATION = <Command.EXPOSURE_COMPENSATION: 11>¶

FRAME_DURATION = <Command.FRAME_DURATION: 21>¶

LUMA_DENOISE = <Command.LUMA_DENOISE: 47>¶

MOVE_LENS = <Command.MOVE_LENS: 4>¶

NOISE_REDUCTION_STRENGTH = <Command.NOISE_REDUCTION_STRENGTH: 27>¶

RESOLUTION = <Command.RESOLUTION: 34>¶

SATURATION = <Command.SATURATION: 28>¶

SCENE_MODE = <Command.SCENE_MODE: 9>¶

SENSITIVITY = <Command.SENSITIVITY: 23>¶

SHARPNESS = <Command.SHARPNESS: 35>¶

START_STREAM = <Command.START_STREAM: 1>¶

STILL_CAPTURE = <Command.STILL_CAPTURE: 3>¶

STOP_STREAM = <Command.STOP_STREAM: 2>¶

STREAM_FORMAT = <Command.STREAM_FORMAT: 33>¶

WB_COLOR_TEMP = <Command.WB_COLOR_TEMP: 49>¶

__init__(self: depthai.RawCameraControl.Command, value: int) → None ¶

property name¶

property value¶

class ControlMode¶

Bases: pybind11_builtins.pybind11_object

Members:

OFF

AUTO

USE_SCENE_MODE

Attributes:

`AUTO`
`OFF`
`USE_SCENE_MODE`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <ControlMode.AUTO: 1>¶

OFF = <ControlMode.OFF: 0>¶

USE_SCENE_MODE = <ControlMode.USE_SCENE_MODE: 2>¶

__init__(self: depthai.RawCameraControl.ControlMode, value: int) → None ¶

property name¶

property value¶

class EffectMode¶

Bases: pybind11_builtins.pybind11_object

Members:

OFF

MONO

NEGATIVE

SOLARIZE

SEPIA

POSTERIZE

WHITEBOARD

BLACKBOARD

AQUA

Attributes:

`AQUA`
`BLACKBOARD`
`MONO`
`NEGATIVE`
`OFF`
`POSTERIZE`
`SEPIA`
`SOLARIZE`
`WHITEBOARD`
`name`
`value`

Methods:

__init__(self, value)

AQUA = <EffectMode.AQUA: 8>¶

BLACKBOARD = <EffectMode.BLACKBOARD: 7>¶

MONO = <EffectMode.MONO: 1>¶

NEGATIVE = <EffectMode.NEGATIVE: 2>¶

OFF = <EffectMode.OFF: 0>¶

POSTERIZE = <EffectMode.POSTERIZE: 5>¶

SEPIA = <EffectMode.SEPIA: 4>¶

SOLARIZE = <EffectMode.SOLARIZE: 3>¶

WHITEBOARD = <EffectMode.WHITEBOARD: 6>¶

__init__(self: depthai.RawCameraControl.EffectMode, value: int) → None ¶

property name¶

property value¶

class FrameSyncMode¶

Bases: pybind11_builtins.pybind11_object

Members:

OFF

OUTPUT

INPUT

Attributes:

`INPUT`
`OFF`
`OUTPUT`
`name`
`value`

Methods:

__init__(self, value)

INPUT = <FrameSyncMode.INPUT: 2>¶

OFF = <FrameSyncMode.OFF: 0>¶

OUTPUT = <FrameSyncMode.OUTPUT: 1>¶

__init__(self: depthai.RawCameraControl.FrameSyncMode, value: int) → None ¶

property name¶

property value¶

class SceneMode¶

Bases: pybind11_builtins.pybind11_object

Members:

UNSUPPORTED

FACE_PRIORITY

ACTION

PORTRAIT

LANDSCAPE

NIGHT

NIGHT_PORTRAIT

THEATRE

BEACH

SNOW

SUNSET

STEADYPHOTO

FIREWORKS

SPORTS

PARTY

CANDLELIGHT

BARCODE

Attributes:

`ACTION`
`BARCODE`
`BEACH`
`CANDLELIGHT`
`FACE_PRIORITY`
`FIREWORKS`
`LANDSCAPE`
`NIGHT`
`NIGHT_PORTRAIT`
`PARTY`
`PORTRAIT`
`SNOW`
`SPORTS`
`STEADYPHOTO`
`SUNSET`
`THEATRE`
`UNSUPPORTED`
`name`
`value`

Methods:

__init__(self, value)

ACTION = <SceneMode.ACTION: 2>¶

BARCODE = <SceneMode.BARCODE: 16>¶

BEACH = <SceneMode.BEACH: 8>¶

CANDLELIGHT = <SceneMode.CANDLELIGHT: 15>¶

FACE_PRIORITY = <SceneMode.FACE_PRIORITY: 1>¶

FIREWORKS = <SceneMode.FIREWORKS: 12>¶

LANDSCAPE = <SceneMode.LANDSCAPE: 4>¶

NIGHT = <SceneMode.NIGHT: 5>¶

NIGHT_PORTRAIT = <SceneMode.NIGHT_PORTRAIT: 6>¶

PARTY = <SceneMode.PARTY: 14>¶

PORTRAIT = <SceneMode.PORTRAIT: 3>¶

SNOW = <SceneMode.SNOW: 9>¶

SPORTS = <SceneMode.SPORTS: 13>¶

STEADYPHOTO = <SceneMode.STEADYPHOTO: 11>¶

SUNSET = <SceneMode.SUNSET: 10>¶

THEATRE = <SceneMode.THEATRE: 7>¶

UNSUPPORTED = <SceneMode.UNSUPPORTED: 0>¶

__init__(self: depthai.RawCameraControl.SceneMode, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.RawCameraControl) → None ¶

property aeLockMode¶

property aeMaxExposureTimeUs¶

property afRegion¶

property antiBandingMode¶

property autoFocusMode¶

property awbLockMode¶

property awbMode¶

property brightness¶

property captureIntent¶

property chromaDenoise¶

clearCommand(self: depthai.RawCameraControl, arg0: depthai.RawCameraControl.Command) → None ¶

property cmdMask¶

property contrast¶

property controlMode¶

property effectMode¶

property expCompensation¶

property expManual¶

getCommand(self: depthai.RawCameraControl, arg0: depthai.RawCameraControl.Command) → bool ¶

property lensPosition¶

property lensPositionRaw¶

property lumaDenoise¶

property saturation¶

property sceneMode¶

setCommand(self: depthai.RawCameraControl, arg0: depthai.RawCameraControl.Command, arg1: bool) → None ¶

property sharpness¶

property wbColorTemp¶

class depthai.RawEdgeDetectorConfig¶

Bases: depthai.RawBuffer

Methods:

__init__(self)

Attributes:

config

__init__(self: depthai.RawEdgeDetectorConfig) → None ¶

property config¶

class depthai.RawEncodedFrame¶

Bases: depthai.RawBuffer

Classes:

`FrameType`	Members:
`Profile`	Members:

Methods:

__init__(self)

Attributes:

`bitrate`
`instanceNum`
`lossless`
`profile`
`quality`
`sequenceNum`
`ts`
`tsDevice`
`type`

class FrameType¶

Bases: pybind11_builtins.pybind11_object

Members:

I

P

B

Unknown

Attributes:

`B`
`I`
`P`
`Unknown`
`name`
`value`

Methods:

__init__(self, value)

B = <FrameType.B: 2>¶

I = <FrameType.I: 0>¶

P = <FrameType.P: 1>¶

Unknown = <FrameType.Unknown: 3>¶

__init__(self: depthai.RawEncodedFrame.FrameType, value: int) → None ¶

property name¶

property value¶

class Profile¶

Bases: pybind11_builtins.pybind11_object

Members:

JPEG

AVC

HEVC

Attributes:

`AVC`
`HEVC`
`JPEG`
`name`
`value`

Methods:

__init__(self, value)

AVC = <Profile.AVC: 1>¶

HEVC = <Profile.HEVC: 2>¶

JPEG = <Profile.JPEG: 0>¶

__init__(self: depthai.RawEncodedFrame.Profile, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.RawEncodedFrame) → None ¶

property bitrate¶

property instanceNum¶

property lossless¶

property profile¶

property quality¶

property sequenceNum¶

property ts¶

property tsDevice¶

property type¶

class depthai.RawFeatureTrackerConfig¶

Bases: depthai.RawBuffer

Classes:

`CornerDetector`
`FeatureMaintainer`
`MotionEstimator`

Methods:

__init__(self)

Attributes:

`cornerDetector`
`featureMaintainer`
`motionEstimator`

class CornerDetector¶

Bases: pybind11_builtins.pybind11_object

Classes:

`Thresholds`
`Type`	Members:

Methods:

__init__(self)

Attributes:

`cellGridDimension`
`enableSobel`
`enableSorting`
`numMaxFeatures`
`numTargetFeatures`
`thresholds`
`type`

class Thresholds¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`decreaseFactor`
`increaseFactor`
`initialValue`
`max`
`min`

__init__(self: depthai.RawFeatureTrackerConfig.CornerDetector.Thresholds) → None ¶

property decreaseFactor¶

property increaseFactor¶

property initialValue¶

property max¶

property min¶

class Type¶

Bases: pybind11_builtins.pybind11_object

Members:

HARRIS

SHI_THOMASI

Attributes:

`HARRIS`
`SHI_THOMASI`
`name`
`value`

Methods:

__init__(self, value)

HARRIS = <Type.HARRIS: 0>¶

SHI_THOMASI = <Type.SHI_THOMASI: 1>¶

__init__(self: depthai.RawFeatureTrackerConfig.CornerDetector.Type, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.RawFeatureTrackerConfig.CornerDetector) → None ¶

property cellGridDimension¶

property enableSobel¶

property enableSorting¶

property numMaxFeatures¶

property numTargetFeatures¶

property thresholds¶

property type¶

class FeatureMaintainer¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`enable`
`lostFeatureErrorThreshold`
`minimumDistanceBetweenFeatures`
`trackedFeatureThreshold`

__init__(self: depthai.RawFeatureTrackerConfig.FeatureMaintainer) → None ¶

property enable¶

property lostFeatureErrorThreshold¶

property minimumDistanceBetweenFeatures¶

property trackedFeatureThreshold¶

class MotionEstimator¶

Bases: pybind11_builtins.pybind11_object

Classes:

`OpticalFlow`
`Type`	Members:

Methods:

__init__(self)

Attributes:

`enable`
`opticalFlow`
`type`

class OpticalFlow¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`epsilon`
`maxIterations`
`pyramidLevels`
`searchWindowHeight`
`searchWindowWidth`

__init__(self: depthai.RawFeatureTrackerConfig.MotionEstimator.OpticalFlow) → None ¶

property epsilon¶

property maxIterations¶

property pyramidLevels¶

property searchWindowHeight¶

property searchWindowWidth¶

class Type¶

Bases: pybind11_builtins.pybind11_object

Members:

LUCAS_KANADE_OPTICAL_FLOW

HW_MOTION_ESTIMATION

Attributes:

`HW_MOTION_ESTIMATION`
`LUCAS_KANADE_OPTICAL_FLOW`
`name`
`value`

Methods:

__init__(self, value)

HW_MOTION_ESTIMATION = <Type.HW_MOTION_ESTIMATION: 1>¶

LUCAS_KANADE_OPTICAL_FLOW = <Type.LUCAS_KANADE_OPTICAL_FLOW: 0>¶

__init__(self: depthai.RawFeatureTrackerConfig.MotionEstimator.Type, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.RawFeatureTrackerConfig.MotionEstimator) → None ¶

property enable¶

property opticalFlow¶

property type¶

__init__(self: depthai.RawFeatureTrackerConfig) → None ¶

property cornerDetector¶

property featureMaintainer¶

property motionEstimator¶

class depthai.RawIMUData¶

Bases: depthai.RawBuffer

Methods:

__init__(self)

Attributes:

packets

__init__(self: depthai.RawIMUData) → None ¶

property packets¶

class depthai.RawImageAlignConfig¶

Bases: depthai.RawBuffer

Methods:

__init__(self)

Attributes:

staticDepthPlane

__init__(self: depthai.RawImageAlignConfig) → None ¶

property staticDepthPlane¶

class depthai.RawImageManipConfig¶

Bases: depthai.RawBuffer

Classes:

`CropConfig`
`CropRect`
`FormatConfig`
`ResizeConfig`

Methods:

__init__(self)

Attributes:

`cropConfig`
`enableCrop`
`enableFormat`
`enableResize`
`formatConfig`
`interpolation`
`resizeConfig`

class CropConfig¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`cropRatio`
`cropRect`
`cropRotatedRect`
`enableCenterCropRectangle`
`enableRotatedRect`
`normalizedCoords`
`widthHeightAspectRatio`

__init__(self: depthai.RawImageManipConfig.CropConfig) → None ¶

property cropRatio¶

property cropRect¶

property cropRotatedRect¶

property enableCenterCropRectangle¶

property enableRotatedRect¶

property normalizedCoords¶

property widthHeightAspectRatio¶

class CropRect¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`xmax`
`xmin`
`ymax`
`ymin`

__init__(self: depthai.RawImageManipConfig.CropRect) → None ¶

property xmax¶

property xmin¶

property ymax¶

property ymin¶

class FormatConfig¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`flipHorizontal`
`flipVertical`
`type`

__init__(self: depthai.RawImageManipConfig.FormatConfig) → None ¶

property flipHorizontal¶

property flipVertical¶

property type¶

class ResizeConfig¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`bgBlue`
`bgGreen`
`bgRed`
`enableRotation`
`enableWarp4pt`
`enableWarpMatrix`
`height`
`keepAspectRatio`
`lockAspectRatioFill`
`normalizedCoords`
`rotationAngleDeg`
`warpBorderReplicate`
`warpFourPoints`
`warpMatrix3x3`
`width`

__init__(self: depthai.RawImageManipConfig.ResizeConfig) → None ¶

property bgBlue¶

property bgGreen¶

property bgRed¶

property enableRotation¶

property enableWarp4pt¶

property enableWarpMatrix¶

property height¶

property keepAspectRatio¶

property lockAspectRatioFill¶

property normalizedCoords¶

property rotationAngleDeg¶

property warpBorderReplicate¶

property warpFourPoints¶

property warpMatrix3x3¶

property width¶

__init__(self: depthai.RawImageManipConfig) → None ¶

property cropConfig¶

property enableCrop¶

property enableFormat¶

property enableResize¶

property formatConfig¶

property interpolation¶

property resizeConfig¶

class depthai.RawImgDetections¶

Bases: depthai.RawBuffer

Methods:

__init__(self)

Attributes:

`detections`
`sequenceNum`
`ts`
`tsDevice`

__init__(self: depthai.RawImgDetections) → None ¶

property detections¶

property sequenceNum¶

property ts¶

property tsDevice¶

class depthai.RawImgFrame¶

Bases: depthai.RawBuffer

Classes:

`Specs`
`Type`	Members:

Methods:

__init__(self)

Attributes:

`category`
`fb`
`instanceNum`
`sequenceNum`
`ts`
`tsDevice`

class Specs¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`bytesPP`
`height`
`p1Offset`
`p2Offset`
`p3Offset`
`stride`
`type`
`width`

__init__(self: depthai.RawImgFrame.Specs) → None ¶

property bytesPP¶

property height¶

property p1Offset¶

property p2Offset¶

property p3Offset¶

property stride¶

property type¶

property width¶

class Type¶

Bases: pybind11_builtins.pybind11_object

Members:

YUV422i

YUV444p

YUV420p

YUV422p

YUV400p

RGBA8888

RGB161616

RGB888p

BGR888p

RGB888i

BGR888i

RGBF16F16F16p

BGRF16F16F16p

RGBF16F16F16i

BGRF16F16F16i

GRAY8

GRAYF16

LUT2

LUT4

LUT16

RAW16

RAW14

RAW12

RAW10

RAW8

PACK10

PACK12

YUV444i

NV12

NV21

BITSTREAM

HDR

NONE

Attributes:

Methods:

__init__(self, value)

BGR888i = <Type.BGR888i: 10>¶

BGR888p = <Type.BGR888p: 8>¶

BGRF16F16F16i = <Type.BGRF16F16F16i: 29>¶

BGRF16F16F16p = <Type.BGRF16F16F16p: 27>¶

BITSTREAM = <Type.BITSTREAM: 24>¶

GRAY8 = <Type.GRAY8: 30>¶

GRAYF16 = <Type.GRAYF16: 31>¶

HDR = <Type.HDR: 25>¶

LUT16 = <Type.LUT16: 13>¶

LUT2 = <Type.LUT2: 11>¶

LUT4 = <Type.LUT4: 12>¶

NONE = <Type.NONE: 32>¶

NV12 = <Type.NV12: 22>¶

NV21 = <Type.NV21: 23>¶

PACK10 = <Type.PACK10: 19>¶

PACK12 = <Type.PACK12: 20>¶

RAW10 = <Type.RAW10: 17>¶

RAW12 = <Type.RAW12: 16>¶

RAW14 = <Type.RAW14: 15>¶

RAW16 = <Type.RAW16: 14>¶

RAW8 = <Type.RAW8: 18>¶

RGB161616 = <Type.RGB161616: 6>¶

RGB888i = <Type.RGB888i: 9>¶

RGB888p = <Type.RGB888p: 7>¶

RGBA8888 = <Type.RGBA8888: 5>¶

RGBF16F16F16i = <Type.RGBF16F16F16i: 28>¶

RGBF16F16F16p = <Type.RGBF16F16F16p: 26>¶

YUV400p = <Type.YUV400p: 4>¶

YUV420p = <Type.YUV420p: 2>¶

YUV422i = <Type.YUV422i: 0>¶

YUV422p = <Type.YUV422p: 3>¶

YUV444i = <Type.YUV444i: 21>¶

YUV444p = <Type.YUV444p: 1>¶

__init__(self: depthai.RawImgFrame.Type, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.RawImgFrame) → None ¶

property category¶

property fb¶

property instanceNum¶

property sequenceNum¶

property ts¶

property tsDevice¶

class depthai.RawMessageGroup¶

Bases: depthai.RawBuffer

Methods:

__init__(self)

Attributes:

group

__init__(self: depthai.RawMessageGroup) → None ¶

property group¶

class depthai.RawNNData¶

Bases: depthai.RawBuffer

Methods:

__init__(self)

Attributes:

`batchSize`
`sequenceNum`
`tensors`
`ts`
`tsDevice`

__init__(self: depthai.RawNNData) → None ¶

property batchSize¶

property sequenceNum¶

property tensors¶

property ts¶

property tsDevice¶

class depthai.RawPointCloudConfig¶

Bases: depthai.RawBuffer

Methods:

__init__(self)

Attributes:

`sparse`
`transformationMatrix`

__init__(self: depthai.RawPointCloudConfig) → None ¶

property sparse¶

property transformationMatrix¶

class depthai.RawPointCloudData¶

Bases: depthai.RawBuffer

Methods:

__init__(self)

Attributes:

`height`
`instanceNum`
`maxx`
`maxy`
`maxz`
`minx`
`miny`
`minz`
`sparse`
`width`

__init__(self: depthai.RawPointCloudData) → None ¶

property height¶

property instanceNum¶

property maxx¶

property maxy¶

property maxz¶

property minx¶

property miny¶

property minz¶

property sparse¶

property width¶

class depthai.RawSpatialImgDetections¶

Bases: depthai.RawBuffer

Methods:

__init__(self)

Attributes:

`detections`
`sequenceNum`
`ts`
`tsDevice`

__init__(self: depthai.RawSpatialImgDetections) → None ¶

property detections¶

property sequenceNum¶

property ts¶

property tsDevice¶

class depthai.RawStereoDepthConfig¶

Bases: depthai.RawBuffer

Classes:

`AlgorithmControl`
`CensusTransform`
`CostAggregation`
`CostMatching`
`MedianFilter`	Members:
`PostProcessing`

Methods:

__init__(self)

Attributes:

`algorithmControl`
`censusTransform`
`costAggregation`
`costMatching`
`postProcessing`

class AlgorithmControl¶

Bases: pybind11_builtins.pybind11_object

Classes:

`DepthAlign`	Members:
`DepthUnit`	Members:

Methods:

__init__(self)

Attributes:

`centerAlignmentShiftFactor`
`customDepthUnitMultiplier`
`depthAlign`
`depthUnit`
`disparityShift`
`enableExtended`
`enableLeftRightCheck`
`enableSubpixel`
`leftRightCheckThreshold`
`numInvalidateEdgePixels`
`subpixelFractionalBits`

class DepthAlign¶

Bases: pybind11_builtins.pybind11_object

Members:

RECTIFIED_RIGHT

RECTIFIED_LEFT

CENTER

Attributes:

`CENTER`
`RECTIFIED_LEFT`
`RECTIFIED_RIGHT`
`name`
`value`

Methods:

__init__(self, value)

CENTER = <DepthAlign.CENTER: 2>¶

RECTIFIED_LEFT = <DepthAlign.RECTIFIED_LEFT: 1>¶

RECTIFIED_RIGHT = <DepthAlign.RECTIFIED_RIGHT: 0>¶

__init__(self: depthai.RawStereoDepthConfig.AlgorithmControl.DepthAlign, value: int) → None ¶

property name¶

property value¶

class DepthUnit¶

Bases: pybind11_builtins.pybind11_object

Members:

METER

CENTIMETER

MILLIMETER

INCH

FOOT

CUSTOM

Attributes:

`CENTIMETER`
`CUSTOM`
`FOOT`
`INCH`
`METER`
`MILLIMETER`
`name`
`value`

Methods:

__init__(self, value)

CENTIMETER = <DepthUnit.CENTIMETER: 1>¶

CUSTOM = <DepthUnit.CUSTOM: 5>¶

FOOT = <DepthUnit.FOOT: 4>¶

INCH = <DepthUnit.INCH: 3>¶

METER = <DepthUnit.METER: 0>¶

MILLIMETER = <DepthUnit.MILLIMETER: 2>¶

__init__(self: depthai.RawStereoDepthConfig.AlgorithmControl.DepthUnit, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.RawStereoDepthConfig.AlgorithmControl) → None ¶

property centerAlignmentShiftFactor¶

property customDepthUnitMultiplier¶

property depthAlign¶

property depthUnit¶

property disparityShift¶

property enableExtended¶

property enableLeftRightCheck¶

property enableSubpixel¶

property leftRightCheckThreshold¶

property numInvalidateEdgePixels¶

property subpixelFractionalBits¶

class CensusTransform¶

Bases: pybind11_builtins.pybind11_object

Classes:

KernelSize

Members:

Methods:

__init__(self)

Attributes:

`enableMeanMode`
`kernelMask`
`kernelSize`
`threshold`

class KernelSize¶

Bases: pybind11_builtins.pybind11_object

Members:

AUTO

KERNEL_5x5

KERNEL_7x7

KERNEL_7x9

Attributes:

`AUTO`
`KERNEL_5x5`
`KERNEL_7x7`
`KERNEL_7x9`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <KernelSize.AUTO: -1>¶

KERNEL_5x5 = <KernelSize.KERNEL_5x5: 0>¶

KERNEL_7x7 = <KernelSize.KERNEL_7x7: 1>¶

KERNEL_7x9 = <KernelSize.KERNEL_7x9: 2>¶

__init__(self: depthai.RawStereoDepthConfig.CensusTransform.KernelSize, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.RawStereoDepthConfig.CensusTransform) → None ¶

property enableMeanMode¶

property kernelMask¶

property kernelSize¶

property threshold¶

class CostAggregation¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`divisionFactor`
`horizontalPenaltyCostP1`
`horizontalPenaltyCostP2`
`verticalPenaltyCostP1`
`verticalPenaltyCostP2`

__init__(self: depthai.RawStereoDepthConfig.CostAggregation) → None ¶

property divisionFactor¶

property horizontalPenaltyCostP1¶

property horizontalPenaltyCostP2¶

property verticalPenaltyCostP1¶

property verticalPenaltyCostP2¶

class CostMatching¶

Bases: pybind11_builtins.pybind11_object

Classes:

`DisparityWidth`	Members:
`LinearEquationParameters`

Methods:

__init__(self)

Attributes:

`confidenceThreshold`
`disparityWidth`
`enableCompanding`
`invalidDisparityValue`
`linearEquationParameters`

class DisparityWidth¶

Bases: pybind11_builtins.pybind11_object

Members:

DISPARITY_64

DISPARITY_96

Attributes:

`DISPARITY_64`
`DISPARITY_96`
`name`
`value`

Methods:

__init__(self, value)

DISPARITY_64 = <DisparityWidth.DISPARITY_64: 0>¶

DISPARITY_96 = <DisparityWidth.DISPARITY_96: 1>¶

__init__(self: depthai.RawStereoDepthConfig.CostMatching.DisparityWidth, value: int) → None ¶

property name¶

property value¶

class LinearEquationParameters¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`alpha`
`beta`
`threshold`

__init__(self: depthai.RawStereoDepthConfig.CostMatching.LinearEquationParameters) → None ¶

property alpha¶

property beta¶

property threshold¶

__init__(self: depthai.RawStereoDepthConfig.CostMatching) → None ¶

property confidenceThreshold¶

property disparityWidth¶

property enableCompanding¶

property invalidDisparityValue¶

property linearEquationParameters¶

class MedianFilter¶

Bases: pybind11_builtins.pybind11_object

Members:

MEDIAN_OFF

KERNEL_3x3

KERNEL_5x5

KERNEL_7x7

Attributes:

`KERNEL_3x3`
`KERNEL_5x5`
`KERNEL_7x7`
`MEDIAN_OFF`
`name`
`value`

Methods:

__init__(self, value)

KERNEL_3x3 = <MedianFilter.KERNEL_3x3: 3>¶

KERNEL_5x5 = <MedianFilter.KERNEL_5x5: 5>¶

KERNEL_7x7 = <MedianFilter.KERNEL_7x7: 7>¶

MEDIAN_OFF = <MedianFilter.MEDIAN_OFF: 0>¶

__init__(self: depthai.MedianFilter, value: int) → None ¶

property name¶

property value¶

class PostProcessing¶

Bases: pybind11_builtins.pybind11_object

Classes:

`BrightnessFilter`
`DecimationFilter`
`SpatialFilter`
`SpeckleFilter`
`TemporalFilter`
`ThresholdFilter`

Methods:

__init__(self)

Attributes:

`bilateralSigmaValue`
`brightnessFilter`
`decimationFilter`
`median`
`spatialFilter`
`speckleFilter`
`temporalFilter`
`thresholdFilter`

class BrightnessFilter¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`maxBrightness`
`minBrightness`

__init__(self: depthai.RawStereoDepthConfig.PostProcessing.BrightnessFilter) → None ¶

property maxBrightness¶

property minBrightness¶

class DecimationFilter¶

Bases: pybind11_builtins.pybind11_object

Classes:

DecimationMode

Members:

Methods:

__init__(self)

Attributes:

`decimationFactor`
`decimationMode`

class DecimationMode¶

Bases: pybind11_builtins.pybind11_object

Members:

PIXEL_SKIPPING

NON_ZERO_MEDIAN

NON_ZERO_MEAN

Attributes:

`NON_ZERO_MEAN`
`NON_ZERO_MEDIAN`
`PIXEL_SKIPPING`
`name`
`value`

Methods:

__init__(self, value)

NON_ZERO_MEAN = <DecimationMode.NON_ZERO_MEAN: 2>¶

NON_ZERO_MEDIAN = <DecimationMode.NON_ZERO_MEDIAN: 1>¶

PIXEL_SKIPPING = <DecimationMode.PIXEL_SKIPPING: 0>¶

__init__(self: depthai.RawStereoDepthConfig.PostProcessing.DecimationFilter.DecimationMode, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.RawStereoDepthConfig.PostProcessing.DecimationFilter) → None ¶

property decimationFactor¶

property decimationMode¶

class SpatialFilter¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`alpha`
`delta`
`enable`
`holeFillingRadius`
`numIterations`

__init__(self: depthai.RawStereoDepthConfig.PostProcessing.SpatialFilter) → None ¶

property alpha¶

property delta¶

property enable¶

property holeFillingRadius¶

property numIterations¶

class SpeckleFilter¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`enable`
`speckleRange`

__init__(self: depthai.RawStereoDepthConfig.PostProcessing.SpeckleFilter) → None ¶

property enable¶

property speckleRange¶

class TemporalFilter¶

Bases: pybind11_builtins.pybind11_object

Classes:

PersistencyMode

Members:

Methods:

__init__(self)

Attributes:

`alpha`
`delta`
`enable`
`persistencyMode`

class PersistencyMode¶

Bases: pybind11_builtins.pybind11_object

Members:

PERSISTENCY_OFF

VALID_8_OUT_OF_8

VALID_2_IN_LAST_3

VALID_2_IN_LAST_4

VALID_2_OUT_OF_8

VALID_1_IN_LAST_2

VALID_1_IN_LAST_5

VALID_1_IN_LAST_8

PERSISTENCY_INDEFINITELY

Attributes:

`PERSISTENCY_INDEFINITELY`
`PERSISTENCY_OFF`
`VALID_1_IN_LAST_2`
`VALID_1_IN_LAST_5`
`VALID_1_IN_LAST_8`
`VALID_2_IN_LAST_3`
`VALID_2_IN_LAST_4`
`VALID_2_OUT_OF_8`
`VALID_8_OUT_OF_8`
`name`
`value`

Methods:

__init__(self, value)

PERSISTENCY_INDEFINITELY = <PersistencyMode.PERSISTENCY_INDEFINITELY: 8>¶

PERSISTENCY_OFF = <PersistencyMode.PERSISTENCY_OFF: 0>¶

VALID_1_IN_LAST_2 = <PersistencyMode.VALID_1_IN_LAST_2: 5>¶

VALID_1_IN_LAST_5 = <PersistencyMode.VALID_1_IN_LAST_5: 6>¶

VALID_1_IN_LAST_8 = <PersistencyMode.VALID_1_IN_LAST_8: 7>¶

VALID_2_IN_LAST_3 = <PersistencyMode.VALID_2_IN_LAST_3: 2>¶

VALID_2_IN_LAST_4 = <PersistencyMode.VALID_2_IN_LAST_4: 3>¶

VALID_2_OUT_OF_8 = <PersistencyMode.VALID_2_OUT_OF_8: 4>¶

VALID_8_OUT_OF_8 = <PersistencyMode.VALID_8_OUT_OF_8: 1>¶

__init__(self: depthai.RawStereoDepthConfig.PostProcessing.TemporalFilter.PersistencyMode, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.RawStereoDepthConfig.PostProcessing.TemporalFilter) → None ¶

property alpha¶

property delta¶

property enable¶

property persistencyMode¶

class ThresholdFilter¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`maxRange`
`minRange`

__init__(self: depthai.RawStereoDepthConfig.PostProcessing.ThresholdFilter) → None ¶

property maxRange¶

property minRange¶

__init__(self: depthai.RawStereoDepthConfig.PostProcessing) → None ¶

property bilateralSigmaValue¶

property brightnessFilter¶

property decimationFilter¶

property median¶

property spatialFilter¶

property speckleFilter¶

property temporalFilter¶

property thresholdFilter¶

__init__(self: depthai.RawStereoDepthConfig) → None ¶

property algorithmControl¶

property censusTransform¶

property costAggregation¶

property costMatching¶

property postProcessing¶

class depthai.RawSystemInformation¶

Bases: depthai.RawBuffer

Methods:

__init__(self)

Attributes:

`chipTemperature`
`cmxMemoryUsage`
`ddrMemoryUsage`
`leonCssCpuUsage`
`leonCssMemoryUsage`
`leonMssCpuUsage`
`leonMssMemoryUsage`

__init__(self: depthai.RawSystemInformation) → None ¶

property chipTemperature¶

property cmxMemoryUsage¶

property ddrMemoryUsage¶

property leonCssCpuUsage¶

property leonCssMemoryUsage¶

property leonMssCpuUsage¶

property leonMssMemoryUsage¶

class depthai.RawToFConfig¶

Bases: depthai.RawBuffer

Methods:

__init__(self)

Attributes:

`enableBurstMode`
`enableFPPNCorrection`
`enableOpticalCorrection`
`enablePhaseShuffleTemporalFilter`
`enablePhaseUnwrapping`
`enableTemperatureCorrection`
`enableWiggleCorrection`
`median`
`phaseUnwrapErrorThreshold`
`phaseUnwrappingLevel`

__init__(self: depthai.RawToFConfig) → None ¶

property enableBurstMode¶

property enableFPPNCorrection¶

property enableOpticalCorrection¶

property enablePhaseShuffleTemporalFilter¶

property enablePhaseUnwrapping¶

property enableTemperatureCorrection¶

property enableWiggleCorrection¶

property median¶

property phaseUnwrapErrorThreshold¶

property phaseUnwrappingLevel¶

class depthai.RawTrackedFeatures¶

Bases: depthai.RawBuffer

Methods:

__init__(self)

Attributes:

trackedFeatures

__init__(self: depthai.RawTrackedFeatures) → None ¶

property trackedFeatures¶

class depthai.RawTracklets¶

Bases: depthai.RawBuffer

Methods:

__init__(self)

Attributes:

tracklets

__init__(self: depthai.RawTracklets) → None ¶

property tracklets¶

class depthai.Rect¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(args, *kwargs)	Overloaded function.
`area`(self)
`bottomRight`(self)
`contains`(self, arg0)
`denormalize`(self, width, height)
`empty`(self)
`isNormalized`(self)
`normalize`(self, width, height)
`size`(self)
`topLeft`(self)

Attributes:

`height`
`width`
`x`
`y`

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.Rect) -> None
__init__(self: depthai.Rect, arg0: float, arg1: float, arg2: float, arg3: float) -> None
__init__(self: depthai.Rect, arg0: depthai.Point2f, arg1: depthai.Point2f) -> None
__init__(self: depthai.Rect, arg0: depthai.Point2f, arg1: depthai.Size2f) -> None

area(self: depthai.Rect) → float ¶

bottomRight(self: depthai.Rect) → depthai.Point2f ¶

contains(self: depthai.Rect, arg0: depthai.Point2f) → bool ¶

denormalize(self: depthai.Rect, width: int, height: int) → depthai.Rect ¶

empty(self: depthai.Rect) → bool ¶

property height¶

isNormalized(self: depthai.Rect) → bool ¶

normalize(self: depthai.Rect, width: int, height: int) → depthai.Rect ¶

size(self: depthai.Rect) → depthai.Size2f ¶

topLeft(self: depthai.Rect) → depthai.Point2f ¶

property width¶

property x¶

property y¶

class depthai.RotatedRect¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`angle`
`center`
`size`

__init__(self: depthai.RotatedRect) → None ¶

property angle¶

property center¶

property size¶

class depthai.SPIInProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`busId`
`maxDataSize`
`numFrames`
`streamName`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property busId¶

property maxDataSize¶

property numFrames¶

property streamName¶

class depthai.SPIOutProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`busId`
`streamName`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property busId¶

property streamName¶

class depthai.ScriptProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`processor`
`scriptName`
`scriptUri`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property processor¶

property scriptName¶

property scriptUri¶

class depthai.SerializationType¶

Bases: pybind11_builtins.pybind11_object

Members:

LIBNOP

JSON

JSON_MSGPACK

Attributes:

`JSON`
`JSON_MSGPACK`
`LIBNOP`
`name`
`value`

Methods:

__init__(self, value)

JSON = <SerializationType.JSON: 1>¶

JSON_MSGPACK = <SerializationType.JSON_MSGPACK: 2>¶

LIBNOP = <SerializationType.LIBNOP: 0>¶

__init__(self: depthai.SerializationType, value: int) → None ¶

property name¶

property value¶

class depthai.Size2f¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Overloaded function.

Attributes:

`height`
`width`

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.Size2f) -> None
__init__(self: depthai.Size2f, arg0: float, arg1: float) -> None

property height¶

property width¶

class depthai.SpatialDetectionNetworkProperties¶

Bases: depthai.DetectionNetworkProperties

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`depthThresholds`
`detectedBBScaleFactor`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property depthThresholds¶

property detectedBBScaleFactor¶

class depthai.SpatialImgDetection¶

Bases: depthai.ImgDetection

Methods:

__init__(self)

Attributes:

`boundingBoxMapping`
`spatialCoordinates`

__init__(self: depthai.SpatialImgDetection) → None ¶

property boundingBoxMapping¶

property spatialCoordinates¶

class depthai.SpatialImgDetections¶

Bases: depthai.Buffer

Methods:

`__init__`(self)
`getSequenceNum`(self)
`getTimestamp`(self)
`getTimestampDevice`(self)
`setSequenceNum`(self, arg0)
`setTimestamp`(self, arg0)
`setTimestampDevice`(self, arg0)

Attributes:

detections

__init__(self: depthai.SpatialImgDetections) → None ¶

property detections¶

getSequenceNum(self: depthai.SpatialImgDetections) → int ¶

getTimestamp(self: depthai.SpatialImgDetections) → datetime.timedelta ¶

getTimestampDevice(self: depthai.SpatialImgDetections) → datetime.timedelta ¶

setSequenceNum(self: depthai.SpatialImgDetections, arg0: int) → depthai.SpatialImgDetections ¶

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

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

class depthai.SpatialLocationCalculatorAlgorithm¶

Bases: pybind11_builtins.pybind11_object

Members:

AVERAGE

MEAN

MIN

MAX

MODE

MEDIAN

Attributes:

`AVERAGE`
`MAX`
`MEAN`
`MEDIAN`
`MIN`
`MODE`
`name`
`value`

Methods:

__init__(self, value)

AVERAGE = <SpatialLocationCalculatorAlgorithm.AVERAGE: 0>¶

MAX = <SpatialLocationCalculatorAlgorithm.MAX: 2>¶

MEAN = <SpatialLocationCalculatorAlgorithm.AVERAGE: 0>¶

MEDIAN = <SpatialLocationCalculatorAlgorithm.MEDIAN: 4>¶

MIN = <SpatialLocationCalculatorAlgorithm.MIN: 1>¶

MODE = <SpatialLocationCalculatorAlgorithm.MODE: 3>¶

__init__(self: depthai.SpatialLocationCalculatorAlgorithm, value: int) → None ¶

property name¶

property value¶

class depthai.SpatialLocationCalculatorConfig¶

Bases: depthai.Buffer

Methods:

`__init__`(self)
`addROI`(self, ROI)
`get`(self)
`getConfigData`(self)
`set`(self, config)
`setROIs`(self, ROIs)

__init__(self: depthai.SpatialLocationCalculatorConfig) → None ¶

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

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

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

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

setROIs(self: depthai.SpatialLocationCalculatorConfig, ROIs: list[depthai.SpatialLocationCalculatorConfigData]) → None ¶

class depthai.SpatialLocationCalculatorConfigData¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`calculationAlgorithm`
`depthThresholds`
`roi`

__init__(self: depthai.SpatialLocationCalculatorConfigData) → None ¶

property calculationAlgorithm¶

property depthThresholds¶

property roi¶

class depthai.SpatialLocationCalculatorConfigThresholds¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`lowerThreshold`
`upperThreshold`

__init__(self: depthai.SpatialLocationCalculatorConfigThresholds) → None ¶

property lowerThreshold¶

property upperThreshold¶

class depthai.SpatialLocationCalculatorData¶

Bases: depthai.Buffer

Methods:

`__init__`(self)
`getSequenceNum`(self)
`getSpatialLocations`(self)
`getTimestamp`(self)
`getTimestampDevice`(self)
`setSequenceNum`(self, arg0)
`setTimestamp`(self, arg0)
`setTimestampDevice`(self, arg0)

Attributes:

spatialLocations

__init__(self: depthai.SpatialLocationCalculatorData) → None ¶

getSequenceNum(self: depthai.SpatialLocationCalculatorData) → int ¶

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

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

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

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

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

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

property spatialLocations¶

class depthai.SpatialLocationCalculatorProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

roiConfig

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property roiConfig¶

class depthai.SpatialLocations¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`config`
`depthAverage`
`depthAveragePixelCount`
`depthMax`
`depthMedian`
`depthMin`
`depthMode`
`spatialCoordinates`

__init__(self: depthai.SpatialLocations) → None ¶

property config¶

property depthAverage¶

property depthAveragePixelCount¶

property depthMax¶

property depthMedian¶

property depthMin¶

property depthMode¶

property spatialCoordinates¶

class depthai.StereoDepthConfig¶

Bases: depthai.Buffer

Classes:

`AlgorithmControl`
`CensusTransform`
`CostAggregation`
`CostMatching`
`MedianFilter`	Members:
`PostProcessing`

Methods:

`__init__`(self)
`get`(self)
`getBilateralFilterSigma`(self)
`getConfidenceThreshold`(self)
`getDepthUnit`(self)
`getLeftRightCheckThreshold`(self)
`getMaxDisparity`(self)
`getMedianFilter`(self)
`set`(self, config)
`setBilateralFilterSigma`(self, sigma)
`setConfidenceThreshold`(self, confThr)
`setDepthAlign`(self, align)
`setDepthUnit`(self, arg0)
`setDisparityShift`(self, arg0)
`setExtendedDisparity`(self, enable)
`setLeftRightCheck`(self, enable)
`setLeftRightCheckThreshold`(self, sigma)
`setMedianFilter`(self, median)
`setNumInvalidateEdgePixels`(self, arg0)
`setSubpixel`(self, enable)
`setSubpixelFractionalBits`(self, …)

class AlgorithmControl¶

Bases: pybind11_builtins.pybind11_object

Classes:

`DepthAlign`	Members:
`DepthUnit`	Members:

Methods:

__init__(self)

Attributes:

`centerAlignmentShiftFactor`
`customDepthUnitMultiplier`
`depthAlign`
`depthUnit`
`disparityShift`
`enableExtended`
`enableLeftRightCheck`
`enableSubpixel`
`leftRightCheckThreshold`
`numInvalidateEdgePixels`
`subpixelFractionalBits`

class DepthAlign¶

Bases: pybind11_builtins.pybind11_object

Members:

RECTIFIED_RIGHT

RECTIFIED_LEFT

CENTER

Attributes:

`CENTER`
`RECTIFIED_LEFT`
`RECTIFIED_RIGHT`
`name`
`value`

Methods:

__init__(self, value)

CENTER = <DepthAlign.CENTER: 2>¶

RECTIFIED_LEFT = <DepthAlign.RECTIFIED_LEFT: 1>¶

RECTIFIED_RIGHT = <DepthAlign.RECTIFIED_RIGHT: 0>¶

__init__(self: depthai.RawStereoDepthConfig.AlgorithmControl.DepthAlign, value: int) → None ¶

property name¶

property value¶

class DepthUnit¶

Bases: pybind11_builtins.pybind11_object

Members:

METER

CENTIMETER

MILLIMETER

INCH

FOOT

CUSTOM

Attributes:

`CENTIMETER`
`CUSTOM`
`FOOT`
`INCH`
`METER`
`MILLIMETER`
`name`
`value`

Methods:

__init__(self, value)

CENTIMETER = <DepthUnit.CENTIMETER: 1>¶

CUSTOM = <DepthUnit.CUSTOM: 5>¶

FOOT = <DepthUnit.FOOT: 4>¶

INCH = <DepthUnit.INCH: 3>¶

METER = <DepthUnit.METER: 0>¶

MILLIMETER = <DepthUnit.MILLIMETER: 2>¶

__init__(self: depthai.RawStereoDepthConfig.AlgorithmControl.DepthUnit, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.RawStereoDepthConfig.AlgorithmControl) → None ¶

property centerAlignmentShiftFactor¶

property customDepthUnitMultiplier¶

property depthAlign¶

property depthUnit¶

property disparityShift¶

property enableExtended¶

property enableLeftRightCheck¶

property enableSubpixel¶

property leftRightCheckThreshold¶

property numInvalidateEdgePixels¶

property subpixelFractionalBits¶

class CensusTransform¶

Bases: pybind11_builtins.pybind11_object

Classes:

KernelSize

Members:

Methods:

__init__(self)

Attributes:

`enableMeanMode`
`kernelMask`
`kernelSize`
`threshold`

class KernelSize¶

Bases: pybind11_builtins.pybind11_object

Members:

AUTO

KERNEL_5x5

KERNEL_7x7

KERNEL_7x9

Attributes:

`AUTO`
`KERNEL_5x5`
`KERNEL_7x7`
`KERNEL_7x9`
`name`
`value`

Methods:

__init__(self, value)

AUTO = <KernelSize.AUTO: -1>¶

KERNEL_5x5 = <KernelSize.KERNEL_5x5: 0>¶

KERNEL_7x7 = <KernelSize.KERNEL_7x7: 1>¶

KERNEL_7x9 = <KernelSize.KERNEL_7x9: 2>¶

__init__(self: depthai.RawStereoDepthConfig.CensusTransform.KernelSize, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.RawStereoDepthConfig.CensusTransform) → None ¶

property enableMeanMode¶

property kernelMask¶

property kernelSize¶

property threshold¶

class CostAggregation¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`divisionFactor`
`horizontalPenaltyCostP1`
`horizontalPenaltyCostP2`
`verticalPenaltyCostP1`
`verticalPenaltyCostP2`

__init__(self: depthai.RawStereoDepthConfig.CostAggregation) → None ¶

property divisionFactor¶

property horizontalPenaltyCostP1¶

property horizontalPenaltyCostP2¶

property verticalPenaltyCostP1¶

property verticalPenaltyCostP2¶

class CostMatching¶

Bases: pybind11_builtins.pybind11_object

Classes:

`DisparityWidth`	Members:
`LinearEquationParameters`

Methods:

__init__(self)

Attributes:

`confidenceThreshold`
`disparityWidth`
`enableCompanding`
`invalidDisparityValue`
`linearEquationParameters`

class DisparityWidth¶

Bases: pybind11_builtins.pybind11_object

Members:

DISPARITY_64

DISPARITY_96

Attributes:

`DISPARITY_64`
`DISPARITY_96`
`name`
`value`

Methods:

__init__(self, value)

DISPARITY_64 = <DisparityWidth.DISPARITY_64: 0>¶

DISPARITY_96 = <DisparityWidth.DISPARITY_96: 1>¶

__init__(self: depthai.RawStereoDepthConfig.CostMatching.DisparityWidth, value: int) → None ¶

property name¶

property value¶

class LinearEquationParameters¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`alpha`
`beta`
`threshold`

__init__(self: depthai.RawStereoDepthConfig.CostMatching.LinearEquationParameters) → None ¶

property alpha¶

property beta¶

property threshold¶

__init__(self: depthai.RawStereoDepthConfig.CostMatching) → None ¶

property confidenceThreshold¶

property disparityWidth¶

property enableCompanding¶

property invalidDisparityValue¶

property linearEquationParameters¶

class MedianFilter¶

Bases: pybind11_builtins.pybind11_object

Members:

MEDIAN_OFF

KERNEL_3x3

KERNEL_5x5

KERNEL_7x7

Attributes:

`KERNEL_3x3`
`KERNEL_5x5`
`KERNEL_7x7`
`MEDIAN_OFF`
`name`
`value`

Methods:

__init__(self, value)

KERNEL_3x3 = <MedianFilter.KERNEL_3x3: 3>¶

KERNEL_5x5 = <MedianFilter.KERNEL_5x5: 5>¶

KERNEL_7x7 = <MedianFilter.KERNEL_7x7: 7>¶

MEDIAN_OFF = <MedianFilter.MEDIAN_OFF: 0>¶

__init__(self: depthai.MedianFilter, value: int) → None ¶

property name¶

property value¶

class PostProcessing¶

Bases: pybind11_builtins.pybind11_object

Classes:

`BrightnessFilter`
`DecimationFilter`
`SpatialFilter`
`SpeckleFilter`
`TemporalFilter`
`ThresholdFilter`

Methods:

__init__(self)

Attributes:

`bilateralSigmaValue`
`brightnessFilter`
`decimationFilter`
`median`
`spatialFilter`
`speckleFilter`
`temporalFilter`
`thresholdFilter`

class BrightnessFilter¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`maxBrightness`
`minBrightness`

__init__(self: depthai.RawStereoDepthConfig.PostProcessing.BrightnessFilter) → None ¶

property maxBrightness¶

property minBrightness¶

class DecimationFilter¶

Bases: pybind11_builtins.pybind11_object

Classes:

DecimationMode

Members:

Methods:

__init__(self)

Attributes:

`decimationFactor`
`decimationMode`

class DecimationMode¶

Bases: pybind11_builtins.pybind11_object

Members:

PIXEL_SKIPPING

NON_ZERO_MEDIAN

NON_ZERO_MEAN

Attributes:

`NON_ZERO_MEAN`
`NON_ZERO_MEDIAN`
`PIXEL_SKIPPING`
`name`
`value`

Methods:

__init__(self, value)

NON_ZERO_MEAN = <DecimationMode.NON_ZERO_MEAN: 2>¶

NON_ZERO_MEDIAN = <DecimationMode.NON_ZERO_MEDIAN: 1>¶

PIXEL_SKIPPING = <DecimationMode.PIXEL_SKIPPING: 0>¶

__init__(self: depthai.RawStereoDepthConfig.PostProcessing.DecimationFilter.DecimationMode, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.RawStereoDepthConfig.PostProcessing.DecimationFilter) → None ¶

property decimationFactor¶

property decimationMode¶

class SpatialFilter¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`alpha`
`delta`
`enable`
`holeFillingRadius`
`numIterations`

__init__(self: depthai.RawStereoDepthConfig.PostProcessing.SpatialFilter) → None ¶

property alpha¶

property delta¶

property enable¶

property holeFillingRadius¶

property numIterations¶

class SpeckleFilter¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`enable`
`speckleRange`

__init__(self: depthai.RawStereoDepthConfig.PostProcessing.SpeckleFilter) → None ¶

property enable¶

property speckleRange¶

class TemporalFilter¶

Bases: pybind11_builtins.pybind11_object

Classes:

PersistencyMode

Members:

Methods:

__init__(self)

Attributes:

`alpha`
`delta`
`enable`
`persistencyMode`

class PersistencyMode¶

Bases: pybind11_builtins.pybind11_object

Members:

PERSISTENCY_OFF

VALID_8_OUT_OF_8

VALID_2_IN_LAST_3

VALID_2_IN_LAST_4

VALID_2_OUT_OF_8

VALID_1_IN_LAST_2

VALID_1_IN_LAST_5

VALID_1_IN_LAST_8

PERSISTENCY_INDEFINITELY

Attributes:

`PERSISTENCY_INDEFINITELY`
`PERSISTENCY_OFF`
`VALID_1_IN_LAST_2`
`VALID_1_IN_LAST_5`
`VALID_1_IN_LAST_8`
`VALID_2_IN_LAST_3`
`VALID_2_IN_LAST_4`
`VALID_2_OUT_OF_8`
`VALID_8_OUT_OF_8`
`name`
`value`

Methods:

__init__(self, value)

PERSISTENCY_INDEFINITELY = <PersistencyMode.PERSISTENCY_INDEFINITELY: 8>¶

PERSISTENCY_OFF = <PersistencyMode.PERSISTENCY_OFF: 0>¶

VALID_1_IN_LAST_2 = <PersistencyMode.VALID_1_IN_LAST_2: 5>¶

VALID_1_IN_LAST_5 = <PersistencyMode.VALID_1_IN_LAST_5: 6>¶

VALID_1_IN_LAST_8 = <PersistencyMode.VALID_1_IN_LAST_8: 7>¶

VALID_2_IN_LAST_3 = <PersistencyMode.VALID_2_IN_LAST_3: 2>¶

VALID_2_IN_LAST_4 = <PersistencyMode.VALID_2_IN_LAST_4: 3>¶

VALID_2_OUT_OF_8 = <PersistencyMode.VALID_2_OUT_OF_8: 4>¶

VALID_8_OUT_OF_8 = <PersistencyMode.VALID_8_OUT_OF_8: 1>¶

__init__(self: depthai.RawStereoDepthConfig.PostProcessing.TemporalFilter.PersistencyMode, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.RawStereoDepthConfig.PostProcessing.TemporalFilter) → None ¶

property alpha¶

property delta¶

property enable¶

property persistencyMode¶

class ThresholdFilter¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`maxRange`
`minRange`

__init__(self: depthai.RawStereoDepthConfig.PostProcessing.ThresholdFilter) → None ¶

property maxRange¶

property minRange¶

__init__(self: depthai.RawStereoDepthConfig.PostProcessing) → None ¶

property bilateralSigmaValue¶

property brightnessFilter¶

property decimationFilter¶

property median¶

property spatialFilter¶

property speckleFilter¶

property temporalFilter¶

property thresholdFilter¶

__init__(self: depthai.StereoDepthConfig) → None ¶

get(self: depthai.StereoDepthConfig) → depthai.RawStereoDepthConfig ¶

getBilateralFilterSigma(self: depthai.StereoDepthConfig) → int ¶

getConfidenceThreshold(self: depthai.StereoDepthConfig) → int ¶

getDepthUnit(self: depthai.StereoDepthConfig) → depthai.RawStereoDepthConfig.AlgorithmControl.DepthUnit ¶

getLeftRightCheckThreshold(self: depthai.StereoDepthConfig) → int ¶

getMaxDisparity(self: depthai.StereoDepthConfig) → float ¶

getMedianFilter(self: depthai.StereoDepthConfig) → depthai.MedianFilter ¶

set(self: depthai.StereoDepthConfig, config: depthai.RawStereoDepthConfig) → depthai.StereoDepthConfig ¶

setBilateralFilterSigma(self: depthai.StereoDepthConfig, sigma: int) → depthai.StereoDepthConfig ¶

setConfidenceThreshold(self: depthai.StereoDepthConfig, confThr: int) → depthai.StereoDepthConfig ¶

setDepthAlign(self: depthai.StereoDepthConfig, align: depthai.RawStereoDepthConfig.AlgorithmControl.DepthAlign) → depthai.StereoDepthConfig ¶

setDepthUnit(self: depthai.StereoDepthConfig, arg0: depthai.RawStereoDepthConfig.AlgorithmControl.DepthUnit) → depthai.StereoDepthConfig ¶

setDisparityShift(self: depthai.StereoDepthConfig, arg0: int) → depthai.StereoDepthConfig ¶

setExtendedDisparity(self: depthai.StereoDepthConfig, enable: bool) → depthai.StereoDepthConfig ¶

setLeftRightCheck(self: depthai.StereoDepthConfig, enable: bool) → depthai.StereoDepthConfig ¶

setLeftRightCheckThreshold(self: depthai.StereoDepthConfig, sigma: int) → depthai.StereoDepthConfig ¶

setMedianFilter(self: depthai.StereoDepthConfig, median: depthai.MedianFilter) → depthai.StereoDepthConfig ¶

setNumInvalidateEdgePixels(self: depthai.StereoDepthConfig, arg0: int) → depthai.StereoDepthConfig ¶

setSubpixel(self: depthai.StereoDepthConfig, enable: bool) → depthai.StereoDepthConfig ¶

setSubpixelFractionalBits(self: depthai.StereoDepthConfig, subpixelFractionalBits: int) → depthai.StereoDepthConfig ¶

class depthai.StereoDepthProperties¶

Bases: pybind11_builtins.pybind11_object

Classes:

`DepthAlign`	Members:
`MedianFilter`	Members:
`RectificationMesh`

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

class DepthAlign¶

Bases: pybind11_builtins.pybind11_object

Members:

RECTIFIED_RIGHT

RECTIFIED_LEFT

CENTER

Attributes:

`CENTER`
`RECTIFIED_LEFT`
`RECTIFIED_RIGHT`
`name`
`value`

Methods:

__init__(self, value)

CENTER = <DepthAlign.CENTER: 2>¶

RECTIFIED_LEFT = <DepthAlign.RECTIFIED_LEFT: 1>¶

RECTIFIED_RIGHT = <DepthAlign.RECTIFIED_RIGHT: 0>¶

__init__(self: depthai.RawStereoDepthConfig.AlgorithmControl.DepthAlign, value: int) → None ¶

property name¶

property value¶

class MedianFilter¶

Bases: pybind11_builtins.pybind11_object

Members:

MEDIAN_OFF

KERNEL_3x3

KERNEL_5x5

KERNEL_7x7

Attributes:

`KERNEL_3x3`
`KERNEL_5x5`
`KERNEL_7x7`
`MEDIAN_OFF`
`name`
`value`

Methods:

__init__(self, value)

KERNEL_3x3 = <MedianFilter.KERNEL_3x3: 3>¶

KERNEL_5x5 = <MedianFilter.KERNEL_5x5: 5>¶

KERNEL_7x7 = <MedianFilter.KERNEL_7x7: 7>¶

MEDIAN_OFF = <MedianFilter.MEDIAN_OFF: 0>¶

__init__(self: depthai.MedianFilter, value: int) → None ¶

property name¶

property value¶

class RectificationMesh¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`meshLeftUri`
`meshRightUri`
`meshSize`
`stepHeight`
`stepWidth`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property meshLeftUri¶

property meshRightUri¶

property meshSize¶

property stepHeight¶

property stepWidth¶

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property alphaScaling¶

property baseline¶

property depthAlignCamera¶

property depthAlignmentUseSpecTranslation¶

property disparityToDepthUseSpecTranslation¶

property enableRectification¶

property enableRuntimeStereoModeSwitch¶

property focalLength¶

property focalLengthFromCalibration¶

property height¶

property initialConfig¶

property mesh¶

property numFramesPool¶

property numPostProcessingMemorySlices¶

property numPostProcessingShaves¶

property outHeight¶

property outKeepAspectRatio¶

property outWidth¶

property rectificationUseSpecTranslation¶

property rectifyEdgeFillColor¶

property useHomographyRectification¶

property width¶

class depthai.StereoPair¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`baseline`
`isVertical`
`left`
`right`

__init__(self: depthai.StereoPair) → None ¶

property baseline¶

property isVertical¶

property left¶

property right¶

class depthai.StereoRectification¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`leftCameraSocket`
`rectifiedRotationLeft`
`rectifiedRotationRight`
`rightCameraSocket`

__init__(self: depthai.StereoRectification) → None ¶

property leftCameraSocket¶

property rectifiedRotationLeft¶

property rectifiedRotationRight¶

property rightCameraSocket¶

class depthai.SyncProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`syncAttempts`
`syncThresholdNs`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property syncAttempts¶

property syncThresholdNs¶

class depthai.SystemInformation¶

Bases: depthai.Buffer

Methods:

__init__(self)

Attributes:

`chipTemperature`
`cmxMemoryUsage`
`ddrMemoryUsage`
`leonCssCpuUsage`
`leonCssMemoryUsage`
`leonMssCpuUsage`
`leonMssMemoryUsage`

__init__(self: depthai.SystemInformation) → None ¶

property chipTemperature¶

property cmxMemoryUsage¶

property ddrMemoryUsage¶

property leonCssCpuUsage¶

property leonCssMemoryUsage¶

property leonMssCpuUsage¶

property leonMssMemoryUsage¶

class depthai.SystemLoggerProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

rateHz

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property rateHz¶

class depthai.TensorInfo¶

Bases: pybind11_builtins.pybind11_object

Classes:

`DataType`	Members:
`StorageOrder`	Members:

Methods:

__init__(self)

Attributes:

`dataType`
`dims`
`name`
`numDimensions`
`offset`
`order`
`strides`

class DataType¶

Bases: pybind11_builtins.pybind11_object

Members:

FP16

U8F

INT

FP32

I8

Attributes:

`FP16`
`FP32`
`I8`
`INT`
`U8F`
`name`
`value`

Methods:

__init__(self, value)

FP16 = <DataType.FP16: 0>¶

FP32 = <DataType.FP32: 3>¶

I8 = <DataType.I8: 4>¶

INT = <DataType.INT: 2>¶

U8F = <DataType.U8F: 1>¶

__init__(self: depthai.TensorInfo.DataType, value: int) → None ¶

property name¶

property value¶

class StorageOrder¶

Bases: pybind11_builtins.pybind11_object

Members:

NHWC

NHCW

NCHW

HWC

CHW

WHC

HCW

WCH

CWH

NC

CN

C

H

W

Attributes:

`C`
`CHW`
`CN`
`CWH`
`H`
`HCW`
`HWC`
`NC`
`NCHW`
`NHCW`
`NHWC`
`W`
`WCH`
`WHC`
`name`
`value`

Methods:

__init__(self, value)

C = <StorageOrder.C: 3>¶

CHW = <StorageOrder.CHW: 801>¶

CN = <StorageOrder.CN: 52>¶

CWH = <StorageOrder.CWH: 786>¶

H = <StorageOrder.H: 2>¶

HCW = <StorageOrder.HCW: 561>¶

HWC = <StorageOrder.HWC: 531>¶

NC = <StorageOrder.NC: 67>¶

NCHW = <StorageOrder.NCHW: 17185>¶

NHCW = <StorageOrder.NHCW: 16945>¶

NHWC = <StorageOrder.NHWC: 16915>¶

W = <StorageOrder.W: 1>¶

WCH = <StorageOrder.WCH: 306>¶

WHC = <StorageOrder.WHC: 291>¶

__init__(self: depthai.TensorInfo.StorageOrder, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.TensorInfo) → None ¶

property dataType¶

property dims¶

property name¶

property numDimensions¶

property offset¶

property order¶

property strides¶

class depthai.Timestamp¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(self)
`get`(self)

Attributes:

`nsec`
`sec`

__init__(self: depthai.Timestamp) → None ¶

get(self: depthai.Timestamp) → datetime.timedelta ¶

property nsec¶

property sec¶

class depthai.ToFConfig¶

Bases: depthai.Buffer

Methods:

`__init__`(args, *kwargs)	Overloaded function.
`get`(self)
`set`(self, config)
`setMedianFilter`(self, arg0)

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.ToFConfig) -> None
__init__(self: depthai.ToFConfig, arg0: depthai.RawToFConfig) -> None

get(self: depthai.ToFConfig) → depthai.RawToFConfig ¶

set(self: depthai.ToFConfig, config: depthai.RawToFConfig) → depthai.ToFConfig ¶

setMedianFilter(self: depthai.ToFConfig, arg0: depthai.MedianFilter) → depthai.ToFConfig ¶

class depthai.ToFProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`initialConfig`
`numFramesPool`
`numShaves`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property initialConfig¶

property numFramesPool¶

property numShaves¶

class depthai.TrackedFeature¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(self)

Attributes:

`age`
`harrisScore`
`id`
`position`
`trackingError`

__init__(self: depthai.TrackedFeature) → None ¶

property age¶

property harrisScore¶

property id¶

property position¶

property trackingError¶

class depthai.TrackedFeatures¶

Bases: depthai.Buffer

Methods:

`__init__`(self)
`getSequenceNum`(self)
`getTimestamp`(self)
`getTimestampDevice`(self)
`setSequenceNum`(self, arg0)
`setTimestamp`(self, arg0)
`setTimestampDevice`(self, arg0)

Attributes:

trackedFeatures

__init__(self: depthai.TrackedFeatures) → None ¶

getSequenceNum(self: depthai.TrackedFeatures) → int ¶

getTimestamp(self: depthai.TrackedFeatures) → datetime.timedelta ¶

getTimestampDevice(self: depthai.TrackedFeatures) → datetime.timedelta ¶

setSequenceNum(self: depthai.TrackedFeatures, arg0: int) → depthai.TrackedFeatures ¶

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

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

property trackedFeatures¶

class depthai.TrackerIdAssignmentPolicy¶

Bases: pybind11_builtins.pybind11_object

Members:

UNIQUE_ID

SMALLEST_ID

Attributes:

`SMALLEST_ID`
`UNIQUE_ID`
`name`
`value`

Methods:

__init__(self, value)

SMALLEST_ID = <TrackerIdAssignmentPolicy.SMALLEST_ID: 1>¶

UNIQUE_ID = <TrackerIdAssignmentPolicy.UNIQUE_ID: 0>¶

__init__(self: depthai.TrackerIdAssignmentPolicy, value: int) → None ¶

property name¶

property value¶

class depthai.TrackerType¶

Bases: pybind11_builtins.pybind11_object

Members:

SHORT_TERM_KCF

SHORT_TERM_IMAGELESS

ZERO_TERM_IMAGELESS

ZERO_TERM_COLOR_HISTOGRAM

Attributes:

`SHORT_TERM_IMAGELESS`
`SHORT_TERM_KCF`
`ZERO_TERM_COLOR_HISTOGRAM`
`ZERO_TERM_IMAGELESS`
`name`
`value`

Methods:

__init__(self, value)

SHORT_TERM_IMAGELESS = <TrackerType.SHORT_TERM_IMAGELESS: 3>¶

SHORT_TERM_KCF = <TrackerType.SHORT_TERM_KCF: 1>¶

ZERO_TERM_COLOR_HISTOGRAM = <TrackerType.ZERO_TERM_COLOR_HISTOGRAM: 6>¶

ZERO_TERM_IMAGELESS = <TrackerType.ZERO_TERM_IMAGELESS: 5>¶

__init__(self: depthai.TrackerType, value: int) → None ¶

property name¶

property value¶

class depthai.Tracklet¶

Bases: pybind11_builtins.pybind11_object

Classes:

TrackingStatus

Members:

Methods:

__init__(self)

Attributes:

`age`
`id`
`label`
`roi`
`spatialCoordinates`
`srcImgDetection`
`status`

class TrackingStatus¶

Bases: pybind11_builtins.pybind11_object

Members:

NEW

TRACKED

LOST

REMOVED

Attributes:

`LOST`
`NEW`
`REMOVED`
`TRACKED`
`name`
`value`

Methods:

__init__(self, value)

LOST = <TrackingStatus.LOST: 2>¶

NEW = <TrackingStatus.NEW: 0>¶

REMOVED = <TrackingStatus.REMOVED: 3>¶

TRACKED = <TrackingStatus.TRACKED: 1>¶

__init__(self: depthai.Tracklet.TrackingStatus, value: int) → None ¶

property name¶

property value¶

__init__(self: depthai.Tracklet) → None ¶

property age¶

property id¶

property label¶

property roi¶

property spatialCoordinates¶

property srcImgDetection¶

property status¶

class depthai.Tracklets¶

Bases: depthai.Buffer

Methods:

`__init__`(self)
`getSequenceNum`(self)
`getTimestamp`(self)
`getTimestampDevice`(self)
`setSequenceNum`(self, arg0)
`setTimestamp`(self, arg0)
`setTimestampDevice`(self, arg0)

Attributes:

tracklets

__init__(self: depthai.Tracklets) → None ¶

getSequenceNum(self: depthai.Tracklets) → int ¶

getTimestamp(self: depthai.Tracklets) → datetime.timedelta ¶

getTimestampDevice(self: depthai.Tracklets) → datetime.timedelta ¶

setSequenceNum(self: depthai.Tracklets, arg0: int) → depthai.Tracklets ¶

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

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

property tracklets¶

class depthai.UVCProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`gpioInit`
`gpioStreamOff`
`gpioStreamOn`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property gpioInit¶

property gpioStreamOff¶

property gpioStreamOn¶

class depthai.UsbSpeed¶

Bases: pybind11_builtins.pybind11_object

Members:

UNKNOWN

LOW

FULL

HIGH

SUPER

SUPER_PLUS

Attributes:

`FULL`
`HIGH`
`LOW`
`SUPER`
`SUPER_PLUS`
`UNKNOWN`
`name`
`value`

Methods:

__init__(self, value)

FULL = <UsbSpeed.FULL: 2>¶

HIGH = <UsbSpeed.HIGH: 3>¶

LOW = <UsbSpeed.LOW: 1>¶

SUPER = <UsbSpeed.SUPER: 4>¶

SUPER_PLUS = <UsbSpeed.SUPER_PLUS: 5>¶

UNKNOWN = <UsbSpeed.UNKNOWN: 0>¶

__init__(self: depthai.UsbSpeed, value: int) → None ¶

property name¶

property value¶

class depthai.Version¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(args, *kwargs)	Overloaded function.
`getBuildInfo`(self)
`getSemver`(self)
`toStringSemver`(self)

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.Version, v: str) -> None
__init__(self: depthai.Version, major: int, minor: int, patch: int) -> None

getBuildInfo(self: depthai.Version) → str ¶

getSemver(self: depthai.Version) → depthai.Version ¶

toStringSemver(self: depthai.Version) → str ¶

class depthai.VideoEncoderProperties¶

Bases: pybind11_builtins.pybind11_object

Classes:

`Profile`	Members:
`RateControlMode`	Members:

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`bitrate`
`keyframeFrequency`
`maxBitrate`
`numBFrames`
`numFramesPool`
`outputFrameSize`
`profile`
`quality`
`rateCtrlMode`

class Profile¶

Bases: pybind11_builtins.pybind11_object

Members:

H264_BASELINE

H264_HIGH

H264_MAIN

H265_MAIN

MJPEG

Attributes:

`H264_BASELINE`
`H264_HIGH`
`H264_MAIN`
`H265_MAIN`
`MJPEG`
`name`
`value`

Methods:

__init__(self, value)

H264_BASELINE = <Profile.H264_BASELINE: 0>¶

H264_HIGH = <Profile.H264_HIGH: 1>¶

H264_MAIN = <Profile.H264_MAIN: 2>¶

H265_MAIN = <Profile.H265_MAIN: 3>¶

MJPEG = <Profile.MJPEG: 4>¶

__init__(self: depthai.VideoEncoderProperties.Profile, value: int) → None ¶

property name¶

property value¶

class RateControlMode¶

Bases: pybind11_builtins.pybind11_object

Members:

CBR

VBR

Attributes:

`CBR`
`VBR`
`name`
`value`

Methods:

__init__(self, value)

CBR = <RateControlMode.CBR: 0>¶

VBR = <RateControlMode.VBR: 1>¶

__init__(self: depthai.VideoEncoderProperties.RateControlMode, value: int) → None ¶

property name¶

property value¶

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property bitrate¶

property keyframeFrequency¶

property maxBitrate¶

property numBFrames¶

property numFramesPool¶

property outputFrameSize¶

property profile¶

property quality¶

property rateCtrlMode¶

class depthai.WarpProperties¶

Bases: pybind11_builtins.pybind11_object

Classes:

Interpolation

Members:

Methods:

__init__(*args, **kwargs)

Initialize self.

class Interpolation¶

Bases: pybind11_builtins.pybind11_object

Members:

BILINEAR

BICUBIC

NEAREST_NEIGHBOR

BYPASS

DEFAULT

DEFAULT_DISPARITY_DEPTH

Attributes:

`BICUBIC`
`BILINEAR`
`BYPASS`
`DEFAULT`
`DEFAULT_DISPARITY_DEPTH`
`NEAREST_NEIGHBOR`
`name`
`value`

Methods:

__init__(self, value)

BICUBIC = <Interpolation.BICUBIC: 1>¶

BILINEAR = <Interpolation.BILINEAR: 0>¶

BYPASS = <Interpolation.NEAREST_NEIGHBOR: 2>¶

DEFAULT = <Interpolation.BICUBIC: 1>¶

DEFAULT_DISPARITY_DEPTH = <Interpolation.NEAREST_NEIGHBOR: 2>¶

NEAREST_NEIGHBOR = <Interpolation.NEAREST_NEIGHBOR: 2>¶

__init__(self: depthai.Interpolation, value: int) → None ¶

property name¶

property value¶

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

class depthai.XLinkConnection¶

Bases: pybind11_builtins.pybind11_object

Methods:

`__init__`(args, *kwargs)	Overloaded function.
`bootBootloader`(devInfo)
`getAllConnectedDevices`(state, skipInvalidDevices)
`getDeviceByMxId`(mxId, state, skipInvalidDevice)
`getFirstDevice`(state, skipInvalidDevice)
`getGlobalProfilingData`()

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: depthai.XLinkConnection, arg0: depthai.DeviceInfo, arg1: list[int]) -> None
__init__(self: depthai.XLinkConnection, arg0: depthai.DeviceInfo, arg1: str) -> None
__init__(self: depthai.XLinkConnection, arg0: depthai.DeviceInfo) -> None

static bootBootloader(devInfo: depthai.DeviceInfo) → depthai.DeviceInfo ¶

static getAllConnectedDevices(state: depthai.XLinkDeviceState = <XLinkDeviceState.X_LINK_ANY_STATE: 0>, skipInvalidDevices: bool = True) → list[depthai.DeviceInfo]¶

static getDeviceByMxId(mxId: str, state: depthai.XLinkDeviceState = <XLinkDeviceState.X_LINK_ANY_STATE: 0>, skipInvalidDevice: bool = True) → tuple[bool, depthai.DeviceInfo]¶

static getFirstDevice(state: depthai.XLinkDeviceState = <XLinkDeviceState.X_LINK_ANY_STATE: 0>, skipInvalidDevice: bool = True) → tuple[bool, depthai.DeviceInfo]¶

static getGlobalProfilingData() → depthai.ProfilingData ¶

class depthai.XLinkDeviceState¶

Bases: pybind11_builtins.pybind11_object

Members:

X_LINK_ANY_STATE

X_LINK_BOOTED

X_LINK_UNBOOTED

X_LINK_BOOTLOADER

X_LINK_FLASH_BOOTED

Attributes:

`X_LINK_ANY_STATE`
`X_LINK_BOOTED`
`X_LINK_BOOTLOADER`
`X_LINK_FLASH_BOOTED`
`X_LINK_UNBOOTED`
`name`
`value`

Methods:

__init__(self, value)

X_LINK_ANY_STATE = <XLinkDeviceState.X_LINK_ANY_STATE: 0>¶

X_LINK_BOOTED = <XLinkDeviceState.X_LINK_BOOTED: 1>¶

X_LINK_BOOTLOADER = <XLinkDeviceState.X_LINK_BOOTLOADER: 3>¶

X_LINK_FLASH_BOOTED = <XLinkDeviceState.X_LINK_FLASH_BOOTED: 4>¶

X_LINK_UNBOOTED = <XLinkDeviceState.X_LINK_UNBOOTED: 2>¶

__init__(self: depthai.XLinkDeviceState, value: int) → None ¶

property name¶

property value¶

exception depthai.XLinkError¶: Bases: RuntimeError

class depthai.XLinkError_t¶

Bases: pybind11_builtins.pybind11_object

Members:

X_LINK_SUCCESS

X_LINK_ALREADY_OPEN

X_LINK_COMMUNICATION_NOT_OPEN

X_LINK_COMMUNICATION_FAIL

X_LINK_COMMUNICATION_UNKNOWN_ERROR

X_LINK_DEVICE_NOT_FOUND

X_LINK_TIMEOUT

X_LINK_ERROR

X_LINK_OUT_OF_MEMORY

X_LINK_INSUFFICIENT_PERMISSIONS

X_LINK_DEVICE_ALREADY_IN_USE

X_LINK_NOT_IMPLEMENTED

X_LINK_INIT_USB_ERROR

X_LINK_INIT_TCP_IP_ERROR

X_LINK_INIT_PCIE_ERROR

Attributes:

`X_LINK_ALREADY_OPEN`
`X_LINK_COMMUNICATION_FAIL`
`X_LINK_COMMUNICATION_NOT_OPEN`
`X_LINK_COMMUNICATION_UNKNOWN_ERROR`
`X_LINK_DEVICE_ALREADY_IN_USE`
`X_LINK_DEVICE_NOT_FOUND`
`X_LINK_ERROR`
`X_LINK_INIT_PCIE_ERROR`
`X_LINK_INIT_TCP_IP_ERROR`
`X_LINK_INIT_USB_ERROR`
`X_LINK_INSUFFICIENT_PERMISSIONS`
`X_LINK_NOT_IMPLEMENTED`
`X_LINK_OUT_OF_MEMORY`
`X_LINK_SUCCESS`
`X_LINK_TIMEOUT`
`name`
`value`

Methods:

__init__(self, value)

X_LINK_ALREADY_OPEN = <XLinkError_t.X_LINK_ALREADY_OPEN: 1>¶

X_LINK_COMMUNICATION_FAIL = <XLinkError_t.X_LINK_COMMUNICATION_FAIL: 3>¶

X_LINK_COMMUNICATION_NOT_OPEN = <XLinkError_t.X_LINK_COMMUNICATION_NOT_OPEN: 2>¶

X_LINK_COMMUNICATION_UNKNOWN_ERROR = <XLinkError_t.X_LINK_COMMUNICATION_UNKNOWN_ERROR: 4>¶

X_LINK_DEVICE_ALREADY_IN_USE = <XLinkError_t.X_LINK_DEVICE_ALREADY_IN_USE: 10>¶

X_LINK_DEVICE_NOT_FOUND = <XLinkError_t.X_LINK_DEVICE_NOT_FOUND: 5>¶

X_LINK_ERROR = <XLinkError_t.X_LINK_ERROR: 7>¶

X_LINK_INIT_PCIE_ERROR = <XLinkError_t.X_LINK_INIT_PCIE_ERROR: 14>¶

X_LINK_INIT_TCP_IP_ERROR = <XLinkError_t.X_LINK_INIT_TCP_IP_ERROR: 13>¶

X_LINK_INIT_USB_ERROR = <XLinkError_t.X_LINK_INIT_USB_ERROR: 12>¶

X_LINK_INSUFFICIENT_PERMISSIONS = <XLinkError_t.X_LINK_INSUFFICIENT_PERMISSIONS: 9>¶

X_LINK_NOT_IMPLEMENTED = <XLinkError_t.X_LINK_NOT_IMPLEMENTED: 11>¶

X_LINK_OUT_OF_MEMORY = <XLinkError_t.X_LINK_OUT_OF_MEMORY: 8>¶

X_LINK_SUCCESS = <XLinkError_t.X_LINK_SUCCESS: 0>¶

X_LINK_TIMEOUT = <XLinkError_t.X_LINK_TIMEOUT: 6>¶

__init__(self: depthai.XLinkError_t, value: int) → None ¶

property name¶

property value¶

class depthai.XLinkInProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`maxDataSize`
`numFrames`
`streamName`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property maxDataSize¶

property numFrames¶

property streamName¶

class depthai.XLinkOutProperties¶

Bases: pybind11_builtins.pybind11_object

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`maxFpsLimit`
`metadataOnly`
`streamName`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property maxFpsLimit¶

property metadataOnly¶

property streamName¶

class depthai.XLinkPlatform¶

Bases: pybind11_builtins.pybind11_object

Members:

X_LINK_ANY_PLATFORM

X_LINK_MYRIAD_2

X_LINK_MYRIAD_X

Attributes:

`X_LINK_ANY_PLATFORM`
`X_LINK_MYRIAD_2`
`X_LINK_MYRIAD_X`
`name`
`value`

Methods:

__init__(self, value)

X_LINK_ANY_PLATFORM = <XLinkPlatform.X_LINK_ANY_PLATFORM: 0>¶

X_LINK_MYRIAD_2 = <XLinkPlatform.X_LINK_MYRIAD_2: 2450>¶

X_LINK_MYRIAD_X = <XLinkPlatform.X_LINK_MYRIAD_X: 2480>¶

__init__(self: depthai.XLinkPlatform, value: int) → None ¶

property name¶

property value¶

class depthai.XLinkProtocol¶

Bases: pybind11_builtins.pybind11_object

Members:

X_LINK_USB_VSC

X_LINK_USB_CDC

X_LINK_PCIE

X_LINK_TCP_IP

X_LINK_IPC

X_LINK_NMB_OF_PROTOCOLS

X_LINK_ANY_PROTOCOL

Attributes:

`X_LINK_ANY_PROTOCOL`
`X_LINK_IPC`
`X_LINK_NMB_OF_PROTOCOLS`
`X_LINK_PCIE`
`X_LINK_TCP_IP`
`X_LINK_USB_CDC`
`X_LINK_USB_VSC`
`name`
`value`

Methods:

__init__(self, value)

X_LINK_ANY_PROTOCOL = <XLinkProtocol.X_LINK_ANY_PROTOCOL: 6>¶

X_LINK_IPC = <XLinkProtocol.X_LINK_IPC: 3>¶

X_LINK_NMB_OF_PROTOCOLS = <XLinkProtocol.X_LINK_NMB_OF_PROTOCOLS: 5>¶

X_LINK_PCIE = <XLinkProtocol.X_LINK_PCIE: 2>¶

X_LINK_TCP_IP = <XLinkProtocol.X_LINK_TCP_IP: 4>¶

X_LINK_USB_CDC = <XLinkProtocol.X_LINK_USB_CDC: 1>¶

X_LINK_USB_VSC = <XLinkProtocol.X_LINK_USB_VSC: 0>¶

__init__(self: depthai.XLinkProtocol, value: int) → None ¶

property name¶

property value¶

exception depthai.XLinkReadError¶: Bases: depthai.XLinkError

exception depthai.XLinkWriteError¶: Bases: depthai.XLinkError

class depthai.connectionInterface¶

Bases: pybind11_builtins.pybind11_object

Members:

USB

ETHERNET

WIFI

Attributes:

`ETHERNET`
`USB`
`WIFI`
`name`
`value`

Methods:

__init__(self, value)

ETHERNET = <connectionInterface.ETHERNET: 1>¶

USB = <connectionInterface.USB: 0>¶

WIFI = <connectionInterface.WIFI: 2>¶

__init__(self: depthai.connectionInterface, value: int) → None ¶

property name¶

property value¶

depthai.isDatatypeSubclassOf(arg0: depthai.DatatypeEnum, arg1: depthai.DatatypeEnum) → bool ¶

Nodes¶

Classes:

class depthai.node.AprilTag¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.AprilTagProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`setWaitForConfigInput`(self, wait)

Attributes:

`initialConfig`
`inputConfig`
`inputImage`
`out`
`passthroughInputImage`

Properties¶

alias of depthai.AprilTagProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`initialConfig`
`inputConfigSync`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property initialConfig¶

property inputConfig¶

property inputImage¶

property out¶

property passthroughInputImage¶

setWaitForConfigInput(self: depthai.node.AprilTag, wait: bool) → None ¶

class depthai.node.Camera¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.CameraProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getBoardSocket`(self)
`getCalibrationAlpha`(self)
`getCamera`(self)
`getFps`(self)
`getHeight`(self)
`getImageOrientation`(self)
`getMeshSource`(self)
`getMeshStep`(self)
`getPreviewHeight`(self)
`getPreviewSize`(self)
`getPreviewWidth`(self)
`getSize`(self)
`getStillHeight`(self)
`getStillSize`(self)
`getStillWidth`(self)
`getVideoHeight`(self)
`getVideoSize`(self)
`getVideoWidth`(self)
`getWidth`(self)
`loadMeshData`(self, warpMesh)
`loadMeshFile`(self, warpMesh)
`setBoardSocket`(self, boardSocket)
`setCalibrationAlpha`(self, alpha)
`setCamera`(self, name)
`setFps`(self, fps)
`setImageOrientation`(self, imageOrientation)
`setIsp3aFps`(self, isp3aFps)
`setMeshSource`(self, source)
`setMeshStep`(self, width, height)
`setPreviewSize`(args, *kwargs)	Overloaded function.
`setRawOutputPacked`(self, packed)
`setSize`(args, *kwargs)	Overloaded function.
`setStillSize`(args, *kwargs)	Overloaded function.
`setVideoSize`(args, *kwargs)	Overloaded function.

Attributes:

`frameEvent`
`initialControl`
`inputConfig`
`inputControl`
`isp`
`preview`
`raw`
`still`
`video`

Properties¶

alias of depthai.CameraProperties Classes:

`ColorOrder`	Members:
`WarpMeshSource`	Members:

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`boardSocket`
`calibAlpha`
`cameraName`
`colorOrder`
`fp16`
`fps`
`imageOrientation`
`initialControl`
`interleaved`
`isp3aFps`
`ispScale`
`numFramesPoolIsp`
`numFramesPoolPreview`
`numFramesPoolRaw`
`numFramesPoolStill`
`numFramesPoolVideo`
`previewHeight`
`previewKeepAspectRatio`
`previewWidth`
`rawPacked`
`resolutionHeight`
`resolutionWidth`
`sensorCropX`
`sensorCropY`
`sensorType`
`stillHeight`
`stillWidth`
`videoHeight`
`videoWidth`
`warpMeshHeight`
`warpMeshSource`
`warpMeshStepHeight`
`warpMeshStepWidth`
`warpMeshUri`
`warpMeshWidth`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property frameEvent¶

getBoardSocket(self: depthai.node.Camera) → depthai.CameraBoardSocket ¶

getCalibrationAlpha(self: depthai.node.Camera) → Optional[float]¶

getCamera(self: depthai.node.Camera) → str ¶

getFps(self: depthai.node.Camera) → float ¶

getHeight(self: depthai.node.Camera) → int ¶

getImageOrientation(self: depthai.node.Camera) → depthai.CameraImageOrientation ¶

getMeshSource(self: depthai.node.Camera) → depthai.CameraProperties.WarpMeshSource ¶

getMeshStep(self: depthai.node.Camera) → tuple[int, int]¶

getPreviewHeight(self: depthai.node.Camera) → int ¶

getPreviewSize(self: depthai.node.Camera) → tuple[int, int]¶

getPreviewWidth(self: depthai.node.Camera) → int ¶

getSize(self: depthai.node.Camera) → tuple[int, int]¶

getStillHeight(self: depthai.node.Camera) → int ¶

getStillSize(self: depthai.node.Camera) → tuple[int, int]¶

getStillWidth(self: depthai.node.Camera) → int ¶

getVideoHeight(self: depthai.node.Camera) → int ¶

getVideoSize(self: depthai.node.Camera) → tuple[int, int]¶

getVideoWidth(self: depthai.node.Camera) → int ¶

getWidth(self: depthai.node.Camera) → int ¶

property initialControl¶

property inputConfig¶

property inputControl¶

property isp¶

loadMeshData(self: depthai.node.Camera, warpMesh: buffer) → None ¶

loadMeshFile(self: depthai.node.Camera, warpMesh: Path) → None ¶

property preview¶

property raw¶

setBoardSocket(self: depthai.node.Camera, boardSocket: depthai.CameraBoardSocket) → None ¶

setCalibrationAlpha(self: depthai.node.Camera, alpha: float) → None ¶

setCamera(self: depthai.node.Camera, name: str) → None ¶

setFps(self: depthai.node.Camera, fps: float) → None ¶

setImageOrientation(self: depthai.node.Camera, imageOrientation: depthai.CameraImageOrientation) → None ¶

setIsp3aFps(self: depthai.node.Camera, isp3aFps: int) → None ¶

setMeshSource(self: depthai.node.Camera, source: depthai.CameraProperties.WarpMeshSource) → None ¶

setMeshStep(self: depthai.node.Camera, width: int, height: int) → None ¶

setPreviewSize(*args, **kwargs)¶

Overloaded function.

setPreviewSize(self: depthai.node.Camera, width: int, height: int) -> None
setPreviewSize(self: depthai.node.Camera, size: tuple[int, int]) -> None

setRawOutputPacked(self: depthai.node.Camera, packed: bool) → None ¶

setSize(*args, **kwargs)¶

Overloaded function.

setSize(self: depthai.node.Camera, width: int, height: int) -> None
setSize(self: depthai.node.Camera, size: tuple[int, int]) -> None

setStillSize(*args, **kwargs)¶

Overloaded function.

setStillSize(self: depthai.node.Camera, width: int, height: int) -> None
setStillSize(self: depthai.node.Camera, size: tuple[int, int]) -> None

setVideoSize(*args, **kwargs)¶

Overloaded function.

setVideoSize(self: depthai.node.Camera, width: int, height: int) -> None
setVideoSize(self: depthai.node.Camera, size: tuple[int, int]) -> None

property still¶

property video¶

class depthai.node.Cast¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.CastProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`setNumFramesPool`(self, arg0)
`setOffset`(self, arg0)
`setOutputFrameType`(self, arg0)
`setScale`(self, arg0)

Attributes:

`input`
`output`
`passthroughInput`

Properties¶

alias of depthai.CastProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`numFramesPool`
`offset`
`outputType`
`scale`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property input¶

property output¶

property passthroughInput¶

setNumFramesPool(self: depthai.node.Cast, arg0: int) → depthai.node.Cast ¶

setOffset(self: depthai.node.Cast, arg0: float) → depthai.node.Cast ¶

setOutputFrameType(self: depthai.node.Cast, arg0: depthai.RawImgFrame.Type) → depthai.node.Cast ¶

setScale(self: depthai.node.Cast, arg0: float) → depthai.node.Cast ¶

class depthai.node.ColorCamera¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.ColorCameraProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getBoardSocket`(self)
`getCamId`(self)
`getCamera`(self)
`getColorOrder`(self)
`getFp16`(self)
`getFps`(self)
`getFrameEventFilter`(self)
`getImageOrientation`(self)
`getInterleaved`(self)
`getIspHeight`(self)
`getIspNumFramesPool`(self)
`getIspSize`(self)
`getIspWidth`(self)
`getPreviewHeight`(self)
`getPreviewKeepAspectRatio`(self)
`getPreviewNumFramesPool`(self)
`getPreviewSize`(self)
`getPreviewWidth`(self)
`getRawNumFramesPool`(self)
`getResolution`(self)
`getResolutionHeight`(self)
`getResolutionSize`(self)
`getResolutionWidth`(self)
`getSensorCrop`(self)
`getSensorCropX`(self)
`getSensorCropY`(self)
`getStillHeight`(self)
`getStillNumFramesPool`(self)
`getStillSize`(self)
`getStillWidth`(self)
`getVideoHeight`(self)
`getVideoNumFramesPool`(self)
`getVideoSize`(self)
`getVideoWidth`(self)
`getWaitForConfigInput`(self)
`sensorCenterCrop`(self)
`setBoardSocket`(self, boardSocket)
`setCamId`(self, arg0)
`setCamera`(self, name)
`setColorOrder`(self, colorOrder)
`setFp16`(self, fp16)
`setFps`(self, fps)
`setFrameEventFilter`(self, events)
`setImageOrientation`(self, imageOrientation)
`setInterleaved`(self, interleaved)
`setIsp3aFps`(self, isp3aFps)
`setIspNumFramesPool`(self, arg0)
`setIspScale`(args, *kwargs)	Overloaded function.
`setNumFramesPool`(self, raw, isp, preview, …)
`setPreviewKeepAspectRatio`(self, keep)
`setPreviewNumFramesPool`(self, arg0)
`setPreviewSize`(args, *kwargs)	Overloaded function.
`setRawNumFramesPool`(self, arg0)
`setRawOutputPacked`(self, packed)
`setResolution`(self, resolution)
`setSensorCrop`(self, x, y)
`setStillNumFramesPool`(self, arg0)
`setStillSize`(args, *kwargs)	Overloaded function.
`setVideoNumFramesPool`(self, arg0)
`setVideoSize`(args, *kwargs)	Overloaded function.
`setWaitForConfigInput`(self, wait)

Attributes:

`frameEvent`
`initialControl`
`inputConfig`
`inputControl`
`isp`
`preview`
`raw`
`still`
`video`

Properties¶

alias of depthai.ColorCameraProperties Classes:

`ColorOrder`	Members:
`SensorResolution`	Members:

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`boardSocket`
`colorOrder`
`eventFilter`
`fp16`
`fps`
`imageOrientation`
`initialControl`
`interleaved`
`isp3aFps`
`ispScale`
`numFramesPoolIsp`
`numFramesPoolPreview`
`numFramesPoolRaw`
`numFramesPoolStill`
`numFramesPoolVideo`
`previewHeight`
`previewKeepAspectRatio`
`previewWidth`
`resolution`
`sensorCropX`
`sensorCropY`
`stillHeight`
`stillWidth`
`videoHeight`
`videoWidth`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property frameEvent¶

getBoardSocket(self: depthai.node.ColorCamera) → depthai.CameraBoardSocket ¶

getCamId(self: depthai.node.ColorCamera) → int ¶

getCamera(self: depthai.node.ColorCamera) → str ¶

getColorOrder(self: depthai.node.ColorCamera) → depthai.ColorCameraProperties.ColorOrder ¶

getFp16(self: depthai.node.ColorCamera) → bool ¶

getFps(self: depthai.node.ColorCamera) → float ¶

getFrameEventFilter(self: depthai.node.ColorCamera) → list[depthai.FrameEvent]¶

getImageOrientation(self: depthai.node.ColorCamera) → depthai.CameraImageOrientation ¶

getInterleaved(self: depthai.node.ColorCamera) → bool ¶

getIspHeight(self: depthai.node.ColorCamera) → int ¶

getIspNumFramesPool(self: depthai.node.ColorCamera) → int ¶

getIspSize(self: depthai.node.ColorCamera) → tuple[int, int]¶

getIspWidth(self: depthai.node.ColorCamera) → int ¶

getPreviewHeight(self: depthai.node.ColorCamera) → int ¶

getPreviewKeepAspectRatio(self: depthai.node.ColorCamera) → bool ¶

getPreviewNumFramesPool(self: depthai.node.ColorCamera) → int ¶

getPreviewSize(self: depthai.node.ColorCamera) → tuple[int, int]¶

getPreviewWidth(self: depthai.node.ColorCamera) → int ¶

getRawNumFramesPool(self: depthai.node.ColorCamera) → int ¶

getResolution(self: depthai.node.ColorCamera) → depthai.ColorCameraProperties.SensorResolution ¶

getResolutionHeight(self: depthai.node.ColorCamera) → int ¶

getResolutionSize(self: depthai.node.ColorCamera) → tuple[int, int]¶

getResolutionWidth(self: depthai.node.ColorCamera) → int ¶

getSensorCrop(self: depthai.node.ColorCamera) → tuple[float, float]¶

getSensorCropX(self: depthai.node.ColorCamera) → float ¶

getSensorCropY(self: depthai.node.ColorCamera) → float ¶

getStillHeight(self: depthai.node.ColorCamera) → int ¶

getStillNumFramesPool(self: depthai.node.ColorCamera) → int ¶

getStillSize(self: depthai.node.ColorCamera) → tuple[int, int]¶

getStillWidth(self: depthai.node.ColorCamera) → int ¶

getVideoHeight(self: depthai.node.ColorCamera) → int ¶

getVideoNumFramesPool(self: depthai.node.ColorCamera) → int ¶

getVideoSize(self: depthai.node.ColorCamera) → tuple[int, int]¶

getVideoWidth(self: depthai.node.ColorCamera) → int ¶

getWaitForConfigInput(self: depthai.node.ColorCamera) → bool ¶

property initialControl¶

property inputConfig¶

property inputControl¶

property isp¶

property preview¶

property raw¶

sensorCenterCrop(self: depthai.node.ColorCamera) → None ¶

setBoardSocket(self: depthai.node.ColorCamera, boardSocket: depthai.CameraBoardSocket) → None ¶

setCamId(self: depthai.node.ColorCamera, arg0: int) → None ¶

setCamera(self: depthai.node.ColorCamera, name: str) → None ¶

setColorOrder(self: depthai.node.ColorCamera, colorOrder: depthai.ColorCameraProperties.ColorOrder) → None ¶

setFp16(self: depthai.node.ColorCamera, fp16: bool) → None ¶

setFps(self: depthai.node.ColorCamera, fps: float) → None ¶

setFrameEventFilter(self: depthai.node.ColorCamera, events: list[depthai.FrameEvent]) → None ¶

setImageOrientation(self: depthai.node.ColorCamera, imageOrientation: depthai.CameraImageOrientation) → None ¶

setInterleaved(self: depthai.node.ColorCamera, interleaved: bool) → None ¶

setIsp3aFps(self: depthai.node.ColorCamera, isp3aFps: int) → None ¶

setIspNumFramesPool(self: depthai.node.ColorCamera, arg0: int) → None ¶

setIspScale(*args, **kwargs)¶

Overloaded function.

setIspScale(self: depthai.node.ColorCamera, numerator: int, denominator: int) -> None
setIspScale(self: depthai.node.ColorCamera, scale: tuple[int, int]) -> None
setIspScale(self: depthai.node.ColorCamera, horizNum: int, horizDenom: int, vertNum: int, vertDenom: int) -> None
setIspScale(self: depthai.node.ColorCamera, horizScale: tuple[int, int], vertScale: tuple[int, int]) -> None

setNumFramesPool(self: depthai.node.ColorCamera, raw: int, isp: int, preview: int, video: int, still: int) → None ¶

setPreviewKeepAspectRatio(self: depthai.node.ColorCamera, keep: bool) → None ¶

setPreviewNumFramesPool(self: depthai.node.ColorCamera, arg0: int) → None ¶

setPreviewSize(*args, **kwargs)¶

Overloaded function.

setPreviewSize(self: depthai.node.ColorCamera, width: int, height: int) -> None
setPreviewSize(self: depthai.node.ColorCamera, size: tuple[int, int]) -> None

setRawNumFramesPool(self: depthai.node.ColorCamera, arg0: int) → None ¶

setRawOutputPacked(self: depthai.node.ColorCamera, packed: bool) → None ¶

setResolution(self: depthai.node.ColorCamera, resolution: depthai.ColorCameraProperties.SensorResolution) → None ¶

setSensorCrop(self: depthai.node.ColorCamera, x: float, y: float) → None ¶

setStillNumFramesPool(self: depthai.node.ColorCamera, arg0: int) → None ¶

setStillSize(*args, **kwargs)¶

Overloaded function.

setStillSize(self: depthai.node.ColorCamera, width: int, height: int) -> None
setStillSize(self: depthai.node.ColorCamera, size: tuple[int, int]) -> None

setVideoNumFramesPool(self: depthai.node.ColorCamera, arg0: int) → None ¶

setVideoSize(*args, **kwargs)¶

Overloaded function.

setVideoSize(self: depthai.node.ColorCamera, width: int, height: int) -> None
setVideoSize(self: depthai.node.ColorCamera, size: tuple[int, int]) -> None

setWaitForConfigInput(self: depthai.node.ColorCamera, wait: bool) → None ¶

property still¶

property video¶

class depthai.node.DetectionNetwork¶

Bases: depthai.node.NeuralNetwork

Classes:

Properties

alias of depthai.DetectionNetworkProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getConfidenceThreshold`(self)
`setConfidenceThreshold`(self, thresh)

Attributes:

`input`
`out`
`outNetwork`
`passthrough`

Properties¶

alias of depthai.DetectionNetworkProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

parser

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getConfidenceThreshold(self: depthai.node.DetectionNetwork) → float ¶

property input¶

property out¶

property outNetwork¶

property passthrough¶

setConfidenceThreshold(self: depthai.node.DetectionNetwork, thresh: float) → None ¶

class depthai.node.DetectionParser¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.DetectionParserProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getAnchorMasks`(self)
`getAnchors`(self)
`getConfidenceThreshold`(self)
`getCoordinateSize`(self)
`getIouThreshold`(self)
`getNNFamily`(self)
`getNumClasses`(self)
`getNumFramesPool`(self)
`setAnchorMasks`(self, anchorMasks, list[int]])
`setAnchors`(self, anchors)
`setBlob`(self, blob)
`setConfidenceThreshold`(self, thresh)
`setCoordinateSize`(self, coordinates)
`setIouThreshold`(self, thresh)
`setNNFamily`(self, type)
`setNumClasses`(self, numClasses)
`setNumFramesPool`(self, numFramesPool)

Attributes:

`input`
`out`

Properties¶

alias of depthai.DetectionParserProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

parser

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getAnchorMasks(self: depthai.node.DetectionParser) → dict[str, list[int]]¶

getAnchors(self: depthai.node.DetectionParser) → list[float]¶

getConfidenceThreshold(self: depthai.node.DetectionParser) → float ¶

getCoordinateSize(self: depthai.node.DetectionParser) → int ¶

getIouThreshold(self: depthai.node.DetectionParser) → float ¶

getNNFamily(self: depthai.node.DetectionParser) → depthai.DetectionNetworkType ¶

getNumClasses(self: depthai.node.DetectionParser) → int ¶

getNumFramesPool(self: depthai.node.DetectionParser) → int ¶

property input¶

property out¶

setAnchorMasks(self: depthai.node.DetectionParser, anchorMasks: dict[str, list[int]]) → None ¶

setAnchors(self: depthai.node.DetectionParser, anchors: list[float]) → None ¶

setBlob(self: depthai.node.DetectionParser, blob: depthai.OpenVINO.Blob) → None ¶

setConfidenceThreshold(self: depthai.node.DetectionParser, thresh: float) → None ¶

setCoordinateSize(self: depthai.node.DetectionParser, coordinates: int) → None ¶

setIouThreshold(self: depthai.node.DetectionParser, thresh: float) → None ¶

setNNFamily(self: depthai.node.DetectionParser, type: depthai.DetectionNetworkType) → None ¶

setNumClasses(self: depthai.node.DetectionParser, numClasses: int) → None ¶

setNumFramesPool(self: depthai.node.DetectionParser, numFramesPool: int) → None ¶

class depthai.node.EdgeDetector¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.EdgeDetectorProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getWaitForConfigInput`(self)
`setMaxOutputFrameSize`(self, arg0)
`setNumFramesPool`(self, arg0)
`setWaitForConfigInput`(self, wait)

Attributes:

`initialConfig`
`inputConfig`
`inputImage`
`outputImage`

Properties¶

alias of depthai.EdgeDetectorProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`initialConfig`
`numFramesPool`
`outputFrameSize`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getWaitForConfigInput(self: depthai.node.EdgeDetector) → bool ¶

property initialConfig¶

property inputConfig¶

property inputImage¶

property outputImage¶

setMaxOutputFrameSize(self: depthai.node.EdgeDetector, arg0: int) → None ¶

setNumFramesPool(self: depthai.node.EdgeDetector, arg0: int) → None ¶

setWaitForConfigInput(self: depthai.node.EdgeDetector, wait: bool) → None ¶

class depthai.node.FeatureTracker¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.FeatureTrackerProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getWaitForConfigInput`(self)
`setHardwareResources`(self, numShaves, …)
`setWaitForConfigInput`(self, wait)

Attributes:

`initialConfig`
`inputConfig`
`inputImage`
`outputFeatures`
`passthroughInputImage`

Properties¶

alias of depthai.FeatureTrackerProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`initialConfig`
`numMemorySlices`
`numShaves`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getWaitForConfigInput(self: depthai.node.FeatureTracker) → bool ¶

property initialConfig¶

property inputConfig¶

property inputImage¶

property outputFeatures¶

property passthroughInputImage¶

setHardwareResources(self: depthai.node.FeatureTracker, numShaves: int, numMemorySlices: int) → None ¶

setWaitForConfigInput(self: depthai.node.FeatureTracker, wait: bool) → None ¶

class depthai.node.IMU¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.IMUProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`enableFirmwareUpdate`(self, arg0)
`enableIMUSensor`(args, *kwargs)	Overloaded function.
`getBatchReportThreshold`(self)
`getMaxBatchReports`(self)
`setBatchReportThreshold`(self, …)
`setMaxBatchReports`(self, maxBatchReports)

Attributes:

out

Properties¶

alias of depthai.IMUProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`batchReportThreshold`
`enableFirmwareUpdate`
`imuSensors`
`maxBatchReports`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

enableFirmwareUpdate(self: depthai.node.IMU, arg0: bool) → None ¶

enableIMUSensor(*args, **kwargs)¶

Overloaded function.

enableIMUSensor(self: depthai.node.IMU, sensorConfig: depthai.IMUSensorConfig) -> None
enableIMUSensor(self: depthai.node.IMU, sensorConfigs: list[depthai.IMUSensorConfig]) -> None
enableIMUSensor(self: depthai.node.IMU, sensor: depthai.IMUSensor, reportRate: int) -> None
enableIMUSensor(self: depthai.node.IMU, sensors: list[depthai.IMUSensor], reportRate: int) -> None

getBatchReportThreshold(self: depthai.node.IMU) → int ¶

getMaxBatchReports(self: depthai.node.IMU) → int ¶

property out¶

setBatchReportThreshold(self: depthai.node.IMU, batchReportThreshold: int) → None ¶

setMaxBatchReports(self: depthai.node.IMU, maxBatchReports: int) → None ¶

class depthai.node.ImageAlign¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.ImageAlignProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`setInterpolation`(self, arg0)
`setNumFramesPool`(self, arg0)
`setNumShaves`(self, arg0)
`setOutKeepAspectRatio`(self, arg0)
`setOutputSize`(self, arg0, arg1)

Attributes:

`initialConfig`
`input`
`inputAlignTo`
`inputConfig`
`outputAligned`
`passthroughInput`

Properties¶

alias of depthai.ImageAlignProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`alignHeight`
`alignWidth`
`initialConfig`
`interpolation`
`numFramesPool`
`numShaves`
`outKeepAspectRatio`
`warpHwIds`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property initialConfig¶

property input¶

property inputAlignTo¶

property inputConfig¶

property outputAligned¶

property passthroughInput¶

setInterpolation(self: depthai.node.ImageAlign, arg0: depthai.Interpolation) → depthai.node.ImageAlign ¶

setNumFramesPool(self: depthai.node.ImageAlign, arg0: int) → depthai.node.ImageAlign ¶

setNumShaves(self: depthai.node.ImageAlign, arg0: int) → depthai.node.ImageAlign ¶

setOutKeepAspectRatio(self: depthai.node.ImageAlign, arg0: bool) → depthai.node.ImageAlign ¶

setOutputSize(self: depthai.node.ImageAlign, arg0: int, arg1: int) → depthai.node.ImageAlign ¶

class depthai.node.ImageManip¶

Bases: depthai.Node

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getWaitForConfigInput`(self)
`setCenterCrop`(self, arg0, arg1)
`setCropRect`(self, arg0, arg1, arg2, arg3)
`setFrameType`(self, arg0)
`setHorizontalFlip`(self, arg0)
`setKeepAspectRatio`(self, arg0)
`setMaxOutputFrameSize`(self, arg0)
`setNumFramesPool`(self, arg0)
`setResize`(self, arg0, arg1)
`setResizeThumbnail`(self, arg0, arg1, arg2, …)
`setWaitForConfigInput`(self, wait)
`setWarpMesh`(args, *kwargs)	Overloaded function.

Attributes:

`initialConfig`
`inputConfig`
`inputImage`
`out`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getWaitForConfigInput(self: depthai.node.ImageManip) → bool ¶

property initialConfig¶

property inputConfig¶

property inputImage¶

property out¶

setCenterCrop(self: depthai.node.ImageManip, arg0: float, arg1: float) → None ¶

setCropRect(self: depthai.node.ImageManip, arg0: float, arg1: float, arg2: float, arg3: float) → None ¶

setFrameType(self: depthai.node.ImageManip, arg0: depthai.RawImgFrame.Type) → None ¶

setHorizontalFlip(self: depthai.node.ImageManip, arg0: bool) → None ¶

setKeepAspectRatio(self: depthai.node.ImageManip, arg0: bool) → None ¶

setMaxOutputFrameSize(self: depthai.node.ImageManip, arg0: int) → None ¶

setNumFramesPool(self: depthai.node.ImageManip, arg0: int) → None ¶

setResize(self: depthai.node.ImageManip, arg0: int, arg1: int) → None ¶

setResizeThumbnail(self: depthai.node.ImageManip, arg0: int, arg1: int, arg2: int, arg3: int, arg4: int) → None ¶

setWaitForConfigInput(self: depthai.node.ImageManip, wait: bool) → None ¶

setWarpMesh(*args, **kwargs)¶

Overloaded function.

setWarpMesh(self: depthai.node.ImageManip, arg0: list[depthai.Point2f], arg1: int, arg2: int) -> None
setWarpMesh(self: depthai.node.ImageManip, arg0: list[tuple[float, float]], arg1: int, arg2: int) -> None

class depthai.node.MessageDemux¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.MessageDemuxProperties

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`input`
`outputs`

Properties¶

alias of depthai.MessageDemuxProperties Methods:

__init__(*args, **kwargs)

Initialize self.

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property input¶

property outputs¶

class depthai.node.MobileNetDetectionNetwork¶

Bases: depthai.node.DetectionNetwork

Methods:

__init__(*args, **kwargs)

Initialize self.

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

class depthai.node.MobileNetSpatialDetectionNetwork¶

Bases: depthai.node.SpatialDetectionNetwork

Methods:

__init__(*args, **kwargs)

Initialize self.

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

class depthai.node.MonoCamera¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.MonoCameraProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getBoardSocket`(self)
`getCamId`(self)
`getCamera`(self)
`getFps`(self)
`getFrameEventFilter`(self)
`getImageOrientation`(self)
`getNumFramesPool`(self)
`getRawNumFramesPool`(self)
`getResolution`(self)
`getResolutionHeight`(self)
`getResolutionSize`(self)
`getResolutionWidth`(self)
`setBoardSocket`(self, boardSocket)
`setCamId`(self, arg0)
`setCamera`(self, name)
`setFps`(self, fps)
`setFrameEventFilter`(self, events)
`setImageOrientation`(self, imageOrientation)
`setIsp3aFps`(self, isp3aFps)
`setNumFramesPool`(self, arg0)
`setRawNumFramesPool`(self, arg0)
`setRawOutputPacked`(self, packed)
`setResolution`(self, resolution)

Attributes:

`frameEvent`
`initialControl`
`inputControl`
`out`
`raw`

Properties¶

alias of depthai.MonoCameraProperties Classes:

SensorResolution

Members:

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`boardSocket`
`eventFilter`
`fps`
`initialControl`
`isp3aFps`
`numFramesPool`
`numFramesPoolRaw`
`resolution`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property frameEvent¶

getBoardSocket(self: depthai.node.MonoCamera) → depthai.CameraBoardSocket ¶

getCamId(self: depthai.node.MonoCamera) → int ¶

getCamera(self: depthai.node.MonoCamera) → str ¶

getFps(self: depthai.node.MonoCamera) → float ¶

getFrameEventFilter(self: depthai.node.MonoCamera) → list[depthai.FrameEvent]¶

getImageOrientation(self: depthai.node.MonoCamera) → depthai.CameraImageOrientation ¶

getNumFramesPool(self: depthai.node.MonoCamera) → int ¶

getRawNumFramesPool(self: depthai.node.MonoCamera) → int ¶

getResolution(self: depthai.node.MonoCamera) → depthai.MonoCameraProperties.SensorResolution ¶

getResolutionHeight(self: depthai.node.MonoCamera) → int ¶

getResolutionSize(self: depthai.node.MonoCamera) → tuple[int, int]¶

getResolutionWidth(self: depthai.node.MonoCamera) → int ¶

property initialControl¶

property inputControl¶

property out¶

property raw¶

setBoardSocket(self: depthai.node.MonoCamera, boardSocket: depthai.CameraBoardSocket) → None ¶

setCamId(self: depthai.node.MonoCamera, arg0: int) → None ¶

setCamera(self: depthai.node.MonoCamera, name: str) → None ¶

setFps(self: depthai.node.MonoCamera, fps: float) → None ¶

setFrameEventFilter(self: depthai.node.MonoCamera, events: list[depthai.FrameEvent]) → None ¶

setImageOrientation(self: depthai.node.MonoCamera, imageOrientation: depthai.CameraImageOrientation) → None ¶

setIsp3aFps(self: depthai.node.MonoCamera, isp3aFps: int) → None ¶

setNumFramesPool(self: depthai.node.MonoCamera, arg0: int) → None ¶

setRawNumFramesPool(self: depthai.node.MonoCamera, arg0: int) → None ¶

setRawOutputPacked(self: depthai.node.MonoCamera, packed: bool) → None ¶

setResolution(self: depthai.node.MonoCamera, resolution: depthai.MonoCameraProperties.SensorResolution) → None ¶

class depthai.node.NeuralNetwork¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.NeuralNetworkProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getNumInferenceThreads`(self)
`setBlob`(args, *kwargs)	Overloaded function.
`setBlobPath`(self, path)
`setNumInferenceThreads`(self, numThreads)
`setNumNCEPerInferenceThread`(self, …)
`setNumPoolFrames`(self, numFrames)

Attributes:

`input`
`inputs`
`out`
`passthrough`
`passthroughs`

Properties¶

alias of depthai.NeuralNetworkProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`blobSize`
`blobUri`
`numFrames`
`numNCEPerThread`
`numThreads`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getNumInferenceThreads(self: depthai.node.NeuralNetwork) → int ¶

property input¶

property inputs¶

property out¶

property passthrough¶

property passthroughs¶

setBlob(*args, **kwargs)¶

Overloaded function.

setBlob(self: depthai.node.NeuralNetwork, blob: depthai.OpenVINO.Blob) -> None
setBlob(self: depthai.node.NeuralNetwork, path: Path) -> None

setBlobPath(self: depthai.node.NeuralNetwork, path: Path) → None ¶

setNumInferenceThreads(self: depthai.node.NeuralNetwork, numThreads: int) → None ¶

setNumNCEPerInferenceThread(self: depthai.node.NeuralNetwork, numNCEPerThread: int) → None ¶

setNumPoolFrames(self: depthai.node.NeuralNetwork, numFrames: int) → None ¶

class depthai.node.ObjectTracker¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.ObjectTrackerProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`setDetectionLabelsToTrack`(self, labels)
`setMaxObjectsToTrack`(self, maxObjectsToTrack)
`setTrackerIdAssignmentPolicy`(self, type)
`setTrackerThreshold`(self, threshold)
`setTrackerType`(self, type)
`setTrackingPerClass`(self, trackingPerClass)

Attributes:

`inputDetectionFrame`
`inputDetections`
`inputTrackerFrame`
`out`
`passthroughDetectionFrame`
`passthroughDetections`
`passthroughTrackerFrame`

Properties¶

alias of depthai.ObjectTrackerProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`detectionLabelsToTrack`
`maxObjectsToTrack`
`trackerIdAssignmentPolicy`
`trackerThreshold`
`trackerType`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property inputDetectionFrame¶

property inputDetections¶

property inputTrackerFrame¶

property out¶

property passthroughDetectionFrame¶

property passthroughDetections¶

property passthroughTrackerFrame¶

setDetectionLabelsToTrack(self: depthai.node.ObjectTracker, labels: list[int]) → None ¶

setMaxObjectsToTrack(self: depthai.node.ObjectTracker, maxObjectsToTrack: int) → None ¶

setTrackerIdAssignmentPolicy(self: depthai.node.ObjectTracker, type: depthai.TrackerIdAssignmentPolicy) → None ¶

setTrackerThreshold(self: depthai.node.ObjectTracker, threshold: float) → None ¶

setTrackerType(self: depthai.node.ObjectTracker, type: depthai.TrackerType) → None ¶

setTrackingPerClass(self: depthai.node.ObjectTracker, trackingPerClass: bool) → None ¶

class depthai.node.PointCloud¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.PointCloudProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`setNumFramesPool`(self, arg0)

Attributes:

`initialConfig`
`inputConfig`
`inputDepth`
`outputPointCloud`
`passthroughDepth`

Properties¶

alias of depthai.PointCloudProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`initialConfig`
`numFramesPool`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property initialConfig¶

property inputConfig¶

property inputDepth¶

property outputPointCloud¶

property passthroughDepth¶

setNumFramesPool(self: depthai.node.PointCloud, arg0: int) → None ¶

class depthai.node.SPIIn¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.SPIInProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getBusId`(self)
`getMaxDataSize`(self)
`getNumFrames`(self)
`getStreamName`(self)
`setBusId`(self, id)
`setMaxDataSize`(self, maxDataSize)
`setNumFrames`(self, numFrames)
`setStreamName`(self, name)

Attributes:

out

Properties¶

alias of depthai.SPIInProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`busId`
`maxDataSize`
`numFrames`
`streamName`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getBusId(self: depthai.node.SPIIn) → int ¶

getMaxDataSize(self: depthai.node.SPIIn) → int ¶

getNumFrames(self: depthai.node.SPIIn) → int ¶

getStreamName(self: depthai.node.SPIIn) → str ¶

property out¶

setBusId(self: depthai.node.SPIIn, id: int) → None ¶

setMaxDataSize(self: depthai.node.SPIIn, maxDataSize: int) → None ¶

setNumFrames(self: depthai.node.SPIIn, numFrames: int) → None ¶

setStreamName(self: depthai.node.SPIIn, name: str) → None ¶

class depthai.node.SPIOut¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.SPIOutProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`setBusId`(self, id)
`setStreamName`(self, name)

Attributes:

input

Properties¶

alias of depthai.SPIOutProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`busId`
`streamName`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property input¶

setBusId(self: depthai.node.SPIOut, id: int) → None ¶

setStreamName(self: depthai.node.SPIOut, name: str) → None ¶

class depthai.node.Script¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.ScriptProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getProcessor`(self)
`getScriptName`(self)
`setProcessor`(self, arg0)
`setScript`(args, *kwargs)	Overloaded function.
`setScriptPath`(args, *kwargs)	Overloaded function.

Attributes:

`inputs`
`outputs`

Properties¶

alias of depthai.ScriptProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`processor`
`scriptName`
`scriptUri`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getProcessor(self: depthai.node.Script) → depthai.ProcessorType ¶

getScriptName(self: depthai.node.Script) → str ¶

property inputs¶

property outputs¶

setProcessor(self: depthai.node.Script, arg0: depthai.ProcessorType) → None ¶

setScript(*args, **kwargs)¶

Overloaded function.

setScript(self: depthai.node.Script, script: str, name: str = ‘’) -> None
setScript(self: depthai.node.Script, data: list[int], name: str = ‘’) -> None

setScriptPath(*args, **kwargs)¶

Overloaded function.

setScriptPath(self: depthai.node.Script, arg0: Path, arg1: str) -> None
setScriptPath(self: depthai.node.Script, path: Path, name: str = ‘’) -> None

class depthai.node.SpatialDetectionNetwork¶

Bases: depthai.node.DetectionNetwork

Classes:

Properties

alias of depthai.SpatialDetectionNetworkProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`setBoundingBoxScaleFactor`(self, scaleFactor)
`setDepthLowerThreshold`(self, lowerThreshold)
`setDepthUpperThreshold`(self, upperThreshold)
`setSpatialCalculationAlgorithm`(self, …)
`setSpatialCalculationStepSize`(self, stepSize)

Attributes:

`boundingBoxMapping`
`input`
`inputDepth`
`out`
`passthrough`
`passthroughDepth`
`spatialLocationCalculatorOutput`

Properties¶

alias of depthai.SpatialDetectionNetworkProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`depthThresholds`
`detectedBBScaleFactor`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property boundingBoxMapping¶

property input¶

property inputDepth¶

property out¶

property passthrough¶

property passthroughDepth¶

setBoundingBoxScaleFactor(self: depthai.node.SpatialDetectionNetwork, scaleFactor: float) → None ¶

setDepthLowerThreshold(self: depthai.node.SpatialDetectionNetwork, lowerThreshold: int) → None ¶

setDepthUpperThreshold(self: depthai.node.SpatialDetectionNetwork, upperThreshold: int) → None ¶

setSpatialCalculationAlgorithm(self: depthai.node.SpatialDetectionNetwork, calculationAlgorithm: depthai.SpatialLocationCalculatorAlgorithm) → None ¶

setSpatialCalculationStepSize(self: depthai.node.SpatialDetectionNetwork, stepSize: int) → None ¶

property spatialLocationCalculatorOutput¶

class depthai.node.SpatialLocationCalculator¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.SpatialLocationCalculatorProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getWaitForConfigInput`(self)
`setWaitForConfigInput`(self, wait)

Attributes:

`initialConfig`
`inputConfig`
`inputDepth`
`out`
`passthroughDepth`

Properties¶

alias of depthai.SpatialLocationCalculatorProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

roiConfig

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getWaitForConfigInput(self: depthai.node.SpatialLocationCalculator) → bool ¶

property initialConfig¶

property inputConfig¶

property inputDepth¶

property out¶

property passthroughDepth¶

setWaitForConfigInput(self: depthai.node.SpatialLocationCalculator, wait: bool) → None ¶

class depthai.node.StereoDepth¶

Bases: depthai.Node

Classes:

`PresetMode`	Members:
`Properties`	alias of `depthai.StereoDepthProperties`

Methods:

`__init__`(args, *kwargs)	Initialize self.
`enableDistortionCorrection`(self, arg0)
`getMaxDisparity`(self)
`loadMeshData`(self, dataLeft, dataRight)
`loadMeshFiles`(self, pathLeft, pathRight)
`setAlphaScaling`(self, arg0)
`setBaseline`(self, arg0)
`setConfidenceThreshold`(self, arg0)
`setDefaultProfilePreset`(self, arg0)
`setDepthAlign`(args, *kwargs)	Overloaded function.
`setDepthAlignmentUseSpecTranslation`(self, arg0)
`setDisparityToDepthUseSpecTranslation`(self, arg0)
`setEmptyCalibration`(self)
`setExtendedDisparity`(self, enable)
`setFocalLength`(self, arg0)
`setFocalLengthFromCalibration`(self, arg0)
`setInputResolution`(args, *kwargs)	Overloaded function.
`setLeftRightCheck`(self, enable)
`setMedianFilter`(self, arg0)
`setMeshStep`(self, width, height)
`setNumFramesPool`(self, arg0)
`setOutputDepth`(self, arg0)
`setOutputKeepAspectRatio`(self, keep)
`setOutputRectified`(self, arg0)
`setOutputSize`(self, width, height)
`setPostProcessingHardwareResources`(self, …)
`setRectification`(self, enable)
`setRectificationUseSpecTranslation`(self, arg0)
`setRectifyEdgeFillColor`(self, color)
`setRectifyMirrorFrame`(self, arg0)
`setRuntimeModeSwitch`(self, arg0)
`setSubpixel`(self, enable)
`setSubpixelFractionalBits`(self, …)
`useHomographyRectification`(self, arg0)

Attributes:

`confidenceMap`
`debugDispCostDump`
`debugDispLrCheckIt1`
`debugDispLrCheckIt2`
`debugExtDispLrCheckIt1`
`debugExtDispLrCheckIt2`
`depth`
`disparity`
`initialConfig`
`inputConfig`
`left`
`outConfig`
`rectifiedLeft`
`rectifiedRight`
`right`
`syncedLeft`
`syncedRight`

class PresetMode¶

Bases: pybind11_builtins.pybind11_object

Members:

HIGH_ACCURACY

HIGH_DENSITY

Attributes:

`HIGH_ACCURACY`
`HIGH_DENSITY`
`name`
`value`

Methods:

__init__(self, value)

HIGH_ACCURACY = <PresetMode.HIGH_ACCURACY: 0>¶

HIGH_DENSITY = <PresetMode.HIGH_DENSITY: 1>¶

__init__(self: depthai.node.StereoDepth.PresetMode, value: int) → None ¶

property name¶

property value¶

Properties¶

alias of depthai.StereoDepthProperties Classes:

`DepthAlign`	Members:
`MedianFilter`	Members:
`RectificationMesh`

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`alphaScaling`
`baseline`
`depthAlignCamera`
`depthAlignmentUseSpecTranslation`
`disparityToDepthUseSpecTranslation`
`enableRectification`
`enableRuntimeStereoModeSwitch`
`focalLength`
`focalLengthFromCalibration`
`height`
`initialConfig`
`mesh`
`numFramesPool`
`numPostProcessingMemorySlices`
`numPostProcessingShaves`
`outHeight`
`outKeepAspectRatio`
`outWidth`
`rectificationUseSpecTranslation`
`rectifyEdgeFillColor`
`useHomographyRectification`
`width`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property confidenceMap¶

property debugDispCostDump¶

property debugDispLrCheckIt1¶

property debugDispLrCheckIt2¶

property debugExtDispLrCheckIt1¶

property debugExtDispLrCheckIt2¶

property depth¶

property disparity¶

enableDistortionCorrection(self: depthai.node.StereoDepth, arg0: bool) → None ¶

getMaxDisparity(self: depthai.node.StereoDepth) → float ¶

property initialConfig¶

property inputConfig¶

property left¶

loadMeshData(self: depthai.node.StereoDepth, dataLeft: list[int], dataRight: list[int]) → None ¶

loadMeshFiles(self: depthai.node.StereoDepth, pathLeft: Path, pathRight: Path) → None ¶

property outConfig¶

property rectifiedLeft¶

property rectifiedRight¶

property right¶

setAlphaScaling(self: depthai.node.StereoDepth, arg0: float) → None ¶

setBaseline(self: depthai.node.StereoDepth, arg0: float) → None ¶

setConfidenceThreshold(self: depthai.node.StereoDepth, arg0: int) → None ¶

setDefaultProfilePreset(self: depthai.node.StereoDepth, arg0: depthai.node.StereoDepth.PresetMode) → None ¶

setDepthAlign(*args, **kwargs)¶

Overloaded function.

setDepthAlign(self: depthai.node.StereoDepth, align: depthai.RawStereoDepthConfig.AlgorithmControl.DepthAlign) -> None
setDepthAlign(self: depthai.node.StereoDepth, camera: depthai.CameraBoardSocket) -> None

setDepthAlignmentUseSpecTranslation(self: depthai.node.StereoDepth, arg0: bool) → None ¶

setDisparityToDepthUseSpecTranslation(self: depthai.node.StereoDepth, arg0: bool) → None ¶

setEmptyCalibration(self: depthai.node.StereoDepth) → None ¶

setExtendedDisparity(self: depthai.node.StereoDepth, enable: bool) → None ¶

setFocalLength(self: depthai.node.StereoDepth, arg0: float) → None ¶

setFocalLengthFromCalibration(self: depthai.node.StereoDepth, arg0: bool) → None ¶

setInputResolution(*args, **kwargs)¶

Overloaded function.

setInputResolution(self: depthai.node.StereoDepth, width: int, height: int) -> None
setInputResolution(self: depthai.node.StereoDepth, resolution: tuple[int, int]) -> None

setLeftRightCheck(self: depthai.node.StereoDepth, enable: bool) → None ¶

setMedianFilter(self: depthai.node.StereoDepth, arg0: depthai.MedianFilter) → None ¶

setMeshStep(self: depthai.node.StereoDepth, width: int, height: int) → None ¶

setNumFramesPool(self: depthai.node.StereoDepth, arg0: int) → None ¶

setOutputDepth(self: depthai.node.StereoDepth, arg0: bool) → None ¶

setOutputKeepAspectRatio(self: depthai.node.StereoDepth, keep: bool) → None ¶

setOutputRectified(self: depthai.node.StereoDepth, arg0: bool) → None ¶

setOutputSize(self: depthai.node.StereoDepth, width: int, height: int) → None ¶

setPostProcessingHardwareResources(self: depthai.node.StereoDepth, arg0: int, arg1: int) → None ¶

setRectification(self: depthai.node.StereoDepth, enable: bool) → None ¶

setRectificationUseSpecTranslation(self: depthai.node.StereoDepth, arg0: bool) → None ¶

setRectifyEdgeFillColor(self: depthai.node.StereoDepth, color: int) → None ¶

setRectifyMirrorFrame(self: depthai.node.StereoDepth, arg0: bool) → None ¶

setRuntimeModeSwitch(self: depthai.node.StereoDepth, arg0: bool) → None ¶

setSubpixel(self: depthai.node.StereoDepth, enable: bool) → None ¶

setSubpixelFractionalBits(self: depthai.node.StereoDepth, subpixelFractionalBits: int) → None ¶

property syncedLeft¶

property syncedRight¶

useHomographyRectification(self: depthai.node.StereoDepth, arg0: bool) → None ¶

class depthai.node.Sync¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.SyncProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getSyncAttempts`(self)
`getSyncThreshold`(self)
`setSyncAttempts`(self, maxDataSize)
`setSyncThreshold`(self, syncThreshold)

Attributes:

`inputs`
`out`

Properties¶

alias of depthai.SyncProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`syncAttempts`
`syncThresholdNs`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getSyncAttempts(self: depthai.node.Sync) → int ¶

getSyncThreshold(self: depthai.node.Sync) → datetime.timedelta ¶

property inputs¶

property out¶

setSyncAttempts(self: depthai.node.Sync, maxDataSize: int) → None ¶

setSyncThreshold(self: depthai.node.Sync, syncThreshold: datetime.timedelta) → None ¶

class depthai.node.SystemLogger¶

Bases: depthai.Node

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getRate`(self)
`setRate`(self, hz)

Attributes:

out

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getRate(self: depthai.node.SystemLogger) → float ¶

property out¶

setRate(self: depthai.node.SystemLogger, hz: float) → None ¶

class depthai.node.ToF¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.ToFProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`setNumFramesPool`(self, arg0)
`setNumShaves`(self, arg0)

Attributes:

`amplitude`
`depth`
`initialConfig`
`input`
`inputConfig`
`intensity`
`phase`

Properties¶

alias of depthai.ToFProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`initialConfig`
`numFramesPool`
`numShaves`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property amplitude¶

property depth¶

property initialConfig¶

property input¶

property inputConfig¶

property intensity¶

property phase¶

setNumFramesPool(self: depthai.node.ToF, arg0: int) → depthai.node.ToF ¶

setNumShaves(self: depthai.node.ToF, arg0: int) → depthai.node.ToF ¶

class depthai.node.UVC¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.UVCProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`setGpiosOnInit`(self, list, int])
`setGpiosOnStreamOff`(self, list, int])
`setGpiosOnStreamOn`(self, list, int])

Attributes:

input

Properties¶

alias of depthai.UVCProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`gpioInit`
`gpioStreamOff`
`gpioStreamOn`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property input¶

setGpiosOnInit(self: depthai.node.UVC, list: dict[int, int]) → None ¶

setGpiosOnStreamOff(self: depthai.node.UVC, list: dict[int, int]) → None ¶

setGpiosOnStreamOn(self: depthai.node.UVC, list: dict[int, int]) → None ¶

class depthai.node.VideoEncoder¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.VideoEncoderProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getBitrate`(self)
`getBitrateKbps`(self)
`getFrameRate`(self)
`getHeight`(self)
`getKeyframeFrequency`(self)
`getLossless`(self)
`getMaxOutputFrameSize`(self)
`getNumBFrames`(self)
`getNumFramesPool`(self)
`getProfile`(self)
`getQuality`(self)
`getRateControlMode`(self)
`getSize`(self)
`getWidth`(self)
`setBitrate`(self, bitrate)
`setBitrateKbps`(self, bitrateKbps)
`setDefaultProfilePreset`(args, *kwargs)	Overloaded function.
`setFrameRate`(self, frameRate)
`setKeyframeFrequency`(self, freq)
`setLossless`(self, arg0)
`setMaxOutputFrameSize`(self, maxFrameSize)
`setNumBFrames`(self, numBFrames)
`setNumFramesPool`(self, frames)
`setProfile`(args, *kwargs)	Overloaded function.
`setQuality`(self, quality)
`setRateControlMode`(self, mode)

Attributes:

`bitstream`
`input`
`out`

Properties¶

alias of depthai.VideoEncoderProperties Classes:

`Profile`	Members:
`RateControlMode`	Members:

Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`bitrate`
`keyframeFrequency`
`maxBitrate`
`numBFrames`
`numFramesPool`
`outputFrameSize`
`profile`
`quality`
`rateCtrlMode`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

property bitstream¶

getBitrate(self: depthai.node.VideoEncoder) → int ¶

getBitrateKbps(self: depthai.node.VideoEncoder) → int ¶

getFrameRate(self: depthai.node.VideoEncoder) → float ¶

getHeight(self: depthai.node.VideoEncoder) → int ¶

getKeyframeFrequency(self: depthai.node.VideoEncoder) → int ¶

getLossless(self: depthai.node.VideoEncoder) → bool ¶

getMaxOutputFrameSize(self: depthai.node.VideoEncoder) → int ¶

getNumBFrames(self: depthai.node.VideoEncoder) → int ¶

getNumFramesPool(self: depthai.node.VideoEncoder) → int ¶

getProfile(self: depthai.node.VideoEncoder) → depthai.VideoEncoderProperties.Profile ¶

getQuality(self: depthai.node.VideoEncoder) → int ¶

getRateControlMode(self: depthai.node.VideoEncoder) → depthai.VideoEncoderProperties.RateControlMode ¶

getSize(self: depthai.node.VideoEncoder) → tuple[int, int]¶

getWidth(self: depthai.node.VideoEncoder) → int ¶

property input¶

property out¶

setBitrate(self: depthai.node.VideoEncoder, bitrate: int) → None ¶

setBitrateKbps(self: depthai.node.VideoEncoder, bitrateKbps: int) → None ¶

setDefaultProfilePreset(*args, **kwargs)¶

Overloaded function.

setDefaultProfilePreset(self: depthai.node.VideoEncoder, fps: float, profile: depthai.VideoEncoderProperties.Profile) -> None
setDefaultProfilePreset(self: depthai.node.VideoEncoder, arg0: int, arg1: int, arg2: float, arg3: depthai.VideoEncoderProperties.Profile) -> None
setDefaultProfilePreset(self: depthai.node.VideoEncoder, arg0: tuple[int, int], arg1: float, arg2: depthai.VideoEncoderProperties.Profile) -> None

setFrameRate(self: depthai.node.VideoEncoder, frameRate: float) → None ¶

setKeyframeFrequency(self: depthai.node.VideoEncoder, freq: int) → None ¶

setLossless(self: depthai.node.VideoEncoder, arg0: bool) → None ¶

setMaxOutputFrameSize(self: depthai.node.VideoEncoder, maxFrameSize: int) → None ¶

setNumBFrames(self: depthai.node.VideoEncoder, numBFrames: int) → None ¶

setNumFramesPool(self: depthai.node.VideoEncoder, frames: int) → None ¶

setProfile(*args, **kwargs)¶

Overloaded function.

setProfile(self: depthai.node.VideoEncoder, profile: depthai.VideoEncoderProperties.Profile) -> None
setProfile(self: depthai.node.VideoEncoder, arg0: tuple[int, int], arg1: depthai.VideoEncoderProperties.Profile) -> None
setProfile(self: depthai.node.VideoEncoder, arg0: int, arg1: int, arg2: depthai.VideoEncoderProperties.Profile) -> None

setQuality(self: depthai.node.VideoEncoder, quality: int) → None ¶

setRateControlMode(self: depthai.node.VideoEncoder, mode: depthai.VideoEncoderProperties.RateControlMode) → None ¶

class depthai.node.Warp¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.WarpProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getHwIds`(self)
`getInterpolation`(self)
`setHwIds`(self, arg0)
`setInterpolation`(self, arg0)
`setMaxOutputFrameSize`(self, arg0)
`setNumFramesPool`(self, arg0)
`setOutputSize`(args, *kwargs)	Overloaded function.
`setWarpMesh`(args, *kwargs)	Overloaded function.

Attributes:

`inputImage`
`out`

Properties¶

alias of depthai.WarpProperties Classes:

Interpolation

Members:

Methods:

__init__(*args, **kwargs)

Initialize self.

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getHwIds(self: depthai.node.Warp) → list[int]¶

getInterpolation(self: depthai.node.Warp) → depthai.Interpolation ¶

property inputImage¶

property out¶

setHwIds(self: depthai.node.Warp, arg0: list[int]) → None ¶

setInterpolation(self: depthai.node.Warp, arg0: depthai.Interpolation) → None ¶

setMaxOutputFrameSize(self: depthai.node.Warp, arg0: int) → None ¶

setNumFramesPool(self: depthai.node.Warp, arg0: int) → None ¶

setOutputSize(*args, **kwargs)¶

Overloaded function.

setOutputSize(self: depthai.node.Warp, arg0: int, arg1: int) -> None
setOutputSize(self: depthai.node.Warp, arg0: tuple[int, int]) -> None

setWarpMesh(*args, **kwargs)¶

Overloaded function.

setWarpMesh(self: depthai.node.Warp, arg0: list[depthai.Point2f], arg1: int, arg2: int) -> None
setWarpMesh(self: depthai.node.Warp, arg0: list[tuple[float, float]], arg1: int, arg2: int) -> None

class depthai.node.XLinkIn¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.XLinkInProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getMaxDataSize`(self)
`getNumFrames`(self)
`getStreamName`(self)
`setMaxDataSize`(self, maxDataSize)
`setNumFrames`(self, numFrames)
`setStreamName`(self, streamName)

Attributes:

out

Properties¶

alias of depthai.XLinkInProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`maxDataSize`
`numFrames`
`streamName`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getMaxDataSize(self: depthai.node.XLinkIn) → int ¶

getNumFrames(self: depthai.node.XLinkIn) → int ¶

getStreamName(self: depthai.node.XLinkIn) → str ¶

property out¶

setMaxDataSize(self: depthai.node.XLinkIn, maxDataSize: int) → None ¶

setNumFrames(self: depthai.node.XLinkIn, numFrames: int) → None ¶

setStreamName(self: depthai.node.XLinkIn, streamName: str) → None ¶

class depthai.node.XLinkOut¶

Bases: depthai.Node

Classes:

Properties

alias of depthai.XLinkOutProperties

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getFpsLimit`(self)
`getMetadataOnly`(self)
`getStreamName`(self)
`setFpsLimit`(self, fpsLimit)
`setMetadataOnly`(self, arg0)
`setStreamName`(self, streamName)

Attributes:

input

Properties¶

alias of depthai.XLinkOutProperties Methods:

__init__(*args, **kwargs)

Initialize self.

Attributes:

`maxFpsLimit`
`metadataOnly`
`streamName`

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getFpsLimit(self: depthai.node.XLinkOut) → float ¶

getMetadataOnly(self: depthai.node.XLinkOut) → bool ¶

getStreamName(self: depthai.node.XLinkOut) → str ¶

property input¶

setFpsLimit(self: depthai.node.XLinkOut, fpsLimit: float) → None ¶

setMetadataOnly(self: depthai.node.XLinkOut, arg0: bool) → None ¶

setStreamName(self: depthai.node.XLinkOut, streamName: str) → None ¶

class depthai.node.YoloDetectionNetwork¶

Bases: depthai.node.DetectionNetwork

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getAnchorMasks`(self)
`getAnchors`(self)
`getCoordinateSize`(self)
`getIouThreshold`(self)
`getNumClasses`(self)
`setAnchorMasks`(self, anchorMasks, list[int]])
`setAnchors`(self, anchors)
`setCoordinateSize`(self, coordinates)
`setIouThreshold`(self, thresh)
`setNumClasses`(self, numClasses)

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getAnchorMasks(self: depthai.node.YoloDetectionNetwork) → dict[str, list[int]]¶

getAnchors(self: depthai.node.YoloDetectionNetwork) → list[float]¶

getCoordinateSize(self: depthai.node.YoloDetectionNetwork) → int ¶

getIouThreshold(self: depthai.node.YoloDetectionNetwork) → float ¶

getNumClasses(self: depthai.node.YoloDetectionNetwork) → int ¶

setAnchorMasks(self: depthai.node.YoloDetectionNetwork, anchorMasks: dict[str, list[int]]) → None ¶

setAnchors(self: depthai.node.YoloDetectionNetwork, anchors: list[float]) → None ¶

setCoordinateSize(self: depthai.node.YoloDetectionNetwork, coordinates: int) → None ¶

setIouThreshold(self: depthai.node.YoloDetectionNetwork, thresh: float) → None ¶

setNumClasses(self: depthai.node.YoloDetectionNetwork, numClasses: int) → None ¶

class depthai.node.YoloSpatialDetectionNetwork¶

Bases: depthai.node.SpatialDetectionNetwork

Methods:

`__init__`(args, *kwargs)	Initialize self.
`getAnchorMasks`(self)
`getAnchors`(self)
`getCoordinateSize`(self)
`getIouThreshold`(self)
`getNumClasses`(self)
`setAnchorMasks`(self, anchorMasks, list[int]])
`setAnchors`(self, anchors)
`setCoordinateSize`(self, coordinates)
`setIouThreshold`(self, thresh)
`setNumClasses`(self, numClasses)

__init__(*args, **kwargs)¶: Initialize self. See help(type(self)) for accurate signature.

getAnchorMasks(self: depthai.node.YoloSpatialDetectionNetwork) → dict[str, list[int]]¶

getAnchors(self: depthai.node.YoloSpatialDetectionNetwork) → list[float]¶

getCoordinateSize(self: depthai.node.YoloSpatialDetectionNetwork) → int ¶

getIouThreshold(self: depthai.node.YoloSpatialDetectionNetwork) → float ¶

getNumClasses(self: depthai.node.YoloSpatialDetectionNetwork) → int ¶

setAnchorMasks(self: depthai.node.YoloSpatialDetectionNetwork, anchorMasks: dict[str, list[int]]) → None ¶

setAnchors(self: depthai.node.YoloSpatialDetectionNetwork, anchors: list[float]) → None ¶

setCoordinateSize(self: depthai.node.YoloSpatialDetectionNetwork, coordinates: int) → None ¶

setIouThreshold(self: depthai.node.YoloSpatialDetectionNetwork, thresh: float) → None ¶

setNumClasses(self: depthai.node.YoloSpatialDetectionNetwork, numClasses: int) → None ¶