sidescanpy.analysis.navigation

Navigation and attitude data-quality summary.

summarize_navigation() reports per-field statistics for the per-ping aux fields (heading, pitch, roll, altitude, depth, heave) and checks which heading convention the data follows. The library’s own convention is compass bearing, clockwise from north, in [0, 360).

Contents

NAV_ATTITUDE_VARS	Built-in immutable sequence.
FieldStats	NaN count and finite min/max/mean of one per-ping field.
NavigationSummary	Per-field statistics plus the heading-convention check.
summarize_navigation	Per-field statistics for every NAV_ATTITUDE_VARS entry in ds, plus the fraction of heading_var values in each heading convention.

sidescanpy.analysis.navigation.NAV_ATTITUDE_VARS

Built-in immutable sequence.

If no argument is given, the constructor returns an empty tuple. If iterable is specified the tuple is initialized from iterable’s items.

If the argument is a tuple, the return value is the same object.

class sidescanpy.analysis.navigation.FieldStats(n_nan=0, minimum=None, maximum=None, mean=None)

Bases:

NaN count and finite min/max/mean of one per-ping field.

class sidescanpy.analysis.navigation.NavigationSummary(heading_convention=None, field_stats=<factory>, heading_frac_compass_range=None, heading_frac_signed_range=None, heading_frac_out_of_range=None, notes=<factory>)

Bases:

Per-field statistics plus the heading-convention check.

heading_convention is "compass_bearing" (all finite values in [0, 360)), "signed" (all in [-180, 180)), "ambiguous" (neither holds for every value), or None (no heading, or no finite heading values). field_stats is keyed by variable name and covers the NAV_ATTITUDE_VARS present.

sidescanpy.analysis.navigation.summarize_navigation(ds, *, heading_var='heading_deg')

Per-field statistics for every NAV_ATTITUDE_VARS entry in ds, plus the fraction of heading_var values in each heading convention.

A value outside both conventions is not necessarily an error (a trace through a turn can briefly leave one), so the plotted trace is the place to judge it.