Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Standardize backscatter_r/i long_name, and correct units #1047

Merged
merged 3 commits into from
May 24, 2023
Merged

Standardize backscatter_r/i long_name, and correct units #1047

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d77500d
Define backscatter_r and backscatter_i long_name in the convention ya…
emiliom May 22, 2023
9237e79
Correct backscatter_r and backscatter_i units for AZFP (count, not dB…
emiliom May 22, 2023
d23428e
Remove some non-operational # noqa flags added recently to set_groups…
emiliom May 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion echopype/convert/set_groups_azfp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,12 @@ def set_beam(self) -> List[xr.Dataset]:
"backscatter_r": (
["channel", "ping_time", "range_sample"],
N,
{"long_name": "Backscatter power", "units": "dB"},
{
"long_name": self._varattrs["beam_var_default"]["backscatter_r"][
"long_name"
],
"units": "count",
},
),
"equivalent_beam_angle": (
["channel"],
Expand Down
15 changes: 12 additions & 3 deletions echopype/convert/set_groups_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,7 +403,10 @@ def _get_power_dataarray(self, zarr_path: str) -> xr.DataArray:
),
},
name="backscatter_r",
attrs={"long_name": "Backscatter power", "units": "dB"},
attrs={
"long_name": self._varattrs["beam_var_default"]["backscatter_r"]["long_name"],
"units": "dB",
},
)

return backscatter_r
Expand Down Expand Up @@ -537,14 +540,20 @@ def _get_complex_dataarrays(self, zarr_path: str) -> Tuple[xr.DataArray, xr.Data
data=complex_r,
coords=array_coords,
name="backscatter_r",
attrs={"long_name": "Real part of backscatter power", "units": "V"},
attrs={
"long_name": self._varattrs["beam_var_default"]["backscatter_r"]["long_name"],
"units": "dB",
},
)

backscatter_i = xr.DataArray(
data=complex_i,
coords=array_coords,
name="backscatter_i",
attrs={"long_name": "Imaginary part of backscatter power", "units": "V"},
attrs={
"long_name": self._varattrs["beam_var_default"]["backscatter_i"]["long_name"],
"units": "dB",
},
)

return backscatter_r, backscatter_i
7 changes: 6 additions & 1 deletion echopype/convert/set_groups_ek60.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -681,7 +681,12 @@ def set_beam(self) -> List[xr.Dataset]:
var_dict["backscatter_r"] = (
["ping_time", "range_sample"],
self.parser_obj.ping_data_dict["power"][ch],
{"long_name": "Backscatter power", "units": "dB"},
{
"long_name": self._varattrs["beam_var_default"]["backscatter_r"][
"long_name"
],
"units": "dB",
},
)

ds_tmp = xr.Dataset(
Expand Down
21 changes: 18 additions & 3 deletions echopype/convert/set_groups_ek80.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -724,12 +724,22 @@ def _assemble_ds_complex(self, ch):
"backscatter_r": (
["ping_time", "range_sample", "beam"],
np.real(data),
{"long_name": "Real part of backscatter power", "units": "V"},
{
"long_name": self._varattrs["beam_var_default"]["backscatter_r"][
"long_name"
],
"units": "dB",
},
),
"backscatter_i": (
["ping_time", "range_sample", "beam"],
np.imag(data),
{"long_name": "Imaginary part of backscatter power", "units": "V"},
{
"long_name": self._varattrs["beam_var_default"]["backscatter_i"][
"long_name"
],
"units": "dB",
},
),
},
coords={
Expand Down Expand Up @@ -823,7 +833,12 @@ def _assemble_ds_power(self, ch):
"backscatter_r": (
["ping_time", "range_sample"],
self.parser_obj.ping_data_dict["power"][ch],
{"long_name": "Backscatter power", "units": "dB"},
{
"long_name": self._varattrs["beam_var_default"]["backscatter_r"][
"long_name"
],
"units": "dB",
},
),
},
coords={
Expand Down
5 changes: 5 additions & 0 deletions echopype/echodata/convention/1.0.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,11 @@ variable_and_varattributes:
long_name: Along-range sample number, base 0
beam:
long_name: Beam name
beam_var_default:
backscatter_r:
long_name: Raw backscatter measurements (real part)
backscatter_i:
long_name: Raw backscatter measurements (imaginary part)
platform_coord_default:
time1:
axis: T
Expand Down