sidescanpy.io

IO for SideScan sonar surveys.

Format-specific readers/converters live in submodules (sidescanpy.io.jsf, sidescanpy.io.sdf, sidescanpy.io.xtf, sidescanpy.io.hdf5, sidescanpy.io.netcdf). This top-level package additionally exposes format-dispatching helpers for callers that have file paths and don’t want to branch on extension themselves.

Public entry points

• detect_format() — extension-based format dispatch (.jsf / .sdf / .xtf).

• read_and_convert() — read + convert a list of same-format sonar files into a validated SideScanSurvey.

• read_and_convert_segments() — one raw file into (output_stem, survey) pairs; XTF files are split at range-setting changes.

• segment_stem() — the output stem of one segment.

• find_sonar_files() — raw sonar files in a directory.

• load_survey() — a .ss.h5 or raw file, whichever it is.

• detect_catalog_format() / read_target_catalog() — target catalogs (EdgeTech Discover or Klein SonarWiz), by directory contents.

2026 rshomberg@uri.edu

Modules

• dispatch
• hdf5
• jsf
• netcdf
• sdf
• xtf