DepthAI Nodes
Overview
depthai-nodes. It offers custom elements fully compatible with DepthAI pipelines, differing only in that they execute on the host machine instead of on Luxonis device.The library consists of two primary modules: node and message, each serving distinct roles in pipeline composition. For more comprehensive documentation and examples, please refer to the library's GitHub repository.Installation
Command Line
1pip install depthai-nodesModules
Node
node module provides a collection of custom node objects that extend the functionality of standard DepthAI nodes. These nodes are grouped into parser, utility, and helper categories.Parsers
| Parser | Task | Usage Example |
|---|---|---|
YOLOExtendedParser | Object Detection | YOLOv8 Instance Segmentation Nano, YOLOv8 Nano Pose Estimation |
YuNetParser | Object Detection | YuNet |
SCRFDParser | Object Detection | SCRFD Person detection |
MPPalmDetectionParser | Object Detection | MediaPipe Palm Detection |
PPTextDetectionParser | Object Detection | Paddle Text Detection |
ClassificationParser | Classification | EfficientNet-Lite |
ClassificationSequenceParser | Classification | Paddle Text Recognition |
SegmentationParser | Segmentation | DeepLab-V3-Plus |
FastSAMParser | Segmentation | FastSAM s |
KeypointParser | Keypoints Detection | MediaPipe Hand Landmarker |
SuperAnimalParser | Keypoints Detection | SuperAnimal Landmarker |
HRNetParser | Keypoints Detection | Lite-HRNet |
XFeatMonoParser | Feature Matching | XFeat |
XFeatStereoParser | Feature Matching | XFeat |
LaneDetectionParser | Other | Ultra Fast Lane Detection |
MLSDParser | Other | M-LSD |
EmbeddingsParser | Other | ArcFace |
RegressionParser | Other | Head pose estimation |
MapOutputParser | Other | Depth Anything V2 |
ImageOutputParser | Other | Zero-DCE |
Utility & Helpers
| Parser | Task | Purpose |
|---|---|---|
BaseHostNode | Abstract Class | Host node base class |
ApplyColormap | Image Processing | Applies a colormap |
DepthMerger | Image Processing | Merges depth and detections |
ImgFrameOverlay | Image Processing | Overlays two images |
Tiling | Image Processing | Divides frames into overlapping tiles |
TilesPatcher | Image Processing | Patches detections from tiles back into the global frame |
ParsingNeuralNetwork | Neural Network Processing | Creates a NeuralNetwork node and relevant parser(s) for the given model |
HostParsingNeuralNetwork | Neural Network Processing | Host-side ParsingNeuralNetwork implementation |
ParserGenerator | Neural Network Processing | Generates parsers from the given NN archive |
ImgDetectionsBridge | Detection and Filtering | Transforms detections message |
ImgDetectionsFilter | Detection and Filtering | Filters detections message |
GatherData | Data Management | Gathers messages into one |
SnapsProducer | Data Management | Creates and sends snaps (any message type) |
SnapsProducerFrameOnly | Data Management | Creates and sends snaps (frame-only) |
Message
message module provides a set of custom message types that extend the standard DepthAI messages. These custom types make it easier to work with the outputs of various AI models and integrate them into visualization or processing pipelines.Here’s a quick overview of the available message types. You can find more information in the Message Type documentation.| Message Type | Stores |
|---|---|
Classifications | Object class labels with probability scores |
Cluster | A group of related points |
Clusters | Multiple Cluster objects |
ImgDetectionExtended | Bounding box with angle, label, keypoints, and confidence |
ImgDetectionsExtended | Multiple ImgDetectionExtended objects; includes segmentation masks |
Keypoint | A single keypoint with coordinates and probability |
Keypoints | Multiple Keypoint objects |
Line | Line coordinates with confidence |
Lines | Multiple Line objects |
Map2D | 2D float array |
Prediction | Single float value |
Predictions | Multiple Prediction objects |
SegmentationMask | 2D integer array |