Core functionality

A collection of analysis methods for underwater acoustics, specialized on radiated noise from ships.

The main package namespace holds some commonly used functions and classes.

Classes for data handling

TimeData(data[, time, start_time, ...])	Handing data which varies over time.
FrequencyData(data[, frequency, ...])	Handing data which varies over frequency.
TimeFrequencyData(data[, time, start_time, ...])	Handing data which varies over time and frequency.

Classes for positions and sensors

Position(*args[, latitude, longitude])	Class for single positions.
Track(data[, calculate_course, calculate_speed])	A class representing a GPS track, which is a sequence of coordinates over time.
sensor(sensor, /[, sensitivity, depth, ...])	Collect sensor information.

Other common operations

dB(x[, power, safe_zeros, ref])	Calculate the decibel of an input value.
Filterbank(*[, bands_per_decade, ...])	Calculates spectrograms, both linear and banded.
Transit(recording, track)	Container for recorded ship transits.
TimeWindow([start, stop, center, duration, ...])	Describes a start and stop point in time.
load_data(path[, lookup_class])	Load data from a Zarr file and optionally restore the original class.
concatenate(items[, dim, nan_between_items, ...])	Concatenates a list of items along a specified dimension.
time_to_datetime(input[, fmt, tz])	Convert datetimes to the same internal format.
time_to_np(input, **kwargs)	Convert a time to numpy.datetime64.