renamed split to split-records to avoid name clash with meta-data field

Author: fracpete

CHANGES.rst

@@ -15,6 +15,7 @@ Changelog
   rather than using an absolute file name
 - the bluechannel/grayscale/indexed-png image segmentation readers/writers can use a value other
   than 0 now for the background
+- `split` filter has been renamed to `split-records`
 
 
 0.0.2 (2024-06-13)

README.md

@@ -70,8 +70,8 @@ filters (30):
    label-present, map-labels, max-records, metadata, metadata-from-name, 
    od-to-ic, od-to-is, passthrough, polygon-discarder, 
    polygon-simplifier, pyfunc-filter, randomize-records, record-window, 
-   remove-classes, rename, sample, split, strip-annotations, tee, 
-   write-labels
+   remove-classes, rename, sample, split-records, strip-annotations, 
+   tee, write-labels
 writers (14):
    to-adams-ic, to-adams-od, to-blue-channel-is, to-coco-od, to-data, 
    to-grayscale-is, to-indexed-png-is, to-layer-segments-is, to-opex-od, 

plugins/README.md

@@ -43,7 +43,7 @@
 * [remove-classes](remove-classes.md)
 * [rename](rename.md)
 * [sample](sample.md)
-* [split](split.md)
+* [split-records](split-records.md)
 * [strip-annotations](strip-annotations.md)
 * [tee](tee.md)
 * [write-labels](write-labels.md)

plugins/split.md plugins/split-records.md

@@ -1,14 +1,14 @@
-# split
+# split-records
 
 * accepts: seppl.AnyData
 * generates: seppl.AnyData
 
 Splits the incoming records into the specified split ratios by setting the 'split' meta-data value. Also stores the split names in the current session.
 
 ```
-usage: split [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [-N LOGGER_NAME]
-             [-r SPLIT_RATIOS [SPLIT_RATIOS ...]]
-             [-n SPLIT_NAMES [SPLIT_NAMES ...]]
+usage: split-records [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
+                     [-N LOGGER_NAME] [-r SPLIT_RATIOS [SPLIT_RATIOS ...]]
+                     [-n SPLIT_NAMES [SPLIT_NAMES ...]]
 
 Splits the incoming records into the specified split ratios by setting the
 'split' meta-data value. Also stores the split names in the current session.

src/idc/filter/__init__.py

@@ -17,7 +17,7 @@
 from ._remove_classes import RemoveClasses
 from ._rename import Rename, RENAME_PLACEHOLDERS, RENAME_PH_NAME, RENAME_PH_COUNT, RENAME_PH_PDIR, RENAME_PH_SAME, RENAME_PH_PDIR_SUFFIX, RENAME_PH_EXT, RENAME_PH_OCCURRENCES, RENAME_PH_HELP
 from ._sample import Sample
-from ._split import Split
+from ._split_records import SplitRecords
 from ._strip_annotations import StripAnnotations
 from ._tee import Tee
 from ._write_labels import WriteLabels

src/idc/filter/_split.py src/idc/filter/_split_records.py

@@ -10,7 +10,7 @@
 """ the key for storing the split name in the meta-data. """
 
 
-class Split(Filter):
+class SplitRecords(Filter):
     """
     Splits the incoming records into the specified split ratios by setting the 'split' meta-data value. Also stores the split names in the current session.
     """
@@ -41,7 +41,7 @@ def name(self) -> str:
         :return: the name
         :rtype: str
         """
-        return "split"
+        return "split-records"
 
     def description(self) -> str:
         """