zea.data.convert.picmus

Script to convert the PICMUS database to the zea format.

For more information about the dataset, resort to the following links:

  • The original dataset can be found at this link.

Functions

convert(source_path, output_path[, overwrite])

Converts and writes a single PICMUS file to the zea format.

convert_picmus(args)

Convert PICMUS HDF5 files under a source directory into the zea dataset format, preserving relative paths in the destination.
zea.data.convert.picmus.convert(source_path, output_path, overwrite=False)[source]

Converts and writes a single PICMUS file to the zea format.

Parameters:

  • source_path (str, pathlike) – The path to the original PICMUS file.

  • output_path (str, pathlike) – The path to the output file.

  • overwrite (bool, optional) – Set to True to overwrite existing file. Defaults to False.

zea.data.convert.picmus.convert_picmus(args)[source]

Convert PICMUS HDF5 files under a source directory into the zea dataset format, preserving relative paths in the destination.

Parameters:

args (argparse.Namespace) –

An object with the following attributes.

  • src (str or Path): Path to the PICMUS source directory or archive.

  • dst (str or Path): Path to the output directory where converted .hdf5 files will be written.

Note

  • Scans src (after unzipping if needed) for .hdf5 files containing IQ/RF data and converts each to the zea format.

  • Preserves the relative directory structure under dst and places each converted file in its own subdirectory named after the file stem.

  • Fails fast if src does not exist or if dst already exists.