Skip to content

Commit b347d08

Browse files
authored
Update README in C++
1 parent 3c5b2ba commit b347d08

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

examples/cpp/DynamicCalibration/README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ This folder contains two minimal, end-to-end **C++** examples that use **`dai::n
99
## What the node does
1010

1111
`dai::node::DynamicCalibration` consumes **raw, unrectified** left/right mono frames and:
12-
- Streams **coverage feedback** (how well the calibration pattern is seen across the image).
12+
- Streams **coverage feedback**.
1313
- Produces either:
1414
- a **new calibration** (`CalibrationHandler`) you can apply on the device, or
15-
- a **quality report** comparing *current* vs *achievable* calibration.
15+
- a **quality report** comparing *current* vs *achieved* calibration.
1616

1717
### Outputs & metrics (C++ message types)
1818

@@ -44,28 +44,28 @@ This folder contains two minimal, end-to-end **C++** examples that use **`dai::n
4444
- `DynamicCalibration.left/right`
4545
- `StereoDepth.left/right` (for live disparity view)
4646
2. Start the pipeline, give AE a moment to settle.
47-
3. **Start calibration** by sending `DynamicCalibrationControl(StartCalibrationCommand{})`.
47+
3. **Start calibration** by sending `DynamicCalibrationControl::Command::StartCalibration{})`.
4848
4. In the loop:
4949
- Show `left`, `right`, and `disparity`.
5050
- Poll `coverageOutput` for progress.
5151
- Poll `calibrationOutput` for a result.
5252
5. When a result arrives:
53-
- **Apply** it by sending `ApplyCalibrationCommand(newCalibration)` on the control queue.
53+
- **Apply** it by sending `DynamicCalibrationControl::Command::ApplyCalibration(newCalibration)` on the control queue.
5454
- Print quality deltas.
5555

5656
---
5757

5858
## 2) Calibration **quality check** (no applying)
5959

60-
**File idea:** `quality_dynamic.cpp`
60+
**File idea:** `calib_quality_dynamic.cpp`
6161

6262
**Flow:**
6363
1. Same camera / StereoDepth / DynamicCalibration setup as above.
6464
2. In the loop:
65-
- Send **coverage** request (`LoadImageCommand{}`) and read `coverageOutput`.
66-
- Send **quality** request (`CalibrationQualityCommand{}`) and read `qualityOutput`.
65+
- Send **coverage** request (`DynamicCalibrationControl::Command::LoadImage{}`) and read `coverageOutput`.
66+
- Send **quality** request (`DynamicCalibrationControl::Command::CalibrationQuality{}`) and read `qualityOutput`.
6767
3. If `qualityData` is present, print rotation/Sampson/depth-error metrics.
68-
4. Optionally reset internal sample store (`ResetDataCommand{}`).
68+
4. Optionally reset internal sample store (`DynamicCalibrationControl::Command::ResetData{}`).
6969

7070
---
7171

@@ -101,8 +101,8 @@ find_package(depthai CONFIG REQUIRED) # provides depthai::core
101101
add_executable(calibrate_dynamic calibrate_dynamic.cpp)
102102
target_link_libraries(calibrate_dynamic PRIVATE depthai::core)
103103
104-
add_executable(quality_dynamic quality_dynamic.cpp)
105-
target_link_libraries(quality_dynamic PRIVATE depthai::core)
104+
add_executable(calib_quality_dynamic calib_quality_dynamic.cpp)
105+
target_link_libraries(calib_quality_dynamic PRIVATE depthai::core)
106106
```
107107

108108
Build:
@@ -122,19 +122,19 @@ Run:
122122

123123
## Commands overview (C++)
124124

125-
- `DynamicCalibrationControl::StartCalibrationCommand{}`
125+
- `DynamicCalibrationControl::Command::StartCalibration{}`
126126
Begins dynamic calibration collection/solve. Combine with performance modes if available.
127127

128-
- `DynamicCalibrationControl::ApplyCalibrationCommand{CalibrationHandler}`
128+
- `DynamicCalibrationControl::Command::ApplyCalibration{CalibrationHandler}`
129129
Applies the provided calibration on-device (affects downstream nodes in-session).
130130

131-
- `DynamicCalibrationControl::LoadImageCommand{}`
131+
- `DDynamicCalibrationControl::Command::LoadImage{}`
132132
Triggers coverage computation for the latest frames.
133133

134-
- `DynamicCalibrationControl::CalibrationQualityCommand{bool force=false}`
134+
- `DynamicCalibrationControl::Command::CalibrationQuality{bool force=false}`
135135
Produces a `CalibrationQuality` message with `qualityData` if estimation is possible.
136136

137-
- `DynamicCalibrationControl::ResetDataCommand{}`
137+
- `DynamicCalibrationControl::Command::ResetData{}`
138138
Clears accumulated samples/coverage state.
139139

140140
---

0 commit comments

Comments
 (0)