Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
dai::node::SpatialLocationCalculator Class Reference

SpatialLocationCalculator node. Calculates spatial location data on a set of ROIs on depth map. More...

#include <SpatialLocationCalculator.hpp>

Inheritance diagram for dai::node::SpatialLocationCalculator:
Inheritance graph
[legend]

Public Member Functions

bool getWaitForConfigInput () const
 
void setWaitForConfigInput (bool wait)
 
 SpatialLocationCalculator (const std::shared_ptr< PipelineImpl > &par, int64_t nodeId)
 
 SpatialLocationCalculator (const std::shared_ptr< PipelineImpl > &par, int64_t nodeId, std::unique_ptr< Properties > props)
 
- Public Member Functions inherited from dai::NodeCRTP< Node, SpatialLocationCalculator, SpatialLocationCalculatorProperties >
std::unique_ptr< Nodeclone () const override
 
const char * getName () const override
 
- Public Member Functions inherited from dai::Node
virtual std::unique_ptr< Nodeclone () const =0
 Deep copy the node. More...
 
AssetManagergetAssetManager ()
 Get node AssetManager as a reference. More...
 
const AssetManagergetAssetManager () const
 Get node AssetManager as a const reference. More...
 
std::vector< Input * > getInputRefs ()
 Retrieves reference to node inputs. More...
 
std::vector< const Input * > getInputRefs () const
 Retrieves reference to node inputs. More...
 
std::vector< InputgetInputs ()
 Retrieves all nodes inputs. More...
 
virtual const char * getName () const =0
 Retrieves nodes name. More...
 
std::vector< Output * > getOutputRefs ()
 Retrieves reference to node outputs. More...
 
std::vector< const Output * > getOutputRefs () const
 Retrieves reference to node outputs. More...
 
std::vector< OutputgetOutputs ()
 Retrieves all nodes outputs. More...
 
Pipeline getParentPipeline ()
 
const Pipeline getParentPipeline () const
 
 Node (const std::shared_ptr< PipelineImpl > &p, Id nodeId, std::unique_ptr< Properties > props)
 Constructs Node. More...
 
virtual ~Node ()=default
 

Public Attributes

SpatialLocationCalculatorConfig initialConfig
 
Input inputConfig {*this, "inputConfig", Input::Type::SReceiver, false, 4, {{DatatypeEnum::SpatialLocationCalculatorConfig, false}}}
 
Input inputDepth {*this, "inputDepth", Input::Type::SReceiver, false, 4, true, {{DatatypeEnum::ImgFrame, false}}}
 
Output out {*this, "out", Output::Type::MSender, {{DatatypeEnum::SpatialLocationCalculatorData, false}}}
 
Output passthroughDepth {*this, "passthroughDepth", Output::Type::MSender, {{DatatypeEnum::ImgFrame, false}}}
 
- Public Attributes inherited from dai::NodeCRTP< Node, SpatialLocationCalculator, SpatialLocationCalculatorProperties >
Propertiesproperties
 Underlying properties. More...
 
- Public Attributes inherited from dai::Node
const Id id
 Id of node. More...
 
Propertiesproperties
 

Static Public Attributes

constexpr static const char * NAME = "SpatialLocationCalculator"
 

Protected Member Functions

PropertiesgetProperties ()
 
- Protected Member Functions inherited from dai::Node
virtual tl::optional< OpenVINO::VersiongetRequiredOpenVINOVersion ()
 
void setInputMapRefs (InputMap *inMapRef)
 
void setInputMapRefs (std::initializer_list< InputMap * > l)
 
void setInputRefs (Input *inRef)
 
void setInputRefs (std::initializer_list< Input * > l)
 
void setOutputMapRefs (OutputMap *outMapRef)
 
void setOutputMapRefs (std::initializer_list< OutputMap * > l)
 
void setOutputRefs (Output *outRef)
 
void setOutputRefs (std::initializer_list< Output * > l)
 

Private Attributes

std::shared_ptr< RawSpatialLocationCalculatorConfigrawConfig
 

Additional Inherited Members

- Public Types inherited from dai::NodeCRTP< Node, SpatialLocationCalculator, SpatialLocationCalculatorProperties >
using Properties = SpatialLocationCalculatorProperties
 
- Public Types inherited from dai::Node
using Id = std::int64_t
 Node identificator. Unique for every node on a single Pipeline. More...
 
- Protected Attributes inherited from dai::Node
AssetManager assetManager
 
std::unordered_map< std::string, InputMap * > inputMapRefs
 
std::unordered_map< std::string, Input * > inputRefs
 
std::unordered_map< std::string, OutputMap * > outputMapRefs
 
std::unordered_map< std::string, Output * > outputRefs
 
std::weak_ptr< PipelineImplparent
 
copyable_unique_ptr< PropertiespropertiesHolder
 

Detailed Description

SpatialLocationCalculator node. Calculates spatial location data on a set of ROIs on depth map.

Definition at line 19 of file SpatialLocationCalculator.hpp.

Constructor & Destructor Documentation

◆ SpatialLocationCalculator() [1/2]

dai::node::SpatialLocationCalculator::SpatialLocationCalculator ( const std::shared_ptr< PipelineImpl > &  par,
int64_t  nodeId 
)

Definition at line 8 of file SpatialLocationCalculator.cpp.

◆ SpatialLocationCalculator() [2/2]

dai::node::SpatialLocationCalculator::SpatialLocationCalculator ( const std::shared_ptr< PipelineImpl > &  par,
int64_t  nodeId,
std::unique_ptr< Properties props 
)

Definition at line 10 of file SpatialLocationCalculator.cpp.

Member Function Documentation

◆ getProperties()

SpatialLocationCalculator::Properties & dai::node::SpatialLocationCalculator::getProperties ( )
protectedvirtual

Reimplemented from dai::Node.

Definition at line 18 of file SpatialLocationCalculator.cpp.

◆ getWaitForConfigInput()

bool dai::node::SpatialLocationCalculator::getWaitForConfigInput ( ) const
See also
setWaitForConfigInput
Returns
True if wait for inputConfig message, false otherwise

Definition at line 28 of file SpatialLocationCalculator.cpp.

◆ setWaitForConfigInput()

void dai::node::SpatialLocationCalculator::setWaitForConfigInput ( bool  wait)

Specify whether or not wait until configuration message arrives to inputConfig Input.

Parameters
waitTrue to wait for configuration message, false otherwise.

Definition at line 24 of file SpatialLocationCalculator.cpp.

Member Data Documentation

◆ initialConfig

SpatialLocationCalculatorConfig dai::node::SpatialLocationCalculator::initialConfig

Initial config to use when calculating spatial location data.

Definition at line 36 of file SpatialLocationCalculator.hpp.

◆ inputConfig

Input dai::node::SpatialLocationCalculator::inputConfig {*this, "inputConfig", Input::Type::SReceiver, false, 4, {{DatatypeEnum::SpatialLocationCalculatorConfig, false}}}

Input SpatialLocationCalculatorConfig message with ability to modify parameters in runtime. Default queue is non-blocking with size 4.

Definition at line 42 of file SpatialLocationCalculator.hpp.

◆ inputDepth

Input dai::node::SpatialLocationCalculator::inputDepth {*this, "inputDepth", Input::Type::SReceiver, false, 4, true, {{DatatypeEnum::ImgFrame, false}}}

Input message with depth data used to retrieve spatial information about detected object. Default queue is non-blocking with size 4.

Definition at line 47 of file SpatialLocationCalculator.hpp.

◆ NAME

constexpr static const char* dai::node::SpatialLocationCalculator::NAME = "SpatialLocationCalculator"
staticconstexpr

Definition at line 21 of file SpatialLocationCalculator.hpp.

◆ out

Output dai::node::SpatialLocationCalculator::out {*this, "out", Output::Type::MSender, {{DatatypeEnum::SpatialLocationCalculatorData, false}}}

Outputs SpatialLocationCalculatorData message that carries spatial location results.

Definition at line 52 of file SpatialLocationCalculator.hpp.

◆ passthroughDepth

Output dai::node::SpatialLocationCalculator::passthroughDepth {*this, "passthroughDepth", Output::Type::MSender, {{DatatypeEnum::ImgFrame, false}}}

Passthrough message on which the calculation was performed. Suitable for when input queue is set to non-blocking behavior.

Definition at line 58 of file SpatialLocationCalculator.hpp.

◆ rawConfig

std::shared_ptr<RawSpatialLocationCalculatorConfig> dai::node::SpatialLocationCalculator::rawConfig
private

Definition at line 27 of file SpatialLocationCalculator.hpp.


The documentation for this class was generated from the following files:


depthai
Author(s): Martin Peterlin
autogenerated on Sat Mar 22 2025 02:58:20