# desnault/codac-coverage-toolbox architecture

> Architecture diagram of the GitHub repository desnault/codac-coverage-toolbox, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/desnault/codac-coverage-toolbox
- Repository: https://github.com/desnault/codac-coverage-toolbox

## Overview

CCT is a C++ toolbox for guaranteed sensor-coverage analysis along a known robot trajectory. The user supplies a trajectory and sensor parameters, chooses a perception model, and uses a projection wrapper to compute covered area at a requested time interval and precision; the result is a classified spatial paving, including uncertain cells when applicable. The main model families cover disk, distance, polar, and pie-shaped sensors, with binary and three-valued perception. The README documents projection and paving; relationships between unsampled projection implementations and local models are shown as documented, not as inspected call chains.

Main entry points: [`separators/SepDynPie.cpp`](https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynPie.cpp) (Pie separator), [`separators/SepDynDisk.cpp`](https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynDisk.cpp) (Disk separator), [`separators/SepDynDist.cpp`](https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynDist.cpp) (Distance separator), [`separators/SepDynPolar.cpp`](https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynPolar.cpp) (Polar separator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_contractors["Dynamic contractors"]
  node_dist_ctc["Distance contractor<br/>[CtcDynDist.cpp]"]
  node_polar_ctc["Polar contractor<br/>[CtcDynPolar.cpp]"]
end

subgraph group_local["Local perception"]
  node_disk["Disk separator<br/>[SepDynDisk.cpp]"]
  node_dist["Distance separator<br/>[SepDynDist.cpp]"]
  node_polar["Polar separator<br/>[SepDynPolar.cpp]"]
  node_pie["Pie separator<br/>[SepDynPie.cpp]"]
end

subgraph group_projection["Coverage projection"]
  node_disk_proj["Disk coverage<br/>[SepDynDiskProj.cpp]"]
  node_dist_proj["Distance coverage<br/>[SepDynDistProj.cpp]"]
  node_polar_proj["Polar coverage"]
  node_pie_proj["Pie coverage<br/>[SepDynPieProj.cpp]"]
end

subgraph group_runtime["Analysis inputs and results"]
  node_trajectory["Known trajectory"]
  node_sensor["Sensor parameters"]
  node_paving["Classified paving"]
end

node_user(("Analyst"))

node_user -->|"provides"| node_trajectory
node_user -->|"configures"| node_sensor
node_trajectory -->|"models along"| node_disk
node_trajectory -->|"models along"| node_dist
node_trajectory -->|"models along"| node_polar
node_trajectory -->|"models along"| node_pie
node_sensor -->|"defines perception"| node_disk
node_sensor -->|"defines perception"| node_dist
node_sensor -->|"defines perception"| node_polar
node_sensor -->|"defines perception"| node_pie
node_disk -->|"uses"| node_dist_ctc
node_dist -->|"creates"| node_dist_ctc
node_polar -->|"uses"| node_polar_ctc
node_pie -->|"creates"| node_polar_ctc
node_pie -->|"creates"| node_dist_ctc
node_disk -->|"projects over time"| node_disk_proj
node_dist -->|"projects over time"| node_dist_proj
node_polar -->|"projects over time"| node_polar_proj
node_pie -->|"projects over time"| node_pie_proj
node_disk_proj -->|"classifies area"| node_paving
node_dist_proj -->|"classifies area"| node_paving
node_polar_proj -->|"classifies area"| node_paving
node_pie_proj -->|"classifies area"| node_paving

click node_dist_ctc "https://github.com/desnault/codac-coverage-toolbox/blob/main/contractors/CtcDynDist.cpp"
click node_polar_ctc "https://github.com/desnault/codac-coverage-toolbox/blob/main/contractors/CtcDynPolar.cpp"
click node_disk "https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynDisk.cpp"
click node_dist "https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynDist.cpp"
click node_polar "https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynPolar.cpp"
click node_pie "https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynPie.cpp"
click node_disk_proj "https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynDiskProj.cpp"
click node_dist_proj "https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynDistProj.cpp"
click node_polar_proj "https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynPolarProj.cpp"
click node_pie_proj "https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynPieProj.cpp"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_dist_ctc,node_polar_ctc toneBlue
class node_disk,node_dist,node_polar,node_pie toneAmber
class node_disk_proj,node_dist_proj,node_polar_proj,node_pie_proj toneMint
class node_trajectory,node_sensor,node_paving toneRose
class node_user toneIndigo
```

## Components

### Dynamic contractors

- [Distance contractor](https://github.com/desnault/codac-coverage-toolbox/blob/main/contractors/CtcDynDist.cpp): `contractors/CtcDynDist.cpp`
- [Polar contractor](https://github.com/desnault/codac-coverage-toolbox/blob/main/contractors/CtcDynPolar.cpp): `contractors/CtcDynPolar.cpp`

### Local perception

- [Disk separator](https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynDisk.cpp): `separators/SepDynDisk.cpp`
- [Distance separator](https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynDist.cpp): `separators/SepDynDist.cpp`
- [Polar separator](https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynPolar.cpp): `separators/SepDynPolar.cpp`
- [Pie separator](https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynPie.cpp): `separators/SepDynPie.cpp`

### Coverage projection

- [Disk coverage](https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynDiskProj.cpp): `separators/SepDynDiskProj.cpp`
- [Distance coverage](https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynDistProj.cpp): `separators/SepDynDistProj.cpp`
- [Polar coverage](https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynPolarProj.cpp): `separators/SepDynPolarProj.cpp`
- [Pie coverage](https://github.com/desnault/codac-coverage-toolbox/blob/main/separators/SepDynPieProj.cpp): `separators/SepDynPieProj.cpp`

### Analysis inputs and results

- **Known trajectory**
- **Sensor parameters**
- **Classified paving**

### Other components

- **Analyst**

## Connections

- Analyst → Known trajectory: provides (evidence: `README.md`)
- Analyst → Sensor parameters: configures (evidence: `README.md`)
- Known trajectory → Disk separator: models along (evidence: `README.md`)
- Known trajectory → Distance separator: models along (evidence: `README.md`)
- Known trajectory → Polar separator: models along (evidence: `README.md`)
- Known trajectory → Pie separator: models along (evidence: `README.md`)
- Sensor parameters → Disk separator: defines perception (evidence: `README.md`)
- Sensor parameters → Distance separator: defines perception (evidence: `README.md`)
- Sensor parameters → Polar separator: defines perception (evidence: `README.md`)
- Sensor parameters → Pie separator: defines perception (evidence: `README.md`)
- Disk separator → Distance contractor: uses
- Distance separator → Distance contractor: creates (evidence: `separators/SepDynDist.cpp`)
- Polar separator → Polar contractor: uses
- Pie separator → Polar contractor: creates (evidence: `separators/SepDynPie.cpp`)
- Pie separator → Distance contractor: creates (evidence: `separators/SepDynPie.cpp`)
- Disk separator → Disk coverage: projects over time (evidence: `README.md`)
- Distance separator → Distance coverage: projects over time (evidence: `README.md`)
- Polar separator → Polar coverage: projects over time (evidence: `README.md`)
- Pie separator → Pie coverage: projects over time (evidence: `README.md`)
- Disk coverage → Classified paving: classifies area (evidence: `README.md`)
- Distance coverage → Classified paving: classifies area (evidence: `README.md`)
- Polar coverage → Classified paving: classifies area (evidence: `README.md`)
- Pie coverage → Classified paving: classifies area (evidence: `README.md`)
