ON THIS PAGE

  • DepthAI Nodes
  • Overview
  • Installation
  • Modules
  • Node
  • Parsers
  • Utility & Helpers
  • Message

DepthAI Nodes

Overview

In DepthAI pipelines, Message objects are used to send information between Nodes. While DepthAI natively supports a variety of message and node types, some use cases—such as deploying custom AI models or executing specialized tasks—may require components beyond the built-in capabilities.To address these needs, we provide an open-source Python library called 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

The package is hosted on PyPI so it can be installed with pip:
Command Line
1pip install depthai-nodes

Modules

Node

The 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 nodes are used to interpret the outputs of AI models. Their primary purpose is to encapsulate and abstract away postprocessing logic, allowing users to interact directly with clean, structured outputs. Thus, each parser node emits a DepthAI-compatible Message containing the parsed data.Below is an overview of the available parser nodes, along with their corresponding tasks and usage examples. We list only a small fraction of examples as many more are available on Luxonis Models. For detailed information on each individual parser, please refer to the Parser Node documentation.
ParserTaskUsage Example
YOLOExtendedParserObject DetectionYOLOv8 Instance Segmentation Nano, YOLOv8 Nano Pose Estimation
YuNetParserObject DetectionYuNet
SCRFDParserObject DetectionSCRFD Person detection
MPPalmDetectionParserObject DetectionMediaPipe Palm Detection
PPTextDetectionParserObject DetectionPaddle Text Detection
ClassificationParserClassificationEfficientNet-Lite
ClassificationSequenceParserClassificationPaddle Text Recognition
SegmentationParserSegmentationDeepLab-V3-Plus
FastSAMParserSegmentationFastSAM s
KeypointParserKeypoints DetectionMediaPipe Hand Landmarker
SuperAnimalParserKeypoints DetectionSuperAnimal Landmarker
HRNetParserKeypoints DetectionLite-HRNet
XFeatMonoParserFeature MatchingXFeat
XFeatStereoParserFeature MatchingXFeat
LaneDetectionParserOtherUltra Fast Lane Detection
MLSDParserOtherM-LSD
EmbeddingsParserOtherArcFace
RegressionParserOtherHead pose estimation
MapOutputParserOtherDepth Anything V2
ImageOutputParserOtherZero-DCE

Utility & Helpers

This group includes nodes designed to assist with common tasks such as data processing, filtering, and pipeline management. It also contains abstract base nodes that serve as templates for building custom node implementations.Below is a brief overview of the available utility and helper nodes, along with their corresponding tasks and usage explanations. You can find more information about each individual node in the Utility & Helper Nodes documentation.
ParserTaskPurpose
BaseHostNodeAbstract ClassHost node base class
ApplyColormapImage ProcessingApplies a colormap
DepthMergerImage ProcessingMerges depth and detections
ImgFrameOverlayImage ProcessingOverlays two images
TilingImage ProcessingDivides frames into overlapping tiles
TilesPatcherImage ProcessingPatches detections from tiles back into the global frame
ParsingNeuralNetworkNeural Network ProcessingCreates a NeuralNetwork node and relevant parser(s) for the given model
HostParsingNeuralNetworkNeural Network ProcessingHost-side ParsingNeuralNetwork implementation
ParserGeneratorNeural Network ProcessingGenerates parsers from the given NN archive
ImgDetectionsBridgeDetection and FilteringTransforms detections message
ImgDetectionsFilterDetection and FilteringFilters detections message
GatherDataData ManagementGathers messages into one
SnapsProducerData ManagementCreates and sends snaps (any message type)
SnapsProducerFrameOnlyData ManagementCreates and sends snaps (frame-only)

Message

The 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 TypeStores
ClassificationsObject class labels with probability scores
ClusterA group of related points
ClustersMultiple Cluster objects
ImgDetectionExtendedBounding box with angle, label, keypoints, and confidence
ImgDetectionsExtendedMultiple ImgDetectionExtended objects; includes segmentation masks
KeypointA single keypoint with coordinates and probability
KeypointsMultiple Keypoint objects
LineLine coordinates with confidence
LinesMultiple Line objects
Map2D2D float array
PredictionSingle float value
PredictionsMultiple Prediction objects
SegmentationMask2D integer array