Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Le format est basé sur [Keep a Changelog](https://keepachangelog.com/) et ce pr
## [Unreleased]
### Added
- Possibilité de définir un timeout via la variable d'environnement `ROK4_NETWORK_TIMEOUT` (valeur à fournir en seconde) pour les intéraction avec le stockage Swift ou S3
- Ajout de diagrammes pour comprendre l'usage des classes Image dans les différents outils
- Amélioration de la documentation Doxygen

### Changed
- Refonte du CHANGELOG au format [Keep a Changelog](https://keepachangelog.com/)
Expand Down
7 changes: 5 additions & 2 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -88,15 +88,18 @@ if(DOC_ENABLED)
set(DOXYGEN_OUTPUT_LANGUAGE french)
set(DOXYGEN_INPUT_ENCODING UTF-8)
set(DOXYGEN_IMAGE_PATH docs/images)
set(DOXYGEN_EXAMPLE_PATH docs/diagrams)
set(DOXYGEN_RECURSIVE YES)
set(DOXYGEN_PROJECT_NAME "Suite d'outils de génération ROK4")
set(DOXYGEN_GENERATE_HTML YES)
set(DOXYGEN_GENERATE_LATEX NO)
set(DOXYGEN_USE_MDFILE_AS_MAINPAGE docs/main.doxygen.md)
set(DOXYGEN_ALIASES mermaid{1}=\"@htmlonly <div class=\\\"mermaid\\\"> ^^ @endhtmlonly @htmlinclude \\\"\\1.mmd\\\" @htmlonly ^^ </div> @endhtmlonly\")
set(DOXYGEN_GENERATE_TREEVIEW YES)
set(DOXYGEN_DISABLE_INDEX NO)
set(DOXYGEN_DISABLE_INDEX YES)
set(DOXYGEN_HAVE_DOT NO)
set(DOXYGEN_FULL_SIDEBAR NO)
set(DOXYGEN_HTML_HEADER docs/doxygen/header.html)
set(DOXYGEN_HTML_FOOTER docs/doxygen/footer.html)
set(DOXYGEN_HTML_EXTRA_STYLESHEET ${CMAKE_CURRENT_SOURCE_DIR}/docs/doxygen/doxygen-awesome.css)
set(DOXYGEN_HTML_COLORSTYLE LIGHT)

Expand Down
21 changes: 21 additions & 0 deletions docs/diagrams/cache2work.mmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
config:
theme: neutral
flowchart:
htmlLabels: false
---

flowchart TB
img1@{ shape: proc, label: "Rok4Image"}
img1_notes@{ shape: braces, label: "image en entrée
en lecture"}
img1 -.- img1_notes

img2@{ shape: proc, label: "FileImage"}
img2_notes@{ shape: braces, label: "image en sortie
en écriture"}
img2 -.- img2_notes

img1 write@-- est lue ligne par ligne pour écrire --> img2
write@{ animate: true }

14 changes: 14 additions & 0 deletions docs/diagrams/checkWork.mmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
config:
theme: neutral
flowchart:
htmlLabels: false
---

flowchart TB
img1@{ shape: proc, label: "FileImage"}
img1_notes@{ shape: braces, label: "image en entrée
en lecture
si la création est en succès, la commande sort en succès"}
img1 -.- img1_notes

27 changes: 27 additions & 0 deletions docs/diagrams/composeNtiff.mmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
config:
theme: neutral
flowchart:
htmlLabels: false
---

flowchart TB
img1@{ shape: proc, label: "FileImage"}
img1_notes@{ shape: braces, label: "1 par image en entrée
en lecture"}
img1 -.- img1_notes

img2@{ shape: proc, label: "CompoundImage"}

img2 --> img1

img8@{ shape: proc, label: "FileImage"}
img8_notes@{ shape: braces, label: "image en sortie
en écriture"}
img8 -.- img8_notes

img2 write@-- est lue ligne par ligne pour écrire --> img8
write@{ animate: true }

classDef optionnal stroke-dasharray: 5 5;
class img5,img4 optionnal
39 changes: 39 additions & 0 deletions docs/diagrams/decimateNtiff.mmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
config:
theme: neutral
flowchart:
htmlLabels: false
---

flowchart TB
img1@{ shape: proc, label: "FileImage"}
img1_notes@{ shape: braces, label: "1 par image en entrée à décimer
en lecture
avec un éventuel convertisseur"}
img1 -.- img1_notes

img2@{ shape: proc, label: "FileImage"}
img2_notes@{ shape: braces, label: "1 pour l'image de fond
en lecture"}
img2 -.- img2_notes

img3@{ shape: proc, label: "ExtendedCompoundImage"}

img4@{ shape: proc, label: "DecimatedImage"}
img4 --> img3 --> img1

img5@{ shape: proc, label: "ExtendedCompoundImage"}

img5 --> img4
img5 -- si il y a un fond --> img2

img8@{ shape: proc, label: "FileImage"}
img8_notes@{ shape: braces, label: "image en sortie
en écriture"}
img8 -.- img8_notes

img5 write@-- est lue ligne par ligne pour écrire --> img8
write@{ animate: true }

classDef optionnal stroke-dasharray: 5 5;
class img2 optionnal
35 changes: 35 additions & 0 deletions docs/diagrams/manageNodata.mmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
config:
theme: neutral
flowchart:
htmlLabels: false
---

flowchart TB

subgraph tnm["TiffNodataManager"]
direction TB

img1@{ shape: proc, label: "FileImage"}
img1_notes@{ shape: braces, label: "1 seul image en entrée
en lecture"}
img1 -.- img1_notes

proc{{determine les pixels de nodata}}

img1 write1@-- est lue en entier --> proc
write1@{ animate: true }

img8@{ shape: proc, label: "FileImage"}
img8_notes@{ shape: braces, label: "image en sortie
en écriture"}
img8 -.- img8_notes

proc write2@-- donnée bufferisée écrite --> img8
write2@{ animate: true }

end


classDef optionnal stroke-dasharray: 5 5;
class img2 optionnal
45 changes: 45 additions & 0 deletions docs/diagrams/merge4tiff.mmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
config:
theme: neutral
flowchart:
htmlLabels: false
---

flowchart TB
img1@{ shape: proc, label: "FileImage"}
img1_notes@{ shape: braces, label: "1 par image de coin en entrée
jusqu'à 4
en lecture
avec un éventuel convertisseur"}
img1 -.- img1_notes

img2@{ shape: proc, label: "ExtendedCompoundImage"}
img3@{ shape: proc, label: "SubsampledImage"}

img3 --> img2 --> img1

img5@{ shape: proc, label: "MergeImage"}
img4@{ shape: proc, label: "FileImage"}
img4_notes@{ shape: braces, label: "1 seule pour l'image de fond
en lecture"}
img4 -.- img4_notes
img5 --> img4
img5 --> img3

input{Au choix}


img8@{ shape: proc, label: "FileImage"}
img8_notes@{ shape: braces, label: "image en sortie
en écriture"}
img8 -.- img8_notes

input write1@-- est lue ligne par ligne pour écrire --> img8
img3 write2@-- si pas de fond fourni --> input
img5 write3@-- si un fond est fourni --> input
write1@{ animate: true }
write2@{ animate: true }
write3@{ animate: true }

classDef optionnal stroke-dasharray: 5 5;
class img5,img4 optionnal
75 changes: 75 additions & 0 deletions docs/diagrams/mergeNtiff.mmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
config:
theme: neutral
flowchart:
htmlLabels: false
---

flowchart TB
img1@{ shape: proc, label: "FileImage"}
img1_notes@{ shape: braces, label: "1 par image en entrée
en lecture
avec un éventuel convertisseur"}
img1 -.- img1_notes

subgraph paquet[" "]
direction TB
img2@{ shape: proc, label: "MirrorImage"}
img2_notes@{ shape: braces, label: "4 par image en entrée
si reprojection ou réechantillonnage"}
img2 -.- img2_notes

img3@{ shape: proc, label: "ExtendedCompoundImage"}
img3_notes@{ shape: braces, label: "1 par paquet d'image en entrée compatibles entre elles"}
img3 -.- img3_notes

subgraph styled["Si un style est appliqué"]
direction TB
subgraph img4["Au choix"]
direction LR
img41@{ shape: proc, label: "EstompageImage"}
img42@{ shape: proc, label: "PenteImage"}
img43@{ shape: proc, label: "AspectImage"}
img41 ~~~ img42 ~~~ img43
end
img4_notes@{ shape: braces, label: "Si le style contient une section associée"}
img4 -.- img4_notes

img5@{ shape: proc, label: "PaletteImage"}
img5_notes@{ shape: braces, label: "Si le style contient une palette non vide"}
img5 -.- img5_notes
end

subgraph img6["Au choix"]
direction LR
img61@{ shape: proc, label: "None"}
img62@{ shape: proc, label: "ResampledImage"}
img63@{ shape: proc, label: "ReprojectedImage"}
end
end
paquet_notes@{ shape: braces, label: "Par paquet d'images en entrée compatibles entre elles"}
paquet -.- paquet_notes

img7@{ shape: proc, label: "ExtendedCompoundImage"}

img3 -- en fin des images sources --> img1
img3 -- en tête des images sources --> img2 --> img1
img5 --> img4
styled --> img3

img7 -- "Si le paquet d'images en entrée est en phase avec la sortie" --- img61
img7 -- "Si le paquet d'images en entrée a la même projection que la sortie déphasé" --> img62
img7 -- "Si le paquet d'images en entrée a une projection différente de la sortie" --> img63
img6 --> styled

img8@{ shape: proc, label: "FileImage"}
img8_notes@{ shape: braces, label: "image en sortie
en écriture"}
img8 -.- img8_notes

img7 write@-- est lue ligne par ligne pour écrire --> img8
write@{ animate: true }

classDef optionnal stroke-dasharray: 5 5;
class img2,img41,img42,img43,img5,styled optionnal
class img61 invisible
27 changes: 27 additions & 0 deletions docs/diagrams/overlayNtiff.mmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
config:
theme: neutral
flowchart:
htmlLabels: false
---

flowchart TB
img1@{ shape: proc, label: "FileImage"}
img1_notes@{ shape: braces, label: "1 par image en entrée
en lecture"}
img1 -.- img1_notes

img2@{ shape: proc, label: "MergeImage"}

img2 --> img1

img8@{ shape: proc, label: "FileImage"}
img8_notes@{ shape: braces, label: "image en sortie
en écriture"}
img8 -.- img8_notes

img2 write@-- est lue ligne par ligne pour écrire --> img8
write@{ animate: true }

classDef optionnal stroke-dasharray: 5 5;
class img2 optionnal
24 changes: 24 additions & 0 deletions docs/diagrams/pbf2cache.mmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
config:
theme: neutral
flowchart:
htmlLabels: false
---

flowchart TB

pbf[[ifstream]]
pbf_notes@{ shape: braces, label: "1 par tuile PBF en entrée
en lecture"}
pbf -.- pbf_notes

img8@{ shape: proc, label: "Rok4Image"}
img8_notes@{ shape: braces, label: "image en sortie
en écriture"}
img8 -.- img8_notes

pbf write@-- est lue en entier pour écrire tuile par tuile --> img8
write@{ animate: true }

classDef optionnal stroke-dasharray: 5 5;
class img2 optionnal
22 changes: 22 additions & 0 deletions docs/diagrams/work2cache.mmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
config:
theme: neutral
flowchart:
htmlLabels: false
---

flowchart TB
img1@{ shape: proc, label: "FileImage"}
img1_notes@{ shape: braces, label: "image en entrée
en lecture
avec un éventuel convertisseur"}
img1 -.- img1_notes

img2@{ shape: proc, label: "Rok4Image"}
img2_notes@{ shape: braces, label: "image en sortie
en écriture"}
img2 -.- img2_notes

img1 write@-- est lue ligne par ligne pour écrire --> img2
write@{ animate: true }

2 changes: 2 additions & 0 deletions docs/doxygen/doxygen-awesome.css
Original file line number Diff line number Diff line change
Expand Up @@ -1985,6 +1985,8 @@ hr {
.contents img, .contents .center, .contents center, .contents div.image object {
max-width: 100%;
overflow: auto;
margin-top: 20px;
margin-bottom: 20px;
}

@media screen and (max-width: 767px) {
Expand Down
12 changes: 12 additions & 0 deletions docs/doxygen/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<script>
mermaid.initialize({
startOnLoad: true,
theme: 'base',
themeVariables: {
primaryColor: '#f4f4ff',
secondaryColor: 'rgba(244,244,255,0.9)',
tertiaryColor: '#F9FAFC',
},
});
</script>
</body>
Loading