Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
dai::ImageManipConfig Class Reference

#include <ImageManipConfig.hpp>

Inheritance diagram for dai::ImageManipConfig:
Inheritance graph
[legend]

Public Types

using CropConfig = RawImageManipConfig::CropConfig
 
using FormatConfig = RawImageManipConfig::FormatConfig
 
using ResizeConfig = RawImageManipConfig::ResizeConfig
 

Public Member Functions

dai::RawImageManipConfig get () const
 
Colormap getColormap () const
 
CropConfig getCropConfig () const
 
float getCropXMax () const
 
float getCropXMin () const
 
float getCropYMax () const
 
float getCropYMin () const
 
FormatConfig getFormatConfig () const
 
dai::Interpolation getInterpolation () const
 Retrieve which interpolation method to use. More...
 
ResizeConfig getResizeConfig () const
 
int getResizeHeight () const
 
int getResizeWidth () const
 
 ImageManipConfig ()
 Construct ImageManipConfig message. More...
 
 ImageManipConfig (std::shared_ptr< RawImageManipConfig > ptr)
 
bool isResizeThumbnail () const
 
ImageManipConfigset (dai::RawImageManipConfig config)
 
ImageManipConfigsetCenterCrop (float ratio, float whRatio=1.0f)
 
ImageManipConfigsetColormap (Colormap colormap, float maxf)
 
ImageManipConfigsetColormap (Colormap colormap, int max=255)
 
ImageManipConfigsetColormap (Colormap colormap, int min, int max)
 
ImageManipConfigsetCropRect (float xmin, float ymin, float xmax, float ymax)
 
ImageManipConfigsetCropRect (std::tuple< float, float, float, float > coordinates)
 
ImageManipConfigsetCropRotatedRect (RotatedRect rr, bool normalizedCoords=true)
 
ImageManipConfigsetFrameType (ImgFrame::Type name)
 
ImageManipConfigsetHorizontalFlip (bool flip)
 
ImageManipConfigsetInterpolation (dai::Interpolation interpolation)
 
ImageManipConfigsetKeepAspectRatio (bool keep)
 
ImageManipConfigsetResize (int w, int h)
 
ImageManipConfigsetResize (std::tuple< int, int > size)
 
ImageManipConfigsetResizeThumbnail (int w, int h, int bgRed=0, int bgGreen=0, int bgBlue=0)
 
ImageManipConfigsetResizeThumbnail (std::tuple< int, int > size, int bgRed=0, int bgGreen=0, int bgBlue=0)
 
ImageManipConfigsetReusePreviousImage (bool reuse)
 
ImageManipConfigsetRotationDegrees (float deg)
 
ImageManipConfigsetRotationRadians (float rad)
 
ImageManipConfigsetSkipCurrentImage (bool skip)
 
void setVerticalFlip (bool flip)
 
ImageManipConfigsetWarpBorderFillColor (int red, int green, int blue)
 
ImageManipConfigsetWarpBorderReplicatePixels ()
 
ImageManipConfigsetWarpTransformFourPoints (std::vector< Point2f > pt, bool normalizedCoords)
 
ImageManipConfigsetWarpTransformMatrix3x3 (std::vector< float > mat)
 
virtual ~ImageManipConfig ()=default
 
- Public Member Functions inherited from dai::Buffer
 Buffer ()
 Creates Buffer message. More...
 
 Buffer (std::shared_ptr< dai::RawBuffer > ptr)
 
std::vector< std::uint8_t > & getData () const
 Get non-owning reference to internal buffer. More...
 
int64_t getSequenceNum () const
 
std::chrono::time_point< std::chrono::steady_clock, std::chrono::steady_clock::duration > getTimestamp () const
 
std::chrono::time_point< std::chrono::steady_clock, std::chrono::steady_clock::duration > getTimestampDevice () const
 
void setData (const std::vector< std::uint8_t > &data)
 
void setData (std::vector< std::uint8_t > &&data)
 
BuffersetSequenceNum (int64_t sequenceNum)
 
BuffersetTimestamp (std::chrono::time_point< std::chrono::steady_clock, std::chrono::steady_clock::duration > timestamp)
 
BuffersetTimestampDevice (std::chrono::time_point< std::chrono::steady_clock, std::chrono::steady_clock::duration > timestamp)
 
virtual ~Buffer ()=default
 
- Public Member Functions inherited from dai::ADatatype
 ADatatype (std::shared_ptr< RawBuffer > r)
 
std::shared_ptr< RawBuffergetRaw () const
 
virtual ~ADatatype ()=default
 

Private Member Functions

std::shared_ptr< RawBufferserialize () const override
 

Private Attributes

RawImageManipConfigcfg
 

Additional Inherited Members

- Protected Attributes inherited from dai::ADatatype
std::shared_ptr< RawBufferraw
 

Detailed Description

ImageManipConfig message. Specifies image manipulation options like:

Definition at line 23 of file ImageManipConfig.hpp.

Member Typedef Documentation

◆ CropConfig

Definition at line 29 of file ImageManipConfig.hpp.

◆ FormatConfig

Definition at line 31 of file ImageManipConfig.hpp.

◆ ResizeConfig

Definition at line 30 of file ImageManipConfig.hpp.

Constructor & Destructor Documentation

◆ ImageManipConfig() [1/2]

dai::ImageManipConfig::ImageManipConfig ( )

Construct ImageManipConfig message.

Definition at line 13 of file ImageManipConfig.cpp.

◆ ImageManipConfig() [2/2]

dai::ImageManipConfig::ImageManipConfig ( std::shared_ptr< RawImageManipConfig ptr)
explicit

Definition at line 14 of file ImageManipConfig.cpp.

◆ ~ImageManipConfig()

virtual dai::ImageManipConfig::~ImageManipConfig ( )
virtualdefault

Member Function Documentation

◆ get()

dai::RawImageManipConfig dai::ImageManipConfig::get ( ) const

Retrieve configuration data for ImageManip.

Returns
config for ImageManip

Definition at line 288 of file ImageManipConfig.cpp.

◆ getColormap()

dai::Colormap dai::ImageManipConfig::getColormap ( ) const
Returns
specified colormap

Definition at line 284 of file ImageManipConfig.cpp.

◆ getCropConfig()

ImageManipConfig::CropConfig dai::ImageManipConfig::getCropConfig ( ) const
Returns
Crop configuration

Definition at line 268 of file ImageManipConfig.cpp.

◆ getCropXMax()

float dai::ImageManipConfig::getCropXMax ( ) const
Returns
Bottom right X coordinate of crop region

Definition at line 252 of file ImageManipConfig.cpp.

◆ getCropXMin()

float dai::ImageManipConfig::getCropXMin ( ) const
Returns
Top left X coordinate of crop region

Definition at line 244 of file ImageManipConfig.cpp.

◆ getCropYMax()

float dai::ImageManipConfig::getCropYMax ( ) const
Returns
Bottom right Y coordinate of crop region

Definition at line 256 of file ImageManipConfig.cpp.

◆ getCropYMin()

float dai::ImageManipConfig::getCropYMin ( ) const
Returns
Top left Y coordinate of crop region

Definition at line 248 of file ImageManipConfig.cpp.

◆ getFormatConfig()

ImageManipConfig::FormatConfig dai::ImageManipConfig::getFormatConfig ( ) const
Returns
Format configuration

Definition at line 276 of file ImageManipConfig.cpp.

◆ getInterpolation()

dai::Interpolation dai::ImageManipConfig::getInterpolation ( ) const

Retrieve which interpolation method to use.

Definition at line 297 of file ImageManipConfig.cpp.

◆ getResizeConfig()

ImageManipConfig::ResizeConfig dai::ImageManipConfig::getResizeConfig ( ) const
Returns
Resize configuration

Definition at line 272 of file ImageManipConfig.cpp.

◆ getResizeHeight()

int dai::ImageManipConfig::getResizeHeight ( ) const
Returns
Output image height

Definition at line 264 of file ImageManipConfig.cpp.

◆ getResizeWidth()

int dai::ImageManipConfig::getResizeWidth ( ) const
Returns
Output image width

Definition at line 260 of file ImageManipConfig.cpp.

◆ isResizeThumbnail()

bool dai::ImageManipConfig::isResizeThumbnail ( ) const
Returns
True if resize thumbnail mode is set, false otherwise

Definition at line 280 of file ImageManipConfig.cpp.

◆ serialize()

std::shared_ptr< RawBuffer > dai::ImageManipConfig::serialize ( ) const
overrideprivatevirtual

Reimplemented from dai::Buffer.

Definition at line 9 of file ImageManipConfig.cpp.

◆ set()

ImageManipConfig & dai::ImageManipConfig::set ( dai::RawImageManipConfig  config)

Set explicit configuration.

Parameters
configExplicit configuration

Definition at line 292 of file ImageManipConfig.cpp.

◆ setCenterCrop()

ImageManipConfig & dai::ImageManipConfig::setCenterCrop ( float  ratio,
float  whRatio = 1.0f 
)

Specifies a centered crop.

Parameters
ratioRatio between input image and crop region (0..1)
whRatioCrop region aspect ratio - 1 equals to square, 1.7 equals to 16:9, ...

Definition at line 83 of file ImageManipConfig.cpp.

◆ setColormap() [1/3]

ImageManipConfig & dai::ImageManipConfig::setColormap ( dai::Colormap  colormap,
float  maxf 
)

Definition at line 164 of file ImageManipConfig.cpp.

◆ setColormap() [2/3]

ImageManipConfig & dai::ImageManipConfig::setColormap ( dai::Colormap  colormap,
int  max = 255 
)

Definition at line 178 of file ImageManipConfig.cpp.

◆ setColormap() [3/3]

ImageManipConfig & dai::ImageManipConfig::setColormap ( dai::Colormap  colormap,
int  min,
int  max 
)

Specify gray to color conversion map

Parameters
colormapmap from Colormap enum or Colormap::NONE to disable

Definition at line 191 of file ImageManipConfig.cpp.

◆ setCropRect() [1/2]

ImageManipConfig & dai::ImageManipConfig::setCropRect ( float  xmin,
float  ymin,
float  xmax,
float  ymax 
)

Specifies crop with rectangle with normalized values (0..1)

Parameters
xminTop left X coordinate of rectangle
yminTop left Y coordinate of rectangle
xmaxBottom right X coordinate of rectangle
ymaxBottom right Y coordinate of rectangle

Definition at line 18 of file ImageManipConfig.cpp.

◆ setCropRect() [2/2]

ImageManipConfig & dai::ImageManipConfig::setCropRect ( std::tuple< float, float, float, float >  coordinates)

Specifies crop with rectangle with normalized values (0..1)

Parameters
coordinatesCoordinate of rectangle

Definition at line 33 of file ImageManipConfig.cpp.

◆ setCropRotatedRect()

ImageManipConfig & dai::ImageManipConfig::setCropRotatedRect ( RotatedRect  rr,
bool  normalizedCoords = true 
)

Specifies crop with rotated rectangle. Optionally as non normalized coordinates

Parameters
rrRotated rectangle which specifies crop
normalizedCoordsIf true coordinates are in normalized range (0..1) otherwise absolute

Definition at line 38 of file ImageManipConfig.cpp.

◆ setFrameType()

ImageManipConfig & dai::ImageManipConfig::setFrameType ( ImgFrame::Type  name)

Specify output frame type.

Parameters
nameFrame type

Definition at line 155 of file ImageManipConfig.cpp.

◆ setHorizontalFlip()

ImageManipConfig & dai::ImageManipConfig::setHorizontalFlip ( bool  flip)

Specify horizontal flip

Parameters
flipTrue to enable flip, false otherwise

Definition at line 205 of file ImageManipConfig.cpp.

◆ setInterpolation()

ImageManipConfig & dai::ImageManipConfig::setInterpolation ( dai::Interpolation  interpolation)

Specify which interpolation method to use

Parameters
interpolationtype of interpolation

Definition at line 238 of file ImageManipConfig.cpp.

◆ setKeepAspectRatio()

ImageManipConfig & dai::ImageManipConfig::setKeepAspectRatio ( bool  keep)

Specifies to whether to keep aspect ratio or not

Definition at line 232 of file ImageManipConfig.cpp.

◆ setResize() [1/2]

ImageManipConfig & dai::ImageManipConfig::setResize ( int  w,
int  h 
)

Specifies output image size. After crop stage the image will be stretched to fit.

Parameters
wWidth in pixels
hHeight in pixels

Definition at line 114 of file ImageManipConfig.cpp.

◆ setResize() [2/2]

ImageManipConfig & dai::ImageManipConfig::setResize ( std::tuple< int, int >  size)

Specifies output image size. After crop stage the image will be stretched to fit.

Parameters
sizeSize in pixels

Definition at line 127 of file ImageManipConfig.cpp.

◆ setResizeThumbnail() [1/2]

ImageManipConfig & dai::ImageManipConfig::setResizeThumbnail ( int  w,
int  h,
int  bgRed = 0,
int  bgGreen = 0,
int  bgBlue = 0 
)

Specifies output image size. After crop stage the image will be resized by preserving aspect ration. Optionally background can be specified.

Parameters
wWidth in pixels
hHeight in pixels
bgRedRed component
bgGreenGreen component
bgBlueBlue component

Definition at line 132 of file ImageManipConfig.cpp.

◆ setResizeThumbnail() [2/2]

ImageManipConfig & dai::ImageManipConfig::setResizeThumbnail ( std::tuple< int, int >  size,
int  bgRed = 0,
int  bgGreen = 0,
int  bgBlue = 0 
)

Specifies output image size. After crop stage the image will be resized by preserving aspect ration. Optionally background can be specified.

Parameters
sizeSize in pixels
bgRedRed component
bgGreenGreen component
bgBlueBlue component

Definition at line 150 of file ImageManipConfig.cpp.

◆ setReusePreviousImage()

ImageManipConfig & dai::ImageManipConfig::setReusePreviousImage ( bool  reuse)

Instruct ImageManip to not remove current image from its queue and use the same for next message.

Parameters
reuseTrue to enable reuse, false otherwise

Definition at line 222 of file ImageManipConfig.cpp.

◆ setRotationDegrees()

ImageManipConfig & dai::ImageManipConfig::setRotationDegrees ( float  deg)

Specifies clockwise rotation in degrees

Parameters
degRotation in degrees

Definition at line 101 of file ImageManipConfig.cpp.

◆ setRotationRadians()

ImageManipConfig & dai::ImageManipConfig::setRotationRadians ( float  rad)

Specifies clockwise rotation in radians

Parameters
radRotation in radians

Definition at line 108 of file ImageManipConfig.cpp.

◆ setSkipCurrentImage()

ImageManipConfig & dai::ImageManipConfig::setSkipCurrentImage ( bool  skip)

Instructs ImageManip to skip current image and wait for next in queue.

Parameters
skipTrue to skip current image, false otherwise

Definition at line 227 of file ImageManipConfig.cpp.

◆ setVerticalFlip()

void dai::ImageManipConfig::setVerticalFlip ( bool  flip)

Specify vertical flip

Parameters
flipTrue to enable vertical flip, false otherwise

Definition at line 214 of file ImageManipConfig.cpp.

◆ setWarpBorderFillColor()

ImageManipConfig & dai::ImageManipConfig::setWarpBorderFillColor ( int  red,
int  green,
int  blue 
)

Specifies fill color for border pixels. Example:

  • setWarpBorderFillColor(255,255,255) -> white
  • setWarpBorderFillColor(0,0,255) -> blue
Parameters
redRed component
greenGreen component
blueBlue component

Definition at line 73 of file ImageManipConfig.cpp.

◆ setWarpBorderReplicatePixels()

ImageManipConfig & dai::ImageManipConfig::setWarpBorderReplicatePixels ( )

Specifies that warp replicates border pixels

Definition at line 66 of file ImageManipConfig.cpp.

◆ setWarpTransformFourPoints()

ImageManipConfig & dai::ImageManipConfig::setWarpTransformFourPoints ( std::vector< Point2f pt,
bool  normalizedCoords 
)

Specifies warp by supplying 4 points in either absolute or normalized coordinates

Parameters
pt4 points specifying warp
normalizedCoordsIf true pt is interpreted as normalized, absolute otherwise

Definition at line 48 of file ImageManipConfig.cpp.

◆ setWarpTransformMatrix3x3()

ImageManipConfig & dai::ImageManipConfig::setWarpTransformMatrix3x3 ( std::vector< float >  mat)

Specifies warp with a 3x3 matrix

Parameters
mat3x3 matrix

Definition at line 58 of file ImageManipConfig.cpp.

Member Data Documentation

◆ cfg

RawImageManipConfig& dai::ImageManipConfig::cfg
private

Definition at line 25 of file ImageManipConfig.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