dai::node::ToF Class Reference

ToF node. More...

#include <ToF.hpp>

Inheritance diagram for dai::node::ToF:

Public Member Functions
ToF &	setNumFramesPool (int numFramesPool)
ToF &	setNumShaves (int numShaves)
	ToF (const std::shared_ptr< PipelineImpl > &par, int64_t nodeId)
	ToF (const std::shared_ptr< PipelineImpl > &par, int64_t nodeId, std::unique_ptr< Properties > props)
Public Member Functions inherited from dai::NodeCRTP< Node, ToF, ToFProperties >
std::unique_ptr< Node >	clone () const override
const char *	getName () const override
Public Member Functions inherited from dai::Node
virtual std::unique_ptr< Node >	clone () const =0
	Deep copy the node. More...
AssetManager &	getAssetManager ()
	Get node AssetManager as a reference. More...
const AssetManager &	getAssetManager () 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< Input >	getInputs ()
	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< Output >	getOutputs ()
	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
Output	amplitude {*this, "amplitude", Output::Type::MSender, {{DatatypeEnum::ImgFrame, true}}}
Output	depth {*this, "depth", Output::Type::MSender, {{DatatypeEnum::ImgFrame, true}}}
ToFConfig	initialConfig
Input	input {*this, "input", Input::Type::SReceiver, true, 8, {{DatatypeEnum::ImgFrame, true}}}
Input	inputConfig {*this, "inputConfig", Input::Type::SReceiver, false, 4, {{DatatypeEnum::ToFConfig, false}}}
Output	intensity {*this, "intensity", Output::Type::MSender, {{DatatypeEnum::ImgFrame, true}}}
Output	phase {*this, "phase", Output::Type::MSender, {{DatatypeEnum::ImgFrame, true}}}
Public Attributes inherited from dai::NodeCRTP< Node, ToF, ToFProperties >
Properties &	properties
	Underlying properties. More...
Public Attributes inherited from dai::Node
const Id	id
	Id of node. More...
Properties &	properties

Static Public Attributes
constexpr static const char *	NAME = "ToF"

Protected Member Functions
Properties &	getProperties ()
Protected Member Functions inherited from dai::Node
virtual tl::optional< OpenVINO::Version >	getRequiredOpenVINOVersion ()
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< RawToFConfig >	rawConfig

Additional Inherited Members
Public Types inherited from dai::NodeCRTP< Node, ToF, ToFProperties >
using	Properties = ToFProperties
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< PipelineImpl >	parent
copyable_unique_ptr< Properties >	propertiesHolder

Detailed Description

ToF node.

Definition at line 16 of file ToF.hpp.

Constructor & Destructor Documentation

ToF() [1/2]

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

Constructs ToF node.

Definition at line 6 of file ToF.cpp.

ToF() [2/2]

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

Definition at line 7 of file ToF.cpp.

Member Function Documentation

getProperties()

ToF::Properties & dai::node::ToF::getProperties ( )

protectedvirtual

Reimplemented from dai::Node.

Definition at line 13 of file ToF.cpp.

setNumFramesPool()

ToF & dai::node::ToF::setNumFramesPool

(

int

numFramesPool

)

Specify number of frames in output pool

Parameters

numFramesPool

Number of frames in output pool

Definition at line 23 of file ToF.cpp.

setNumShaves()

ToF & dai::node::ToF::setNumShaves

(

int

numShaves

)

Specify number of shaves reserved for ToF decoding.

Definition at line 18 of file ToF.cpp.

Member Data Documentation

amplitude

Output dai::node::ToF::amplitude {*this, "amplitude", Output::Type::MSender, {{DatatypeEnum::ImgFrame, true}}}

Outputs ImgFrame message that carries amplitude image.

Definition at line 57 of file ToF.hpp.

depth

Output dai::node::ToF::depth {*this, "depth", Output::Type::MSender, {{DatatypeEnum::ImgFrame, true}}}

Outputs ImgFrame message that carries decoded depth image.

Definition at line 53 of file ToF.hpp.

initialConfig

ToFConfig dai::node::ToF::initialConfig

Initial config to use for depth calculation.

Definition at line 36 of file ToF.hpp.

input

Input dai::node::ToF::input {*this, "input", Input::Type::SReceiver, true, 8, {{DatatypeEnum::ImgFrame, true}}}

Input raw ToF data. Default queue is blocking with size 8.

Definition at line 48 of file ToF.hpp.

inputConfig

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

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

Definition at line 42 of file ToF.hpp.

intensity

Output dai::node::ToF::intensity {*this, "intensity", Output::Type::MSender, {{DatatypeEnum::ImgFrame, true}}}

Outputs ImgFrame message that carries intensity image.

Definition at line 61 of file ToF.hpp.

NAME

constexpr static const char* dai::node::ToF::NAME = "ToF"

staticconstexpr

Definition at line 18 of file ToF.hpp.

phase

Output dai::node::ToF::phase {*this, "phase", Output::Type::MSender, {{DatatypeEnum::ImgFrame, true}}}

Outputs ImgFrame message that carries phase image, useful for debugging. float32 type.

Definition at line 65 of file ToF.hpp.

rawConfig

std::shared_ptr<RawToFConfig> dai::node::ToF::rawConfig

private

Definition at line 24 of file ToF.hpp.

---

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

• ToF.hpp
• ToF.cpp