added support for skippable filter/writer plugins

fracpete · fracpete · commit 80c173ac0528 · 2025-04-08T12:06:07.000+12:00
diff --git a/plugins/change-grayscale.md b/plugins/change-grayscale.md
@@ -7,7 +7,7 @@ Changes the pixel values of grayscale images either by a factor or by a fixed va
 
 ```
 usage: change-grayscale [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
-                        [-N LOGGER_NAME] [--factor FACTOR]
+                        [-N LOGGER_NAME] [--skip] [--factor FACTOR]
                         [--increment INCREMENT]
 
 Changes the pixel values of grayscale images either by a factor or by a fixed
@@ -20,6 +20,8 @@ options:
   -N LOGGER_NAME, --logger_name LOGGER_NAME
                         The custom name to use for the logger, uses the plugin
                         name by default (default: None)
+  --skip                Disables the plugin, removing it from the pipeline.
+                        (default: False)
   --factor FACTOR       The factor with which to scale the pixel values.
                         (default: None)
   --increment INCREMENT
diff --git a/plugins/clip-grayscale.md b/plugins/clip-grayscale.md
@@ -7,8 +7,8 @@ Changes the grayscale values that fall below the minimum or go above the maximum
 
 ```
 usage: clip-grayscale [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
-                      [-N LOGGER_NAME] [-m MIN_VALUE] [-r MIN_REPLACEMENT]
-                      [-M MAX_VALUE] [-R MAX_REPLACEMENT]
+                      [-N LOGGER_NAME] [--skip] [-m MIN_VALUE]
+                      [-r MIN_REPLACEMENT] [-M MAX_VALUE] [-R MAX_REPLACEMENT]
 
 Changes the grayscale values that fall below the minimum or go above the
 maximum to the specified replacement values.
@@ -20,6 +20,8 @@ options:
   -N LOGGER_NAME, --logger_name LOGGER_NAME
                         The custom name to use for the logger, uses the plugin
                         name by default (default: None)
+  --skip                Disables the plugin, removing it from the pipeline.
+                        (default: False)
   -m MIN_VALUE, --min_value MIN_VALUE
                         The smallest allowed grayscale pixel value. (default:
                         0)
diff --git a/plugins/crop-to-label.md b/plugins/crop-to-label.md
@@ -7,7 +7,7 @@ Crops an image to the bbox with the specified label.
 
 ```
 usage: crop-to-label [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
-                     [-N LOGGER_NAME] -r REGION_LABEL [-k]
+                     [-N LOGGER_NAME] [--skip] -r REGION_LABEL [-k]
 
 Crops an image to the bbox with the specified label.
 
@@ -18,6 +18,8 @@ options:
   -N LOGGER_NAME, --logger_name LOGGER_NAME
                         The custom name to use for the logger, uses the plugin
                         name by default (default: None)
+  --skip                Disables the plugin, removing it from the pipeline.
+                        (default: False)
   -r REGION_LABEL, --region_label REGION_LABEL
                         The label of the bbox to crop the image to. (default:
                         None)
diff --git a/plugins/crop.md b/plugins/crop.md
@@ -7,8 +7,8 @@ Crops images.
 
 ```
 usage: crop [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [-N LOGGER_NAME]
-            [-m {replace,add}] [--suffix SUFFIX] [-s SEED] [-a] [-T THRESHOLD]
-            [-f FROM_PERCENT] [-t TO_PERCENT] [-u]
+            [--skip] [-m {replace,add}] [--suffix SUFFIX] [-s SEED] [-a]
+            [-T THRESHOLD] [-f FROM_PERCENT] [-t TO_PERCENT] [-u]
 
 Crops images.
 
@@ -19,6 +19,8 @@ options:
   -N LOGGER_NAME, --logger_name LOGGER_NAME
                         The custom name to use for the logger, uses the plugin
                         name by default (default: None)
+  --skip                Disables the plugin, removing it from the pipeline.
+                        (default: False)
   -m {replace,add}, --mode {replace,add}
                         The image augmentation mode to use. (default: replace)
   --suffix SUFFIX       The suffix to use for the file names in case of
diff --git a/plugins/enhance.md b/plugins/enhance.md
@@ -7,7 +7,7 @@ Enhances the image using the specified enhancement and factor.
 
 ```
 usage: enhance [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [-N LOGGER_NAME]
-               [-m {replace,add}] [--suffix SUFFIX] [-s SEED] [-a]
+               [--skip] [-m {replace,add}] [--suffix SUFFIX] [-s SEED] [-a]
                [-T THRESHOLD] [-f FROM_FACTOR] [-t TO_FACTOR]
                [-e {color,contrast,brightness,sharpness}]
 
@@ -20,6 +20,8 @@ options:
   -N LOGGER_NAME, --logger_name LOGGER_NAME
                         The custom name to use for the logger, uses the plugin
                         name by default (default: None)
+  --skip                Disables the plugin, removing it from the pipeline.
+                        (default: False)
   -m {replace,add}, --mode {replace,add}
                         The image augmentation mode to use. (default: replace)
   --suffix SUFFIX       The suffix to use for the file names in case of
diff --git a/plugins/find-contours.md b/plugins/find-contours.md
@@ -7,8 +7,9 @@ Detects blobs images and turns them into object detection polygons. In case of i
 
 ```
 usage: find-contours [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
-                     [-N LOGGER_NAME] [-t MASK_THRESHOLD] [-n MASK_NTH]
-                     [-m VIEW_MARGIN] [-f {low,high}] [--label LABEL]
+                     [-N LOGGER_NAME] [--skip] [-t MASK_THRESHOLD]
+                     [-n MASK_NTH] [-m VIEW_MARGIN] [-f {low,high}]
+                     [--label LABEL]
 
 Detects blobs images and turns them into object detection polygons. In case of
 image segmentation data, the annotations are analyzed, otherwise the base
@@ -21,6 +22,8 @@ options:
   -N LOGGER_NAME, --logger_name LOGGER_NAME
                         The custom name to use for the logger, uses the plugin
                         name by default (default: None)
+  --skip                Disables the plugin, removing it from the pipeline.
+                        (default: False)
   -t MASK_THRESHOLD, --mask_threshold MASK_THRESHOLD
                         The (lower) probability threshold for mask values in
                         order to be considered part of the object (0-1).
diff --git a/plugins/flip.md b/plugins/flip.md
@@ -7,8 +7,8 @@ Flips images either left-to-right, up-to-down or both.
 
 ```
 usage: flip [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [-N LOGGER_NAME]
-            [-m {replace,add}] [--suffix SUFFIX] [-s SEED] [-a] [-T THRESHOLD]
-            [-d {lr,ud,lrud}]
+            [--skip] [-m {replace,add}] [--suffix SUFFIX] [-s SEED] [-a]
+            [-T THRESHOLD] [-d {lr,ud,lrud}]
 
 Flips images either left-to-right, up-to-down or both.
 
@@ -19,6 +19,8 @@ options:
   -N LOGGER_NAME, --logger_name LOGGER_NAME
                         The custom name to use for the logger, uses the plugin
                         name by default (default: None)
+  --skip                Disables the plugin, removing it from the pipeline.
+                        (default: False)
   -m {replace,add}, --mode {replace,add}
                         The image augmentation mode to use. (default: replace)
   --suffix SUFFIX       The suffix to use for the file names in case of
diff --git a/plugins/gaussian-blur.md b/plugins/gaussian-blur.md
@@ -7,9 +7,9 @@ Applies gaussian blur to images.
 
 ```
 usage: gaussian-blur [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
-                     [-N LOGGER_NAME] [-m {replace,add}] [--suffix SUFFIX]
-                     [-s SEED] [-a] [-T THRESHOLD] [-f FROM_SIGMA]
-                     [-t TO_SIGMA]
+                     [-N LOGGER_NAME] [--skip] [-m {replace,add}]
+                     [--suffix SUFFIX] [-s SEED] [-a] [-T THRESHOLD]
+                     [-f FROM_SIGMA] [-t TO_SIGMA]
 
 Applies gaussian blur to images.
 
@@ -20,6 +20,8 @@ options:
   -N LOGGER_NAME, --logger_name LOGGER_NAME
                         The custom name to use for the logger, uses the plugin
                         name by default (default: None)
+  --skip                Disables the plugin, removing it from the pipeline.
+                        (default: False)
   -m {replace,add}, --mode {replace,add}
                         The image augmentation mode to use. (default: replace)
   --suffix SUFFIX       The suffix to use for the file names in case of
diff --git a/plugins/hsl-grayscale.md b/plugins/hsl-grayscale.md
@@ -7,9 +7,9 @@ Turns RGB images into fake grayscale ones by converting them to HSL and then usi
 
 ```
 usage: hsl-grayscale [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
-                     [-N LOGGER_NAME] [-m {replace,add}] [--suffix SUFFIX]
-                     [-s SEED] [-a] [-T THRESHOLD] [-f FROM_FACTOR]
-                     [-t TO_FACTOR]
+                     [-N LOGGER_NAME] [--skip] [-m {replace,add}]
+                     [--suffix SUFFIX] [-s SEED] [-a] [-T THRESHOLD]
+                     [-f FROM_FACTOR] [-t TO_FACTOR]
 
 Turns RGB images into fake grayscale ones by converting them to HSL and then
 using the L channel for all channels. The brightness can be influenced and
@@ -22,6 +22,8 @@ options:
   -N LOGGER_NAME, --logger_name LOGGER_NAME
                         The custom name to use for the logger, uses the plugin
                         name by default (default: None)
+  --skip                Disables the plugin, removing it from the pipeline.
+                        (default: False)
   -m {replace,add}, --mode {replace,add}
                         The image augmentation mode to use. (default: replace)
   --suffix SUFFIX       The suffix to use for the file names in case of
diff --git a/plugins/linear-contrast.md b/plugins/linear-contrast.md
@@ -7,9 +7,9 @@ Applies linear contrast to images.
 
 ```
 usage: linear-contrast [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
-                       [-N LOGGER_NAME] [-m {replace,add}] [--suffix SUFFIX]
-                       [-s SEED] [-a] [-T THRESHOLD] [-f FROM_ALPHA]
-                       [-t TO_ALPHA]
+                       [-N LOGGER_NAME] [--skip] [-m {replace,add}]
+                       [--suffix SUFFIX] [-s SEED] [-a] [-T THRESHOLD]
+                       [-f FROM_ALPHA] [-t TO_ALPHA]
 
 Applies linear contrast to images.
 
@@ -20,6 +20,8 @@ options:
   -N LOGGER_NAME, --logger_name LOGGER_NAME
                         The custom name to use for the logger, uses the plugin
                         name by default (default: None)
+  --skip                Disables the plugin, removing it from the pipeline.
+                        (default: False)
   -m {replace,add}, --mode {replace,add}
                         The image augmentation mode to use. (default: replace)
   --suffix SUFFIX       The suffix to use for the file names in case of
diff --git a/plugins/meta-sub-images.md b/plugins/meta-sub-images.md
@@ -7,7 +7,7 @@ Extracts sub-images (incl their annotations) from the images coming through, usi
 
 ```
 usage: meta-sub-images [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
-                       [-N LOGGER_NAME] [-r [REGIONS ...]]
+                       [-N LOGGER_NAME] [--skip] [-r [REGIONS ...]]
                        [--num_rows NUM_ROWS] [--num_cols NUM_COLS]
                        [--row_height ROW_HEIGHT] [--col_width COL_WIDTH]
                        [--overlap_right OVERLAP_RIGHT]
@@ -27,6 +27,8 @@ options:
   -N LOGGER_NAME, --logger_name LOGGER_NAME
                         The custom name to use for the logger, uses the plugin
                         name by default (default: None)
+  --skip                Disables the plugin, removing it from the pipeline.
+                        (default: False)
   -r [REGIONS ...], --regions [REGIONS ...]
                         The regions (X,Y,WIDTH,HEIGHT) to crop and forward
                         with their annotations (0-based coordinates) (default:
diff --git a/plugins/resize.md b/plugins/resize.md
@@ -7,7 +7,7 @@ Resizes all images according to the specified width/height. When only resizing o
 
 ```
 usage: resize [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [-N LOGGER_NAME]
-              [-W WIDTH] [-H HEIGHT]
+              [--skip] [-W WIDTH] [-H HEIGHT]
 
 Resizes all images according to the specified width/height. When only resizing
 one dimension, use 'keep-aspect-ratio' for the other one to keep the aspect
@@ -20,6 +20,8 @@ options:
   -N LOGGER_NAME, --logger_name LOGGER_NAME
                         The custom name to use for the logger, uses the plugin
                         name by default (default: None)
+  --skip                Disables the plugin, removing it from the pipeline.
+                        (default: False)
   -W WIDTH, --width WIDTH
                         The new width for the image; use 'keep-aspect-ratio'
                         when only supplying height and you want to keep the
diff --git a/plugins/roi-images.md b/plugins/roi-images.md
@@ -7,7 +7,8 @@ Extracts sub-images using the bbox of all the object detection annotations that
 
 ```
 usage: roi-images [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
-                  [-N LOGGER_NAME] [--labels [LABELS ...]] [-S SUFFIX]
+                  [-N LOGGER_NAME] [--skip] [--labels [LABELS ...]]
+                  [-S SUFFIX]
 
 Extracts sub-images using the bbox of all the object detection annotations
 that have matching labels. If no labels are specified, all annotations are
@@ -20,6 +21,8 @@ options:
   -N LOGGER_NAME, --logger_name LOGGER_NAME
                         The custom name to use for the logger, uses the plugin
                         name by default (default: None)
+  --skip                Disables the plugin, removing it from the pipeline.
+                        (default: False)
   --labels [LABELS ...]
                         The label(s) of the annotations to forward as sub-
                         images, uses all annotations if not specified.
diff --git a/plugins/rotate.md b/plugins/rotate.md
@@ -7,7 +7,7 @@ Rotates images randomly within a range of degrees or by a specified degree. Spec
 
 ```
 usage: rotate [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [-N LOGGER_NAME]
-              [-m {replace,add}] [--suffix SUFFIX] [-s SEED] [-a]
+              [--skip] [-m {replace,add}] [--suffix SUFFIX] [-s SEED] [-a]
               [-T THRESHOLD] [-f FROM_DEGREE] [-t TO_DEGREE]
 
 Rotates images randomly within a range of degrees or by a specified degree.
@@ -21,6 +21,8 @@ options:
   -N LOGGER_NAME, --logger_name LOGGER_NAME
                         The custom name to use for the logger, uses the plugin
                         name by default (default: None)
+  --skip                Disables the plugin, removing it from the pipeline.
+                        (default: False)
   -m {replace,add}, --mode {replace,add}
                         The image augmentation mode to use. (default: replace)
   --suffix SUFFIX       The suffix to use for the file names in case of
diff --git a/plugins/scale.md b/plugins/scale.md
@@ -7,7 +7,7 @@ Scales images randomly within a range of percentages or by a specified percentag
 
 ```
 usage: scale [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [-N LOGGER_NAME]
-             [-m {replace,add}] [--suffix SUFFIX] [-s SEED] [-a]
+             [--skip] [-m {replace,add}] [--suffix SUFFIX] [-s SEED] [-a]
              [-T THRESHOLD] [-f FROM_PERCENTAGE] [-t TO_PERCENTAGE] [-k] [-u]
 
 Scales images randomly within a range of percentages or by a specified
@@ -21,6 +21,8 @@ options:
   -N LOGGER_NAME, --logger_name LOGGER_NAME
                         The custom name to use for the logger, uses the plugin
                         name by default (default: None)
+  --skip                Disables the plugin, removing it from the pipeline.
+                        (default: False)
   -m {replace,add}, --mode {replace,add}
                         The image augmentation mode to use. (default: replace)
   --suffix SUFFIX       The suffix to use for the file names in case of
diff --git a/plugins/sub-images.md b/plugins/sub-images.md
@@ -7,9 +7,10 @@ Extracts sub-images (incl their annotations) from the images coming through, usi
 
 ```
 usage: sub-images [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
-                  [-N LOGGER_NAME] [-r [REGIONS ...]] [--num_rows NUM_ROWS]
-                  [--num_cols NUM_COLS] [--row_height ROW_HEIGHT]
-                  [--col_width COL_WIDTH] [--overlap_right OVERLAP_RIGHT]
+                  [-N LOGGER_NAME] [--skip] [-r [REGIONS ...]]
+                  [--num_rows NUM_ROWS] [--num_cols NUM_COLS]
+                  [--row_height ROW_HEIGHT] [--col_width COL_WIDTH]
+                  [--overlap_right OVERLAP_RIGHT]
                   [--overlap_bottom OVERLAP_BOTTOM]
                   [-s {none,x-then-y,y-then-x}] [-p] [-e] [-S SUFFIX]
                   [--pad_width PAD_WIDTH] [--pad_height PAD_HEIGHT]
@@ -25,6 +26,8 @@ options:
   -N LOGGER_NAME, --logger_name LOGGER_NAME
                         The custom name to use for the logger, uses the plugin
                         name by default (default: None)
+  --skip                Disables the plugin, removing it from the pipeline.
+                        (default: False)
   -r [REGIONS ...], --regions [REGIONS ...]
                         The regions (X,Y,WIDTH,HEIGHT) to crop and forward
                         with their annotations (0-based coordinates) (default:
