sidescanpy.io.jsf

JSF (Edgetech Survey Format) IO.

This module parses Edgetech .jsf binary files into typed message instances and converts those messages into a validated SideScanSurvey.

Public entry points

• read_jsf() — eager read, returns list[JSFMessage].

• read_jsf_iter() — generator over messages (use for large files).

• convert() — dispatches a message list into a SideScanSurvey.

• write_subset() — copy a run of pings to a new file, byte for byte.

Conventions

• Sonar messages expose timestamp_ns: int. Auxiliary messages expose timestamp: float (epoch seconds).

• Per-ping fields with invalid validity flags currently appear as None; the converter coerces them to np.nan.

• All output time coordinates are datetime64[ns].

See docs/sources/jsf.md for full reference and known issues.

2026 rshomberg@uri.edu

Modules

• converter
• messages
• reader
• subset
• targets