uwacan.analysis.ShipLevel#

class ShipLevel(data, attrs=None)[source]#

Bases: DatasetWrap

Calculates and stores measured ship levels.

This class has all functionality to analyze ship transits and post-process the resulting radiated noise levels. The analysis methods are all implemented as classmethods with the analyze_transits prefix.

Parameters:
dataxarray.Dataset

The dataset with measurement results. This dataset must have a “source_power” variable.

Methods

analyze_transits(*transits[, filterbank, ...])

Analyze ship transits to estimate source power and related metrics.

analyze_transits_in_angle_segments(*transits)

Analyze ship transits in constant angle segments to estimate source power and related metrics.

level_average(dims, **kwargs)

Level-wise average of data.

meets_snr_threshold(threshold)

Check where the measurement meets a specific SnR threshold.

power_average([dim])

Power-wise average of data.

Inherited methods

from_dataset(dataset, **kwargs)

Instantiate the class from a dataset.

groupby(group)

isel([indexers, drop, missing_dims, drop_allnan])

Select a subset of the data from the coordinate indices.

load(path[, lookup_class])

Load data from a Zarr file and optionally restore the original class.

make_figure(**kwargs)

Create a plotly figure, styled for this data.

save(path[, append_dim])

Save the data to a Zarr file at the specified path.

sel([indexers, method, tolerance, drop, ...])

Select a subset of the data from the coordinate labels.

where(cond[, other, drop])

Filter elements from this object according to a condition.

Attributes

attrs

Attributes stored in the data.

coords

The coordinate (dimension) arrays for this data.

data

The contained data.

dims

The dimensions of this data.

received_level

The received level during the transits.

received_power

The received power during the transits.

sizes

Mapping from dimension names to lengths.

snr

The signal to noise ratio in the measurement, in dB.

source_level

The source level of the transits.

source_power

The source power of the transits.