Struct DynamicCalibrationControl::Commands

Defined in File DynamicCalibrationControl.hpp

Nested Relationships

This struct is a nested type of Class DynamicCalibrationControl.

Nested Types

Struct Documentation

struct Commands

Namespace containing all command structures that may be used inside Command.

These structs represent individual commands that the Dynamic Calibration node can execute. Each command corresponds to a specific action or configuration update.

struct ApplyCalibration

Command to apply a new calibration to the device.

Public Functions

ApplyCalibration() = default

inline explicit ApplyCalibration(const CalibrationHandler &calibration, bool flash = false)

DEPTHAI_SERIALIZE(ApplyCalibration, calibration, flash)

Public Members

CalibrationHandler calibration: Calibration data to apply.

bool flash

struct Calibrate

Command to perform a full calibration run.

Public Functions

inline explicit Calibrate(bool force = false)

DEPTHAI_SERIALIZE(Calibrate, force)

Public Members

bool force = false: Force calibration even when unnecessary.

struct CalibrationQuality

Command to perform a calibration quality check.

Public Functions

inline explicit CalibrationQuality(bool force = false)

DEPTHAI_SERIALIZE(CalibrationQuality, force)

Public Members

bool force = false: Force check even if previous quality is valid.

struct ComputeCalibrationMetrics

Command to compute calibration metrics (e.g., calibrationConfidence and dataConfidence).

Evaluates the provided calibration data and computes relevant quality metrics.

Public Functions

inline explicit ComputeCalibrationMetrics(dai::CalibrationHandler &calibration)

DEPTHAI_SERIALIZE(ComputeCalibrationMetrics, calibration)

Public Members

dai::CalibrationHandler calibration

struct LoadImage

Command to load a single image for calibration.

Useful for manual step-by-step calibration sequences.

struct ResetData: Command to reset accumulated calibration and quality data.

struct SetPerformanceMode

Command to select the calibration performance mode.

Public Functions

inline SetPerformanceMode()

inline explicit SetPerformanceMode(PerformanceMode performanceMode)

DEPTHAI_SERIALIZE(SetPerformanceMode, performanceMode)

Public Members

PerformanceMode performanceMode: Desired performance mode.

struct StartCalibration

Command to start dynamic calibration with periodic operations.

Param loadImagePeriod:: How often image loading should occur (seconds)
Param calibrationPeriod:: How often calibration should run (seconds)

Public Functions

inline explicit StartCalibration(float loadImagePeriod = 0.5f, float calibrationPeriod = 5.0f)

DEPTHAI_SERIALIZE(StartCalibration, loadImagePeriod, calibrationPeriod)

Public Members

float loadImagePeriod = 0.5f: Seconds between image loads.

float calibrationPeriod = 5.0f: Seconds between calibration cycles.

struct StopCalibration: Command to stop a running dynamic calibration process.