update docs

README.md

@@ -12,7 +12,7 @@ Die im Rahmen des Projekts erstellte Anwendung erlaubt es, Bilder von Sensoren,
 - Abmessungen der Elektroden eines jeden Sensors auf Basis von Kalibrierungswerten (in der Form Pixel/Maßeinheit)
 - Erkennung von Anomalien und damit möglichen Defekten eines Sensors
 
-Ein zu analysierendes Bild enthält zwei Sensoren mit ihrer jeweils definierten Anzahl an Elektroden. Ein solches Bild kann über die bereitgestellte CLI analysiert werden. Ist die Analyse erfolgreich, wird eine nach dem Bild benannte CSV-Datei im selben Verzeichnis, in welchem sich das Bild befindet, abgelegt. Diese CSV-Datei enthält die ermittelten Werte für die Abmessungen der Elektroden sowie deren Flächeninhalte. Jeder Sensor besitzt drei Elektroden. Demzufolge ergeben sich 2x3x3 = 18 Kennwerte.
+Ein zu analysierendes Bild enthält zwei Sensoren mit ihrer jeweils definierten Anzahl an Elektroden. Ein solches Bild kann über die bereitgestellte Command-Line-Interface (CLI) analysiert werden. Ist die Analyse erfolgreich, wird eine nach dem Bild benannte CSV-Datei im selben Verzeichnis, in welchem sich das Bild befindet, abgelegt. Diese CSV-Datei enthält die ermittelten Werte für die Abmessungen der Elektroden sowie deren Flächeninhalte. Jeder Sensor besitzt drei Elektroden. Demzufolge ergeben sich 2x3x3 = 18 Kennwerte.
 
 Darüber hinaus wird ermittelt, ob die Sensoren jeweils Anomalien aufweisen. Die CSV-Datei enthält zusätzlich zu den 18 Maß-Kennwerten zwei Einträge mit jeweils ``0`` oder ``1``, ein Ergebnis der Anomaliedetektion für jeden Sensor. Bei einem Ergebnis von ``0`` wurde keine Anomalie festgestellt, bei ``1`` hingegen schon.
 
@@ -22,11 +22,11 @@ Im Zuge der Analyse wird eine Heatmap für das Bild erzeugt, welche Rückschlüs
 
 Die Anwendung ist vollständig in Python implementiert. Zur Nutzung wird eine vollständige Python-Standalone-Umgebung mit allen erforderlichen Abhängigkeiten bereitgestellt. Das Anwendungsverzeichnis wird als gepacktes ZIP-Archiv bereitgestellt. Die entpackte Größe liegt bei etwa 1,3 GB.
 
-Die Nutzung erfolgt über ein Command-Line-Interface (CLI), das über ein Python-Skript abgerufen werden kann. Dieses liegt im Wurzelverzeichnis der Python-Umgebung als ``cli.py`` ab.
+Die Nutzung erfolgt über ein CLI, das über ein Python-Skript abgerufen werden kann. Dieses liegt im Wurzelverzeichnis der Python-Umgebung als ``cli.py`` ab.
 
-## Command-Line-Interface (CLI)
+## Command-Line-Interface
 
-Die Funktionalität wird über ein CLI nutzbar gemacht. Hierfür liegt in der bereitgestellten Distribution im Ordner "python" ein Python-Skript ab. Dieses muss durch den ebenfalls in diesem Ordner befindlichen Interpreter "python.exe" aufgerufen werden. Erfolgt der Aufruf mit einem anderen Interpreter, werden die installierten Abhängigkeiten nicht gefunden und das Programm funktioniert nicht. Ausgehend vom Ordner, in dem das entpackte Applikationsverzeichnis abliegt, kann der Aufruf folgendermaßen stattfinden:
+Die Funktionalität wird über ein CLI nutzbar gemacht. Hierfür liegt in der bereitgestellten Distribution im Ordner "python" ein Python-Skript ab. Dieses muss durch den ebenfalls in diesem Ordner befindlichen Interpreter "python.exe" aufgerufen werden. Erfolgt der Aufruf mit einem anderen Interpreter, werden die installierten Abhängigkeiten nicht gefunden und das Programm funktioniert nicht. Ausgehend vom Ordner, in dem das entpackte Applikationsverzeichnis abliegt, kann die Applikation folgendermaßen aufgerufen werden:
 
 ```pwsh
 cd ekf-sensor-anomalies-deployment\python

docs/header.tex

@@ -0,0 +1,13 @@
+\usepackage{listings}
+\usepackage[scaled=0.9]{DejaVuSansMono}  % or another monospaced font
+\renewcommand{\ttdefault}{pcr}           % 'pcr' = Courier
+\lstset{
+  basicstyle=\ttfamily\small,
+  columns=fullflexible,
+  keepspaces=true,
+  breaklines=true,
+  breakatwhitespace=true,
+  showstringspaces=false,
+  frame=none,
+  backgroundcolor=\color{white}
+}

docs/manual.md

@@ -9,7 +9,7 @@ Die im Rahmen des Projekts erstellte Anwendung erlaubt es, Bilder von Sensoren,
 - Abmessungen der Elektroden eines jeden Sensors auf Basis von Kalibrierungswerten (in der Form Pixel/Maßeinheit)
 - Erkennung von Anomalien und damit möglichen Defekten eines Sensors
 
-Ein zu analysierendes Bild enthält zwei Sensoren mit ihrer jeweils definierten Anzahl an Elektroden. Ein solches Bild kann über die bereitgestellte CLI analysiert werden. Ist die Analyse erfolgreich, wird eine nach dem Bild benannte CSV-Datei im selben Verzeichnis, in welchem sich das Bild befindet, abgelegt. Diese CSV-Datei enthält die ermittelten Werte für die Abmessungen der Elektroden sowie deren Flächeninhalte. Jeder Sensor besitzt drei Elektroden. Demzufolge ergeben sich 2x3x3 = 18 Kennwerte.
+Ein zu analysierendes Bild enthält zwei Sensoren mit ihrer jeweils definierten Anzahl an Elektroden. Ein solches Bild kann über die bereitgestellte Command-Line-Interface (CLI) analysiert werden. Ist die Analyse erfolgreich, wird eine nach dem Bild benannte CSV-Datei im selben Verzeichnis, in welchem sich das Bild befindet, abgelegt. Diese CSV-Datei enthält die ermittelten Werte für die Abmessungen der Elektroden sowie deren Flächeninhalte. Jeder Sensor besitzt drei Elektroden. Demzufolge ergeben sich 2x3x3 = 18 Kennwerte.
 
 Darüber hinaus wird ermittelt, ob die Sensoren jeweils Anomalien aufweisen. Die CSV-Datei enthält zusätzlich zu den 18 Maß-Kennwerten zwei Einträge mit jeweils ``0`` oder ``1``, ein Ergebnis der Anomaliedetektion für jeden Sensor. Bei einem Ergebnis von ``0`` wurde keine Anomalie festgestellt, bei ``1`` hingegen schon.
 
@@ -19,11 +19,11 @@ Im Zuge der Analyse wird eine Heatmap für das Bild erzeugt, welche Rückschlüs
 
 Die Anwendung ist vollständig in Python implementiert. Zur Nutzung wird eine vollständige Python-Standalone-Umgebung mit allen erforderlichen Abhängigkeiten bereitgestellt. Das Anwendungsverzeichnis wird als gepacktes ZIP-Archiv bereitgestellt. Die entpackte Größe liegt bei etwa 1,3 GB.
 
-Die Nutzung erfolgt über ein Command-Line-Interface (CLI), das über ein Python-Skript abgerufen werden kann. Dieses liegt im Wurzelverzeichnis der Python-Umgebung als ``cli.py`` ab.
+Die Nutzung erfolgt über ein CLI, das über ein Python-Skript abgerufen werden kann. Dieses liegt im Wurzelverzeichnis der Python-Umgebung als ``cli.py`` ab.
 
-## Command-Line-Interface (CLI)
+## Command-Line-Interface
 
-Die Funktionalität wird über ein CLI nutzbar gemacht. Hierfür liegt in der bereitgestellten Distribution im Ordner "python" ein Python-Skript ab. Dieses muss durch den ebenfalls in diesem Ordner befindlichen Interpreter "python.exe" aufgerufen werden. Erfolgt der Aufruf mit einem anderen Interpreter, werden die installierten Abhängigkeiten nicht gefunden und das Programm funktioniert nicht. Ausgehend vom Ordner, in dem das entpackte Applikationsverzeichnis abliegt, kann der Aufruf folgendermaßen stattfinden:
+Die Funktionalität wird über ein CLI nutzbar gemacht. Hierfür liegt in der bereitgestellten Distribution im Ordner "python" ein Python-Skript ab. Dieses muss durch den ebenfalls in diesem Ordner befindlichen Interpreter "python.exe" aufgerufen werden. Erfolgt der Aufruf mit einem anderen Interpreter, werden die installierten Abhängigkeiten nicht gefunden und das Programm funktioniert nicht. Ausgehend vom Ordner, in dem das entpackte Applikationsverzeichnis abliegt, kann die Applikation folgendermaßen aufgerufen werden:
 
 ```pwsh
 cd ekf-sensor-anomalies-deployment\python
@@ -41,7 +41,9 @@ positional arguments:
   img_path       file path to the image which is to be analysed
   calib_value_x  calibration value in pixels per mcm for x axis, type: float
   calib_value_y  calibration value in pixels per mcm for y axis, type: float
-
+```
+\newpage
+```
 options:
   -h, --help     show this help message and exit
 ```

scripts/cvt_manual.ps1

@@ -1,2 +1,2 @@
 # covert the manual Markdown file to PDF
-pandoc .\docs\manual.md -o .\docs\manual.pdf -V geometry:"a4paper, margin=2.5cm"
+pandoc .\docs\manual.md -o .\docs\manual.pdf -V geometry:"a4paper, margin=2.5cm" -V header-includes="\usepackage[none]{hyphenat}" # -V header-includes="\lstset{escapeinside={(*@}{@*)}}" --include-in-header=.\docs\header.tex # --syntax-highlighting=idiomatic