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

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

#include <ImageAlign.hpp>

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

Public Member Functions

 ImageAlign (const std::shared_ptr< PipelineImpl > &par, int64_t nodeId)
 
 ImageAlign (const std::shared_ptr< PipelineImpl > &par, int64_t nodeId, std::unique_ptr< Properties > props)
 
ImageAlignsetInterpolation (Interpolation interp)
 
ImageAlignsetNumFramesPool (int numFramesPool)
 
ImageAlignsetNumShaves (int numShaves)
 
ImageAlignsetOutKeepAspectRatio (bool keep)
 
ImageAlignsetOutputSize (int alignWidth, int alignHeight)
 
- Public Member Functions inherited from dai::NodeCRTP< Node, ImageAlign, ImageAlignProperties >
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

ImageAlignConfig initialConfig
 
Input input {*this, "input", Input::Type::SReceiver, false, 4, true, {{DatatypeEnum::ImgFrame, false}}}
 
Input inputAlignTo {*this, "inputAlignTo", Input::Type::SReceiver, false, 1, true, {{DatatypeEnum::ImgFrame, false}}}
 
Input inputConfig {*this, "inputConfig", Input::Type::SReceiver, false, 4, {{DatatypeEnum::ImageAlignConfig, false}}}
 
Output outputAligned {*this, "outputAligned", Output::Type::MSender, {{DatatypeEnum::ImgFrame, false}}}
 
Output passthroughInput {*this, "passthroughInput", Output::Type::MSender, {{DatatypeEnum::ImgFrame, false}}}
 
- Public Attributes inherited from dai::NodeCRTP< Node, ImageAlign, ImageAlignProperties >
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 = "ImageAlign"
 

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< RawImageAlignConfigrawConfig
 

Additional Inherited Members

- Public Types inherited from dai::NodeCRTP< Node, ImageAlign, ImageAlignProperties >
using Properties = ImageAlignProperties
 
- 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

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

Definition at line 16 of file ImageAlign.hpp.

Constructor & Destructor Documentation

◆ ImageAlign() [1/2]

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

Definition at line 6 of file ImageAlign.cpp.

◆ ImageAlign() [2/2]

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

Definition at line 7 of file ImageAlign.cpp.

Member Function Documentation

◆ getProperties()

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

Reimplemented from dai::Node.

Definition at line 15 of file ImageAlign.cpp.

◆ setInterpolation()

ImageAlign & dai::node::ImageAlign::setInterpolation ( Interpolation  interp)

Specify interpolation method to use when resizing

Definition at line 30 of file ImageAlign.cpp.

◆ setNumFramesPool()

ImageAlign & dai::node::ImageAlign::setNumFramesPool ( int  numFramesPool)

Specify number of frames in the pool

Definition at line 40 of file ImageAlign.cpp.

◆ setNumShaves()

ImageAlign & dai::node::ImageAlign::setNumShaves ( int  numShaves)

Specify number of shaves to use for this node

Definition at line 35 of file ImageAlign.cpp.

◆ setOutKeepAspectRatio()

ImageAlign & dai::node::ImageAlign::setOutKeepAspectRatio ( bool  keep)

Specify whether to keep aspect ratio when resizing

Definition at line 25 of file ImageAlign.cpp.

◆ setOutputSize()

ImageAlign & dai::node::ImageAlign::setOutputSize ( int  alignWidth,
int  alignHeight 
)

Specify the output size of the aligned image

Definition at line 20 of file ImageAlign.cpp.

Member Data Documentation

◆ initialConfig

ImageAlignConfig dai::node::ImageAlign::initialConfig

Initial config to use when calculating spatial location data.

Definition at line 33 of file ImageAlign.hpp.

◆ input

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

Input message. Default queue is non-blocking with size 4.

Definition at line 45 of file ImageAlign.hpp.

◆ inputAlignTo

Input dai::node::ImageAlign::inputAlignTo {*this, "inputAlignTo", Input::Type::SReceiver, false, 1, true, {{DatatypeEnum::ImgFrame, false}}}

Input align to message. Default queue is non-blocking with size 1.

Definition at line 51 of file ImageAlign.hpp.

◆ inputConfig

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

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

Definition at line 39 of file ImageAlign.hpp.

◆ NAME

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

Definition at line 18 of file ImageAlign.hpp.

◆ outputAligned

Output dai::node::ImageAlign::outputAligned {*this, "outputAligned", Output::Type::MSender, {{DatatypeEnum::ImgFrame, false}}}

Outputs ImgFrame message that is aligned to inputAlignTo.

Definition at line 56 of file ImageAlign.hpp.

◆ passthroughInput

Output dai::node::ImageAlign::passthroughInput {*this, "passthroughInput", 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 62 of file ImageAlign.hpp.

◆ rawConfig

std::shared_ptr<RawImageAlignConfig> dai::node::ImageAlign::rawConfig
private

Definition at line 24 of file ImageAlign.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