Add split-beam (alongship/athwartship) angles into the Sv dataset. This function calculates the alongship/athwartship angle using data stored in the Sonar/Beam_groupX groups of an EchoData object.
In cases when angle data does not already exist or cannot be computed from the data, an error is issued and no angle variables are added to the dataset.
The Sv Dataset or path to a file containing the Sv Dataset, to which the split-beam angles will be added
An EchoData
object or path to a file containing the EchoData
object holding the raw data
Type of transmit waveform
"CW"
for narrowband transmission,
returned echoes recorded either as complex or power/angle samples
"BB"
for broadband transmission,
returned echoes recorded as complex samples
Type of encoded return echo data
"complex"
for complex samples
"power"
for power/angle samples, only allowed when
the echosounder is configured for narrowband transmission
Whether pulse compression should be used (only valid for
waveform_mode="BB"
and encode_mode="complex"
)
Any additional parameters for the storage backend, corresponding to the
path provided for source_Sv
If False
, to_disk
with split-beam angles added will be returned.
to_disk=True
is useful when source_Sv
is a path and
users only want to write the split-beam angle data to this path.
If to_disk=False
, nothing will be returned.
If to_disk=True
, either the input dataset source_Sv
or a lazy-loaded Dataset (from the path source_Sv
)
with split-beam angles added will be returned.
If echodata
has a sonar model that is not analogous to either EK60 or EK80
If the input source_Sv
does not have a channel
dimension
If source_Sv
does not have appropriate dimension lengths in
comparison to echodata
data
If the provided waveform_mode
, encode_mode
, and pulse_compression
are not valid
If an unknown beam_type
is encountered during the split-beam calculation
Split-beam angle data potentially exist for the Simrad EK60 or EK80 echosounders with split-beam transducers and configured to store angle data (along with power samples) or store raw complex samples.
In most cases where the type of samples collected by the echosounder (power/angle
samples or complex samples) and the transmit waveform (broadband or narrowband)
are identical across all channels, the channels existing in source_Sv
and `
echodata` will be identical. If this is not the case, only angle data corresponding
to channels existing in source_Sv
will be added.