From 312c078c01d0d749aa17ae0b8a1233a4241a8edf Mon Sep 17 00:00:00 2001 From: foefl Date: Tue, 6 Jan 2026 08:48:37 +0100 Subject: [PATCH] update docs for anomaly threshold, related to #20 --- README.md | 4 ++++ docs/manual.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/README.md b/README.md index f13d7a5..34c0090 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,8 @@ positional arguments: options: -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: @@ -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. +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 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``. diff --git a/docs/manual.md b/docs/manual.md index d4828df..53e4ba1 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -46,6 +46,8 @@ positional arguments: ``` options: -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: @@ -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. +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 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``.