generated from dopt-python/py311
update README and manual, related to #26
This commit is contained in:
parent
e8c6845e39
commit
ed9c7f2c67
12
README.md
12
README.md
@ -14,7 +14,9 @@ Die im Rahmen des Projekts erstellte Anwendung erlaubt es, Bilder von Sensoren,
|
||||
|
||||
Ein zu analysierendes Bild enthält zwei Sensoren mit ihrer jeweils definierten Anzahl an Elektroden. Ein solches Bild kann über das 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.
|
||||
Darüber hinaus wird ermittelt, ob die Sensoren jeweils Anomalien aufweisen. Die CSV-Datei enthält zusätzlich zu den 18 Maß-Kennwerten vier Einträge, für jeden Sensor jeweils der ermittelte Anomalie-Score und die Entscheidung, ob eine Anomalie vorliegt (``1``) oder nicht (``0``).
|
||||
|
||||
Die Reihenfolge aller Werte in der CSV-Datei orientiert sich an der Spezifikation, die durch EKF-Diagnostics bereitgestellt wurde.
|
||||
|
||||
Im Zuge der Analyse wird eine Heatmap für das Bild erzeugt, welche Rückschlüsse auf Anomaliebereiche erlaubt. Die Datei wird analog der CSV-Datei im entsprechenden Ordner der ursprünglichen Bilddatei mit einem Suffix abgelegt.
|
||||
|
||||
@ -29,14 +31,14 @@ Die Nutzung erfolgt über ein CLI, das über ein Python-Skript abgerufen werden
|
||||
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
|
||||
cd dopt_ekf_sensor-anomalies_v{AKTUELLE-VERSION}\python
|
||||
.\python.exe .\cli.py --help
|
||||
```
|
||||
|
||||
Dieser Befehl gibt den folgenden Hilfetext aus:
|
||||
|
||||
```
|
||||
usage: cli.py [-h] img_path calib_value_x calib_value_y
|
||||
usage: cli.py [-h] [-t ANOMALY_THRESHOLD] img_path calib_value_x calib_value_y
|
||||
|
||||
simple CLI tool to analyse single sensor images for anomalies
|
||||
|
||||
@ -57,9 +59,9 @@ Das CLI besteht entsprechend der obigen Beschreibung aus einer Funktion. Diese b
|
||||
- ``calib_value_x``: den Kalibrierwert in x-Richtung zur Ermittlung der Abmessungen, angegeben in Pixel/µm als Gleitkommazahl
|
||||
- ``calib_value_y``: den Kalibrierwert in y-Richtung zur Ermittlung der Abmessungen, angegeben in Pixel/µm als Gleitkommazahl
|
||||
|
||||
Alle Parameter sind obligatorisch und müssen bereitgestellt werden. Die Analyse ist stets für nur ein Bild zur selben Zeit durchführbar. Eine Übergabe mehrerer Dateien ist nicht möglich. Ausgaben, die nicht auf Fehler zurückzuführen sind, werden standardmäßig über ``STDOUT`` ausgegeben.
|
||||
Diese Parameter sind obligatorisch und müssen bereitgestellt werden. Die Analyse ist stets für nur ein Bild zur selben Zeit durchführbar. Eine Übergabe mehrerer Dateien ist nicht möglich. Ausgaben, die nicht auf Fehler zurückzuführen sind, werden standardmäßig über ``STDOUT`` ausgegeben.
|
||||
|
||||
Optional kann für die Pipeline auch der Schwellwert für die Anomaliedetektion definiert werden. Dieser Wert bestimmt, ab wann eine Unregelmäßigkeit in den Bildern tatsächlich als Anomlie gewertet wird, und muss als Gleitkommazahl bereitgestellt werden. Der Standardwert liegt bei 0,14.
|
||||
Optional kann für die Pipeline auch der Schwellwert für die Anomaliedetektion definiert werden. Dieser Wert bestimmt, ab wann eine Unregelmäßigkeit in den Bildern tatsächlich als Anomlie gewertet wird, und muss als Gleitkommazahl bereitgestellt werden. Die Übergabe erfolgt über den Parameter ``-t`` bzw. ``--anomaly_threshold``. Der Standardwert liegt bei 0,14.
|
||||
|
||||
### Fehlermeldungen
|
||||
|
||||
|
||||
@ -11,7 +11,9 @@ Die im Rahmen des Projekts erstellte Anwendung erlaubt es, Bilder von Sensoren,
|
||||
|
||||
Ein zu analysierendes Bild enthält zwei Sensoren mit ihrer jeweils definierten Anzahl an Elektroden. Ein solches Bild kann über das 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.
|
||||
Darüber hinaus wird ermittelt, ob die Sensoren jeweils Anomalien aufweisen. Die CSV-Datei enthält zusätzlich zu den 18 Maß-Kennwerten vier Einträge, für jeden Sensor jeweils der ermittelte Anomalie-Score und die Entscheidung, ob eine Anomalie vorliegt (``1``) oder nicht (``0``).
|
||||
|
||||
Die Reihenfolge aller Werte in der CSV-Datei orientiert sich an der Spezifikation, die durch EKF-Diagnostics bereitgestellt wurde.
|
||||
|
||||
Im Zuge der Analyse wird eine Heatmap für das Bild erzeugt, welche Rückschlüsse auf Anomaliebereiche erlaubt. Die Datei wird analog der CSV-Datei im entsprechenden Ordner der ursprünglichen Bilddatei mit einem Suffix abgelegt.
|
||||
|
||||
@ -26,14 +28,14 @@ Die Nutzung erfolgt über ein CLI, das über ein Python-Skript abgerufen werden
|
||||
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
|
||||
cd dopt_ekf_sensor-anomalies_v{AKTUELLE-VERSION}\python
|
||||
.\python.exe .\cli.py --help
|
||||
```
|
||||
|
||||
Dieser Befehl gibt den folgenden Hilfetext aus:
|
||||
|
||||
```
|
||||
usage: cli.py [-h] img_path calib_value_x calib_value_y
|
||||
usage: cli.py [-h] [-t ANOMALY_THRESHOLD] img_path calib_value_x calib_value_y
|
||||
|
||||
simple CLI tool to analyse single sensor images for anomalies
|
||||
|
||||
@ -41,9 +43,7 @@ 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
|
||||
-t ANOMALY_THRESHOLD, --anomaly_threshold ANOMALY_THRESHOLD
|
||||
@ -56,9 +56,9 @@ Das CLI besteht entsprechend der obigen Beschreibung aus einer Funktion. Diese b
|
||||
- ``calib_value_x``: den Kalibrierwert in x-Richtung zur Ermittlung der Abmessungen, angegeben in Pixel/µm als Gleitkommazahl
|
||||
- ``calib_value_y``: den Kalibrierwert in y-Richtung zur Ermittlung der Abmessungen, angegeben in Pixel/µm als Gleitkommazahl
|
||||
|
||||
Alle Parameter sind obligatorisch und müssen bereitgestellt werden. Die Analyse ist stets für nur ein Bild zur selben Zeit durchführbar. Eine Übergabe mehrerer Dateien ist nicht möglich. Ausgaben, die nicht auf Fehler zurückzuführen sind, werden standardmäßig über ``STDOUT`` ausgegeben.
|
||||
Diese Parameter sind obligatorisch und müssen bereitgestellt werden. Die Analyse ist stets für nur ein Bild zur selben Zeit durchführbar. Eine Übergabe mehrerer Dateien ist nicht möglich. Ausgaben, die nicht auf Fehler zurückzuführen sind, werden standardmäßig über ``STDOUT`` ausgegeben.
|
||||
|
||||
Optional kann für die Pipeline auch der Schwellwert für die Anomaliedetektion definiert werden. Dieser Wert bestimmt, ab wann eine Unregelmäßigkeit in den Bildern tatsächlich als Anomlie gewertet wird, und muss als Gleitkommazahl bereitgestellt werden. Der Standardwert liegt bei 0,14.
|
||||
Optional kann für die Pipeline auch der Schwellwert für die Anomaliedetektion definiert werden. Dieser Wert bestimmt, ab wann eine Unregelmäßigkeit in den Bildern tatsächlich als Anomlie gewertet wird, und muss als Gleitkommazahl bereitgestellt werden. Die Übergabe erfolgt über den Parameter ``-t`` bzw. ``--anomaly_threshold``. Der Standardwert liegt bei 0,14.
|
||||
|
||||
### Fehlermeldungen
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user