add hint for value range of anomaly threshold, closes #28

README.md

@@ -50,7 +50,7 @@ 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
+                        optional anomaly threshold to set, must be between 0 < value < 1, default: 0.14, type: float
 ```
 
 Das CLI besteht entsprechend der obigen Beschreibung aus einer Funktion. Diese benötigt die folgenden Parameter:
@@ -61,7 +61,7 @@ Das CLI besteht entsprechend der obigen Beschreibung aus einer Funktion. Diese b
 
 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. Die Übergabe erfolgt über den Parameter ``-t`` bzw. ``--anomaly_threshold``. 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. Der Wert muss im Intervall ``(0, 1)`` liegen. Bei ``0`` würde nie und bei ``1`` immer eine Anomlie detektiert werden. Die Übergabe erfolgt über den Parameter ``-t`` bzw. ``--anomaly_threshold``. Der Standardwert liegt bei 0,14.
 
 ### Fehlermeldungen
 

cli.py

@@ -39,7 +39,7 @@ def main() -> int:
         "-t",
         "--anomaly_threshold",
         help=(
-            f"optional anomaly threshold to set, default: "
+            f"optional anomaly threshold to set, must be between 0 < value < 1, default: "
             f"{constants.ANOMALY_THRESHOLD_DEFAULT}, type: float"
         ),
         default=constants.ANOMALY_THRESHOLD_DEFAULT,

cli_mocked.py

@@ -42,7 +42,7 @@ def main() -> int:
         "-t",
         "--anomaly_threshold",
         help=(
-            f"optional anomaly threshold to set, default: "
+            f"optional anomaly threshold to set, must be between 0 < value < 1, default: "
             f"{constants.ANOMALY_THRESHOLD_DEFAULT}, type: float"
         ),
         default=constants.ANOMALY_THRESHOLD_DEFAULT,

docs/manual.md

@@ -47,7 +47,7 @@ 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
+                        optional anomaly threshold to set, must be between 0 < value < 1, default: 0.14, type: float
 ```
 
 Das CLI besteht entsprechend der obigen Beschreibung aus einer Funktion. Diese benötigt die folgenden Parameter:
@@ -58,7 +58,7 @@ Das CLI besteht entsprechend der obigen Beschreibung aus einer Funktion. Diese b
 
 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. Die Übergabe erfolgt über den Parameter ``-t`` bzw. ``--anomaly_threshold``. 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. Der Wert muss im Intervall ``(0, 1)`` liegen. Bei ``0`` würde nie und bei ``1`` immer eine Anomlie detektiert werden. Die Übergabe erfolgt über den Parameter ``-t`` bzw. ``--anomaly_threshold``. Der Standardwert liegt bei 0,14.
 
 ### Fehlermeldungen