sidescanpy.analysis#

Quantitative analysis tools for sidescan data.

Each function takes data and returns a result dataclass (with to_dict()); none runs a workflow or plots (see sidescanpy.viz.analysis and sidescanpy.viz.tvg).

characterize_values() / infer_units() — value-range summary and units call (ValueSummary, UnitsResult).
compare_outlier_rejection() — effect of range-binned outlier rejection (OutlierComparisonResult).
analyze_nadir() — nadir type, altitude and first-bottom-return boundaries (NadirResult).
estimate_beam_geometry() — near/far beam edges (BeamGeometryResult).
estimate_usable_range() — where signal falls to the noise floor (UsableRangeResult); find_noise_knee() — peak, floor and noise knee of a level profile (NoiseKnee).
fit_tvg_models() — the TVG to apply: fixed and free spreading and absorption models fitted to the median level (TVGFitResult); check_tvg() — how flat a TVG recipe leaves the data (TVGCheckResult).
compare_before_after(), bin_by_altitude() — TVG comparison helpers.
Deprecated, removed in 0.12: fit_range_decay() (RangeDecayResult), fit_tvg_curve() (TVGCandidateFit, TVGCandidateFitResult); use fit_tvg_models().
summarize_navigation() — heading convention and nav/attitude stats (NavigationSummary).
measure_ping_geometry() — ping spacing and resolution (PingGeometry).
detect_shadow_proposals() — object proposals from acoustic shadows and their highlights (ShadowProposals).

Modules