swap_dims_channel_frequency

echopype.consolidate.swap_dims_channel_frequency(ds: Union[Dataset, str, Path]) → Dataset

Use frequency_nominal in place of channel to be dataset dimension and coorindate.

This is useful because the nominal transducer frequencies are commonly used to refer to data collected from a specific transducer.

Parameters

dsxr.Dataset or str or pathlib.Path

Dataset or path to a file containing the Dataset for which the dimension will be swapped

Returns

The input dataset with the dimension swapped

Notes

This operation is only possible when there are no duplicated frequencies present in the file.