Bases: object
Echo data model class for handling raw converted data, including multiple files associated with the same data set.
Clean up the swap files during raw data conversion | |
| Save content of EchoData to netCDF. |
| Save content of EchoData to zarr. |
| Updates the EchoData["Platform"] group with additional external platform data. |
from_file |
Clean up the swap files during raw data conversion | |
| |
| Save content of EchoData to netCDF. |
| Save content of EchoData to zarr. |
| Updates the EchoData["Platform"] group with additional external platform data. |
Clean up the swap files during raw data conversion
Save content of EchoData to netCDF.
path that converted .nc file will be saved
whether or not to perform compression on data variables
Defaults to True
whether or not to overwrite existing files
Defaults to False
whether or not to use parallel processing. (Not yet implemented)
Additional keywords to pass to the filesystem class.
Extra arguments to xr.Dataset.to_netcdf: refer to xarray’s documentation for a list of all possible arguments.
Save content of EchoData to zarr.
path that converted .nc file will be saved
whether or not to perform compression on data variables
Defaults to True
whether or not to overwrite existing files
Defaults to False
whether or not to use parallel processing. (Not yet implemented)
Additional keywords to pass to the filesystem class.
Flag to consolidate zarr metadata.
Defaults to True
Extra arguments to xr.Dataset.to_zarr: refer to xarray’s documentation for a list of all possible arguments.
Updates the EchoData[“Platform”] group with additional external platform data.
extra_platform_data must be an xarray Dataset. Data is extracted from extra_platform_data by variable name. Only data assigned to a pre-existing (but possibly all-nan) variable name in Platform will be processed. These Platform variables include latitude, longitude, pitch, roll, vertical_offset, etc. See the variables present in the EchoData object’s Platform group to obtain a complete list of possible variables. Different external variables may be dependent on different time dimensions, but latitude and longitude (if specified) must share the same time dimension. New time dimensions will be added as needed. For example, if variables to be added from the external data use two time dimensions and the Platform group has time dimensions time2 and time2, new dimensions time3 and time4 will be created.
An xr.Dataset containing the additional platform data to be added to the EchoData[“Platform”] group.
A dictionary mapping Platform variable names (dict key) to the external-data variable name (dict value).
File name for source of extra platform data, if read from a file
>>> ed = echopype.open_raw(raw_file, "EK60")
>>> extra_platform_data = xr.open_dataset(extra_platform_data_file_name)
>>> ed.update_platform(
>>> extra_platform_data,
>>> variable_mappings={"longitude": "lon", "latitude": "lat", "roll": "ROLL"},
>>> extra_platform_data_file_name=extra_platform_data_file_name
>>> )