Technical implementation details

Some shared core functionality in the package.

This contains mostly wrappers around xarray objects, and some very basic functions. A few of these are publicly available in the main package namespace. They should be accessed from there if used externally, but from here if used internally.

Classes and functions only exposed here

time_to_np(input, **kwargs)	Convert a time to numpy.datetime64.
time_to_datetime(input[, fmt, tz])	Convert datetimes to the same internal format.
time_frame_settings([duration, step, ...])	Calculate time frame overlap settings from various input parameters.
TimeWindow([start, stop, center, duration, ...])	Describes a start and stop point in time.
xrwrap(data[, attrs])	Wrapper around xarray objects.
DataArrayWrap(data[, dims, coords])	Wrapper around xarray.DataArray.
DatasetWrap(data[, attrs])	Wraps xarray.Dataset objects.
Roller()	Base class for rolling windows.
TimeDataRoller(obj[, duration, step, ...])	Rolling windows of time data.

Classes and functions exposed in the main package namespace

uwacan.TimeData(data[, time, start_time, ...])	Handing data which varies over time.
uwacan.FrequencyData(data[, frequency, ...])	Handing data which varies over frequency.
uwacan.TimeFrequencyData(data[, time, ...])	Handing data which varies over time and frequency.
uwacan.Transit(recording, track)	Container for recorded ship transits.
uwacan.dB(x[, power, safe_zeros, ref])	Calculate the decibel of an input value.