sigmf.archivereader.SigMFArchiveReader

class sigmf.archivereader.SigMFArchiveReader(name=None, skip_checksum=False, map_readonly=True, archive_buffer=None, autoscale=True)

Bases: object

Access data within SigMF archive (tar, tar.gz, tar.xz, or zip) in-place.

For uncompressed tar archives opened by path, data is memory-mapped directly from the archive file for efficient access. Compressed archives and buffer-based reading load data into memory.

Parameters:

  • name (str | bytes | PathLike, optional) – Path to archive file to access. Recognized extensions: .sigmf, .sigmf.gz, .sigmf.xz, .sigmf.zip

  • skip_checksum (bool, optional) – Skip dataset checksum calculation.

  • map_readonly (bool, optional) – Indicate whether assignments on the numpy.memmap are allowed.

  • archive_buffer (buffer, optional) – Alternative buffer to read archive from.

  • autoscale (bool, optional) – If dataset is in a fixed-point representation, scale samples from (min, max) to (-1.0, 1.0).

Raises:

  • SigMFFileError – Archive file does not exist or is improperly formatted.

  • ValueError – If invalid arguments.

  • ValidationError – If metadata is invalid.

Methods