sidescanpy.io.netcdf.writer#
Write a SideScanFrequencyChannel to a NetCDF (.nc) file.
Uses h5netcdf engine. Encoding follows the shared policy in
io.hdf5.writer._encoding_for (gzip + shuffle on every ndim >= 2
variable; small per-ping scalars are stored uncompressed).
2026 rshomberg@uri.edu
Contents
Write a single SideScanFrequencyChannel to a .nc file. |
- sidescanpy.io.netcdf.writer.write_frequency_channel(channel, path, *, overwrite=False)#
Write a single SideScanFrequencyChannel to a .nc file.
- Parameters:
- channelSideScanFrequencyChannel
The channel to serialize. Its underlying dataset must already pass SideScanAccessor.validate().
- pathPath or str
Destination file path.
- overwritebool, default False
If False (default) and
pathexists, raise FileExistsError. If True, replace the existing file.
- Raises:
- FileExistsError
If
pathexists andoverwriteis False.