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

#include <ColorCameraProperties.hpp>

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

Classes

struct  IspScale
 

Public Types

enum  ColorOrder : int32_t { ColorOrder::BGR, ColorOrder::RGB }
 
enum  SensorResolution : int32_t {
  SensorResolution::THE_1080_P, SensorResolution::THE_4_K, SensorResolution::THE_12_MP, SensorResolution::THE_13_MP,
  SensorResolution::THE_720_P, SensorResolution::THE_800_P, SensorResolution::THE_1200_P, SensorResolution::THE_5_MP,
  SensorResolution::THE_4000X3000, SensorResolution::THE_5312X6000, SensorResolution::THE_48_MP, SensorResolution::THE_1440X1080,
  SensorResolution::THE_1352X1012, SensorResolution::THE_2024X1520
}
 

Public Attributes

CameraBoardSocket boardSocket = CameraBoardSocket::AUTO
 
std::string cameraName = ""
 
ColorOrder colorOrder = ColorOrder::BGR
 
std::vector< dai::FrameEventeventFilter = {dai::FrameEvent::READOUT_START}
 
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 = 300
 
bool previewKeepAspectRatio = true
 
uint32_t previewWidth = 300
 
tl::optional< bool > rawPacked
 
SensorResolution resolution = SensorResolution::THE_1080_P
 
float sensorCropX = AUTO
 
float sensorCropY = AUTO
 
int32_t stillHeight = AUTO
 
int32_t stillWidth = AUTO
 
int32_t videoHeight = AUTO
 
int32_t videoWidth = AUTO
 

Static Public Attributes

static constexpr int AUTO = -1
 

Additional Inherited Members

- Public Member Functions inherited from dai::PropertiesSerializable< Properties, ColorCameraProperties >
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 17 of file ColorCameraProperties.hpp.

Member Enumeration Documentation

◆ ColorOrder

For 24 bit color these can be either RGB or BGR

Enumerator
BGR 
RGB 

Definition at line 66 of file ColorCameraProperties.hpp.

◆ SensorResolution

Select the camera sensor resolution

Enumerator
THE_1080_P 

1920 × 1080

THE_4_K 

3840 × 2160

THE_12_MP 

4056 × 3040

THE_13_MP 

4208 × 3120

THE_720_P 

1280 × 720

THE_800_P 

1280 × 800

THE_1200_P 

1920 × 1200

THE_5_MP 

2592 × 1944

THE_4000X3000 

4000 × 3000

THE_5312X6000 

5312 × 6000

THE_48_MP 

8000 × 6000

THE_1440X1080 

1440 × 1080

THE_1352X1012 

1352 × 1012

THE_2024X1520 

2024 × 1520

Definition at line 32 of file ColorCameraProperties.hpp.

Member Data Documentation

◆ AUTO

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

Definition at line 18 of file ColorCameraProperties.hpp.

◆ boardSocket

CameraBoardSocket dai::ColorCameraProperties::boardSocket = CameraBoardSocket::AUTO

Which socket will color camera use

Definition at line 76 of file ColorCameraProperties.hpp.

◆ cameraName

std::string dai::ColorCameraProperties::cameraName = ""

Which camera name will color camera use

Definition at line 81 of file ColorCameraProperties.hpp.

◆ colorOrder

ColorOrder dai::ColorCameraProperties::colorOrder = ColorOrder::BGR

For 24 bit color these can be either RGB or BGR

Definition at line 91 of file ColorCameraProperties.hpp.

◆ eventFilter

std::vector<dai::FrameEvent> dai::ColorCameraProperties::eventFilter = {dai::FrameEvent::READOUT_START}

List of events to receive, the rest will be ignored

Definition at line 177 of file ColorCameraProperties.hpp.

◆ fp16

bool dai::ColorCameraProperties::fp16 = false

Are values FP16 type (0.0 - 255.0)

Definition at line 99 of file ColorCameraProperties.hpp.

◆ fps

float dai::ColorCameraProperties::fps = 30.0

Camera sensor FPS

Definition at line 137 of file ColorCameraProperties.hpp.

◆ imageOrientation

CameraImageOrientation dai::ColorCameraProperties::imageOrientation = CameraImageOrientation::AUTO

Camera sensor image orientation / pixel readout

Definition at line 86 of file ColorCameraProperties.hpp.

◆ initialControl

RawCameraControl dai::ColorCameraProperties::initialControl

Definition at line 71 of file ColorCameraProperties.hpp.

◆ interleaved

bool dai::ColorCameraProperties::interleaved = true

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

Definition at line 95 of file ColorCameraProperties.hpp.

◆ isp3aFps

int dai::ColorCameraProperties::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 147 of file ColorCameraProperties.hpp.

◆ ispScale

IspScale dai::ColorCameraProperties::ispScale

Configure scaling for isp output.

Definition at line 163 of file ColorCameraProperties.hpp.

◆ numFramesPoolIsp

int dai::ColorCameraProperties::numFramesPoolIsp = 3

Definition at line 169 of file ColorCameraProperties.hpp.

◆ numFramesPoolPreview

int dai::ColorCameraProperties::numFramesPoolPreview = 4

Definition at line 171 of file ColorCameraProperties.hpp.

◆ numFramesPoolRaw

int dai::ColorCameraProperties::numFramesPoolRaw = 3

Pool sizes

Definition at line 168 of file ColorCameraProperties.hpp.

◆ numFramesPoolStill

int dai::ColorCameraProperties::numFramesPoolStill = 4

Definition at line 172 of file ColorCameraProperties.hpp.

◆ numFramesPoolVideo

int dai::ColorCameraProperties::numFramesPoolVideo = 4

Definition at line 170 of file ColorCameraProperties.hpp.

◆ previewHeight

uint32_t dai::ColorCameraProperties::previewHeight = 300

Preview frame output height

Definition at line 104 of file ColorCameraProperties.hpp.

◆ previewKeepAspectRatio

bool dai::ColorCameraProperties::previewKeepAspectRatio = true

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

Definition at line 158 of file ColorCameraProperties.hpp.

◆ previewWidth

uint32_t dai::ColorCameraProperties::previewWidth = 300

Preview frame output width

Definition at line 108 of file ColorCameraProperties.hpp.

◆ rawPacked

tl::optional<bool> dai::ColorCameraProperties::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 188 of file ColorCameraProperties.hpp.

◆ resolution

SensorResolution dai::ColorCameraProperties::resolution = SensorResolution::THE_1080_P

Select the camera sensor resolution

Definition at line 133 of file ColorCameraProperties.hpp.

◆ sensorCropX

float dai::ColorCameraProperties::sensorCropX = AUTO

Initial sensor crop, -1 signifies center crop

Definition at line 152 of file ColorCameraProperties.hpp.

◆ sensorCropY

float dai::ColorCameraProperties::sensorCropY = AUTO

Definition at line 153 of file ColorCameraProperties.hpp.

◆ stillHeight

int32_t dai::ColorCameraProperties::stillHeight = AUTO

Preview frame output height

Definition at line 128 of file ColorCameraProperties.hpp.

◆ stillWidth

int32_t dai::ColorCameraProperties::stillWidth = AUTO

Preview frame output width

Definition at line 123 of file ColorCameraProperties.hpp.

◆ videoHeight

int32_t dai::ColorCameraProperties::videoHeight = AUTO

Preview frame output height

Definition at line 118 of file ColorCameraProperties.hpp.

◆ videoWidth

int32_t dai::ColorCameraProperties::videoWidth = AUTO

Preview frame output width

Definition at line 113 of file ColorCameraProperties.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