Classes | Public Types | Public Attributes | Static Public Attributes | List of all members
dai::CameraProperties Struct Reference

#include <CameraProperties.hpp>

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

Classes

struct  IspScale
 

Public Types

enum  ColorOrder : int32_t { ColorOrder::BGR, ColorOrder::RGB }
 
enum  WarpMeshSource { WarpMeshSource::AUTO = -1, WarpMeshSource::NONE, WarpMeshSource::CALIBRATION, WarpMeshSource::URI }
 

Public Attributes

CameraBoardSocket boardSocket = CameraBoardSocket::AUTO
 
tl::optional< float > calibAlpha
 
std::string cameraName = ""
 
ColorOrder colorOrder = ColorOrder::BGR
 
bool fp16 = false
 
float fps = 30.0
 
CameraImageOrientation imageOrientation = CameraImageOrientation::AUTO
 
RawCameraControl initialControl
 
bool interleaved = true
 
int isp3aFps = 0
 
IspScale ispScale
 
int numFramesPoolIsp = 3
 
int numFramesPoolPreview = 4
 
int numFramesPoolRaw = 3
 
int numFramesPoolStill = 4
 
int numFramesPoolVideo = 4
 
uint32_t previewHeight = DEFAULT_PREVIEW_HEIGHT
 
bool previewKeepAspectRatio = false
 
uint32_t previewWidth = DEFAULT_PREVIEW_WIDTH
 
tl::optional< bool > rawPacked
 
int32_t resolutionHeight = AUTO
 
int32_t resolutionWidth = AUTO
 
float sensorCropX = AUTO
 
float sensorCropY = AUTO
 
CameraSensorType sensorType = CameraSensorType::AUTO
 Type of sensor, specifies what kind of postprocessing is performed. More...
 
int32_t stillHeight = AUTO
 
int32_t stillWidth = AUTO
 
int32_t videoHeight = AUTO
 
int32_t videoWidth = AUTO
 
int warpMeshHeight
 
WarpMeshSource warpMeshSource = WarpMeshSource::AUTO
 
int warpMeshStepHeight = 32
 
int warpMeshStepWidth = 32
 
std::string warpMeshUri = ""
 
int warpMeshWidth
 

Static Public Attributes

static constexpr int AUTO = -1
 
static constexpr uint32_t DEFAULT_PREVIEW_HEIGHT = 300
 
static constexpr uint32_t DEFAULT_PREVIEW_WIDTH = 300
 

Additional Inherited Members

- Public Member Functions inherited from dai::PropertiesSerializable< Properties, CameraProperties >
virtual std::unique_ptr< Propertiesclone () const override
 
virtual void serialize (std::vector< std::uint8_t > &data, SerializationType type=SerializationType::LIBNOP) const override
 
- Public Member Functions inherited from dai::Properties
virtual std::unique_ptr< Propertiesclone () const =0
 
virtual ~Properties ()=default
 

Detailed Description

Specify properties for ColorCamera such as camera ID, ...

Definition at line 15 of file CameraProperties.hpp.

Member Enumeration Documentation

◆ ColorOrder

enum dai::CameraProperties::ColorOrder : int32_t
strong

For 24 bit color these can be either RGB or BGR

Enumerator
BGR 
RGB 

Definition at line 30 of file CameraProperties.hpp.

◆ WarpMeshSource

Warp mesh source

Enumerator
AUTO 
NONE 
CALIBRATION 
URI 

Definition at line 152 of file CameraProperties.hpp.

Member Data Documentation

◆ AUTO

constexpr int dai::CameraProperties::AUTO = -1
staticconstexpr

Definition at line 16 of file CameraProperties.hpp.

◆ boardSocket

CameraBoardSocket dai::CameraProperties::boardSocket = CameraBoardSocket::AUTO

Which socket will color camera use

Definition at line 40 of file CameraProperties.hpp.

◆ calibAlpha

tl::optional<float> dai::CameraProperties::calibAlpha

Free scaling parameter between 0 (when all the pixels in the undistorted image are valid) and 1 (when all the source image pixels are retained in the undistorted image). On some high distortion lenses, and/or due to rectification (image rotated) invalid areas may appear even with alpha=0, in these cases alpha < 0.0 helps removing invalid areas. See getOptimalNewCameraMatrix from opencv for more details.

Definition at line 163 of file CameraProperties.hpp.

◆ cameraName

std::string dai::CameraProperties::cameraName = ""

Which camera name will color camera use

Definition at line 45 of file CameraProperties.hpp.

◆ colorOrder

ColorOrder dai::CameraProperties::colorOrder = ColorOrder::BGR

For 24 bit color these can be either RGB or BGR

Definition at line 55 of file CameraProperties.hpp.

◆ DEFAULT_PREVIEW_HEIGHT

constexpr uint32_t dai::CameraProperties::DEFAULT_PREVIEW_HEIGHT = 300
staticconstexpr

Definition at line 65 of file CameraProperties.hpp.

◆ DEFAULT_PREVIEW_WIDTH

constexpr uint32_t dai::CameraProperties::DEFAULT_PREVIEW_WIDTH = 300
staticconstexpr

Definition at line 66 of file CameraProperties.hpp.

◆ fp16

bool dai::CameraProperties::fp16 = false

Are values FP16 type (0.0 - 255.0)

Definition at line 63 of file CameraProperties.hpp.

◆ fps

float dai::CameraProperties::fps = 30.0

Camera sensor FPS

Definition at line 109 of file CameraProperties.hpp.

◆ imageOrientation

CameraImageOrientation dai::CameraProperties::imageOrientation = CameraImageOrientation::AUTO

Camera sensor image orientation / pixel readout

Definition at line 50 of file CameraProperties.hpp.

◆ initialControl

RawCameraControl dai::CameraProperties::initialControl

Initial controls applied to ColorCamera node

Definition at line 35 of file CameraProperties.hpp.

◆ interleaved

bool dai::CameraProperties::interleaved = true

Are colors interleaved (R1G1B1, R2G2B2, ...) or planar (R1R2..., G1G2..., B1B2)

Definition at line 59 of file CameraProperties.hpp.

◆ isp3aFps

int dai::CameraProperties::isp3aFps = 0

Isp 3A rate (auto focus, auto exposure, auto white balance, camera controls etc.). Default (0) matches the camera FPS, meaning that 3A is running on each frame. Reducing the rate of 3A reduces the CPU usage on CSS, but also increases the convergence rate of 3A. Note that camera controls will be processed at this rate. E.g. if camera is running at 30 fps, and camera control is sent at every frame, but 3A fps is set to 15, the camera control messages will be processed at 15 fps rate, which will lead to queueing.

Definition at line 119 of file CameraProperties.hpp.

◆ ispScale

IspScale dai::CameraProperties::ispScale

Configure scaling for isp output.

Definition at line 135 of file CameraProperties.hpp.

◆ numFramesPoolIsp

int dai::CameraProperties::numFramesPoolIsp = 3

Definition at line 144 of file CameraProperties.hpp.

◆ numFramesPoolPreview

int dai::CameraProperties::numFramesPoolPreview = 4

Definition at line 146 of file CameraProperties.hpp.

◆ numFramesPoolRaw

int dai::CameraProperties::numFramesPoolRaw = 3

Pool sizes

Definition at line 143 of file CameraProperties.hpp.

◆ numFramesPoolStill

int dai::CameraProperties::numFramesPoolStill = 4

Definition at line 147 of file CameraProperties.hpp.

◆ numFramesPoolVideo

int dai::CameraProperties::numFramesPoolVideo = 4

Definition at line 145 of file CameraProperties.hpp.

◆ previewHeight

uint32_t dai::CameraProperties::previewHeight = DEFAULT_PREVIEW_HEIGHT

Preview frame output height

Definition at line 71 of file CameraProperties.hpp.

◆ previewKeepAspectRatio

bool dai::CameraProperties::previewKeepAspectRatio = false

Whether to keep aspect ratio of input (video/preview size) or not

Definition at line 130 of file CameraProperties.hpp.

◆ previewWidth

uint32_t dai::CameraProperties::previewWidth = DEFAULT_PREVIEW_WIDTH

Preview frame output width

Definition at line 75 of file CameraProperties.hpp.

◆ rawPacked

tl::optional<bool> dai::CameraProperties::rawPacked

Configures whether the camera raw frames are saved as MIPI-packed to memory. The packed format is more efficient, consuming less memory on device, and less data to send to host: RAW10: 4 pixels saved on 5 bytes, RAW12: 2 pixels saved on 3 bytes. When packing is disabled (false), data is saved lsb-aligned, e.g. a RAW10 pixel will be stored as uint16, on bits 9..0: 0b0000'00pp'pppp'pppp. Default is auto: enabled for standard color/monochrome cameras where ISP can work with both packed/unpacked, but disabled for other cameras like ToF.

Definition at line 176 of file CameraProperties.hpp.

◆ resolutionHeight

int32_t dai::CameraProperties::resolutionHeight = AUTO

Select the camera sensor height

Definition at line 104 of file CameraProperties.hpp.

◆ resolutionWidth

int32_t dai::CameraProperties::resolutionWidth = AUTO

Select the camera sensor width

Definition at line 100 of file CameraProperties.hpp.

◆ sensorCropX

float dai::CameraProperties::sensorCropX = AUTO

Initial sensor crop, -1 signifies center crop

Definition at line 124 of file CameraProperties.hpp.

◆ sensorCropY

float dai::CameraProperties::sensorCropY = AUTO

Definition at line 125 of file CameraProperties.hpp.

◆ sensorType

CameraSensorType dai::CameraProperties::sensorType = CameraSensorType::AUTO

Type of sensor, specifies what kind of postprocessing is performed.

Definition at line 138 of file CameraProperties.hpp.

◆ stillHeight

int32_t dai::CameraProperties::stillHeight = AUTO

Preview frame output height

Definition at line 95 of file CameraProperties.hpp.

◆ stillWidth

int32_t dai::CameraProperties::stillWidth = AUTO

Preview frame output width

Definition at line 90 of file CameraProperties.hpp.

◆ videoHeight

int32_t dai::CameraProperties::videoHeight = AUTO

Preview frame output height

Definition at line 85 of file CameraProperties.hpp.

◆ videoWidth

int32_t dai::CameraProperties::videoWidth = AUTO

Preview frame output width

Definition at line 80 of file CameraProperties.hpp.

◆ warpMeshHeight

int dai::CameraProperties::warpMeshHeight

Definition at line 155 of file CameraProperties.hpp.

◆ warpMeshSource

WarpMeshSource dai::CameraProperties::warpMeshSource = WarpMeshSource::AUTO

Definition at line 153 of file CameraProperties.hpp.

◆ warpMeshStepHeight

int dai::CameraProperties::warpMeshStepHeight = 32

Definition at line 165 of file CameraProperties.hpp.

◆ warpMeshStepWidth

int dai::CameraProperties::warpMeshStepWidth = 32

Definition at line 164 of file CameraProperties.hpp.

◆ warpMeshUri

std::string dai::CameraProperties::warpMeshUri = ""

Definition at line 154 of file CameraProperties.hpp.

◆ warpMeshWidth

int dai::CameraProperties::warpMeshWidth

Definition at line 155 of file CameraProperties.hpp.


The documentation for this struct was generated from the following file:


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