Command-line interface


Create a compressed version of an .rtdc file. This can be used for saving disk space. The data generate during an experiment is usually not compressed.

usage: dclab-compress [-h] INPUT OUTPUT

positional arguments:

  • INPUT Input path (.rtdc file)
  • OUTPUT Output path (.rtdc file)


Reduce an RT-DC measurement to its scalar-only features (i.e. without contour, image, mask, or trace). All available ancillary features are computed.

usage: dclab-condense [-h] INPUT OUTPUT

positional arguments:

  • INPUT Input path (.tdms or .rtdc file)
  • OUTPUT Output path (.rtdc file)


Join two or more RT-DC measurements. This will produce one larger .rtdc file. The meta data of the dataset that was recorded earliest will be used in the output file. Please only join datasets that were recorded in the same measurement run.

usage: dclab-join [-h] [-o OUTPUT] [INPUT [INPUT ...]]

positional arguments:

  • INPUT Input paths (.tdms or .rtdc files)

optional arguments:

  • -o, --output Output path (.rtdc file)


Convert RT-DC .tdms files to the hdf5-based .rtdc file format. Note: Do not delete original .tdms files after conversion. The conversion might be incomplete.

usage: dclab-tdms2rtdc [-h] [--compute-ancillary-features]
                       TDMS_PATH RTDC_PATH

positional arguments:

  • TDMS_PATH Input path (tdms file or folder containing tdms files)
  • RTDC_PATH Output path (file or folder), existing data will be overridden

optional arguments:

  • --compute-ancillary-features (disabled by default) Compute features, such as volume or emodulus, that are otherwise computed on-the-fly. Use this if you want to minimize analysis time in e.g. Shape-Out. CAUTION: ancillary feature recipes might be subject to change (e.g. if an error is found in the recipe). Disabling this option maximizes compatibility with future versions and allows to isolate the original data.
  • --include-initial-empty-image (disabled by default) In old versions of Shape-In, the first image was sometimes not stored in the resulting .avi file. In dclab, such images are represented as zero-valued images. Set this option, if you wish to include the first event with empty image data.


Check experimental datasets for completeness. Note that old measurements will most likely fail this verification step. This program is used to enforce data integrity with future implementations of RT-DC recording software (e.g. Shape-In).

usage: dclab-verify-dataset [-h] PATH

positional arguments:

  • PATH Path to experimental dataset