Command Line Interface (CLI)

The following section is generated automatically based on the implemented cli commands (and there descriptions in the source code)

chimcla - CLI interface

chimcla main command line interface (for all functions which do not have their own script)

chimcla [-h] [--version]
        {prepare-docs,build-docs,continuously-build-docs,bgr-convert,split-into-lots,create-work-images}
        ...

chimcla options

  • -h, --help - show this help message and exit

  • --version - show chimcla version and exit

chimcla prepare-docs

prepare automatic generation of docs

chimcla prepare-docs [-h]

chimcla prepare-docs options

  • -h, --help - show this help message and exit

chimcla build-docs

automatic generation of docs (after preparation)

chimcla build-docs [-h] [docfile]

chimcla build-docs positional arguments

  • docfile - optional file to build (otherwise: build all) (default: None)

chimcla build-docs options

  • -h, --help - show this help message and exit

chimcla continuously-build-docs

continuous automatic generation of docs (after preparation)

chimcla continuously-build-docs [-h]

chimcla continuously-build-docs options

  • -h, --help - show this help message and exit

chimcla bgr-convert

convert jpg files from BGR to RGB and vice versa

chimcla bgr-convert [-h] img_dir

chimcla bgr-convert positional arguments

  • img_dir - directory containing jpg files to convert (default: None)

chimcla bgr-convert options

  • -h, --help - show this help message and exit

chimcla split-into-lots

distribute a big list of files into subdirectories

chimcla split-into-lots [-h] pathlist [part_size]

chimcla split-into-lots positional arguments

  • pathlist - txt file containing the paths (default: None)

  • part_size - number of files per part-subdirectory (default: 1000) (default: 1000)

chimcla split-into-lots options

  • -h, --help - show this help message and exit

chimcla create-work-images

perform stage 1: size adaption, empty slot detection, incomplete form detection, shading correction

chimcla create-work-images [-h] [--no-parallel] img_dir [prefix]

chimcla create-work-images positional arguments

  • img_dir - e.g. /home/ck/mnt/XAI-DIA-gl/Carsten/data_images/lots/2025-09-15_06-17-16__1d__27.9k/part001 (default: None)

  • prefix - prefix for newly created dirs during preprocessing (default: pp_)

chimcla create-work-images options