EKF-Diagnostic/sensor-anomalies
1
0
Fork 0
generated from dopt-python/py311
Code Issues Pull Requests Actions Packages Projects 1 Releases 8 Wiki Activity

update docs for anomaly threshold, related to #20

Browse Source
This commit is contained in:
Florian Förster 2026-01-06 08:48:37 +01:00
parent f25dbeebd8
commit 312c078c01
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -47,6 +47,8 @@ positional arguments:
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-t ANOMALY_THRESHOLD, --anomaly_threshold ANOMALY_THRESHOLD
optional anomaly threshold to set, default: 0.14, type: float
``` ```
Das CLI besteht entsprechend der obigen Beschreibung aus einer Funktion. Diese benötigt die folgenden Parameter: Das CLI besteht entsprechend der obigen Beschreibung aus einer Funktion. Diese benötigt die folgenden Parameter:
@ -57,6 +59,8 @@ Das CLI besteht entsprechend der obigen Beschreibung aus einer Funktion. Diese b
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. 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.
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.
### Fehlermeldungen ### Fehlermeldungen
Die Anwendung führt zahlreiche Verarbeitungsschritte durch. Treten hierbei Fehler auf, werden diese mit ihrer Bezeichnung und einer Fehlerbeschreibung ausgegeben. Dies erlaubt Rückschlüsse, an welcher Stelle der Verarbeitungs-Pipeline Fehler aufgetreten sind und aus welchen Gründen das geschah. Die Fehlerausgabe erfolgt über ``STDERR``. Die Anwendung führt zahlreiche Verarbeitungsschritte durch. Treten hierbei Fehler auf, werden diese mit ihrer Bezeichnung und einer Fehlerbeschreibung ausgegeben. Dies erlaubt Rückschlüsse, an welcher Stelle der Verarbeitungs-Pipeline Fehler aufgetreten sind und aus welchen Gründen das geschah. Die Fehlerausgabe erfolgt über ``STDERR``.

4
docs/manual.md
View File

@ -46,6 +46,8 @@ positional arguments:
``` ```
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
-t ANOMALY_THRESHOLD, --anomaly_threshold ANOMALY_THRESHOLD
optional anomaly threshold to set, default: 0.14, type: float
``` ```
Das CLI besteht entsprechend der obigen Beschreibung aus einer Funktion. Diese benötigt die folgenden Parameter: Das CLI besteht entsprechend der obigen Beschreibung aus einer Funktion. Diese benötigt die folgenden Parameter:
@ -56,6 +58,8 @@ Das CLI besteht entsprechend der obigen Beschreibung aus einer Funktion. Diese b
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. 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.
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.
### Fehlermeldungen ### Fehlermeldungen
Die Anwendung führt zahlreiche Verarbeitungsschritte durch. Treten hierbei Fehler auf, werden diese mit ihrer Bezeichnung und einer Fehlerbeschreibung ausgegeben. Dies erlaubt Rückschlüsse, an welcher Stelle der Verarbeitungs-Pipeline Fehler aufgetreten sind und aus welchen Gründen das geschah. Die Fehlerausgabe erfolgt über ``STDERR``. Die Anwendung führt zahlreiche Verarbeitungsschritte durch. Treten hierbei Fehler auf, werden diese mit ihrer Bezeichnung und einer Fehlerbeschreibung ausgegeben. Dies erlaubt Rückschlüsse, an welcher Stelle der Verarbeitungs-Pipeline Fehler aufgetreten sind und aus welchen Gründen das geschah. Die Fehlerausgabe erfolgt über ``STDERR``.