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

do not use melt_onset QA flag mask for south #173

Merged
merged 4 commits into from
Nov 7, 2024
Merged

do not use melt_onset QA flag mask for south #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4052380
do not use melt_onset QA flag mask for south
Nov 6, 2024
97539a5
fix test_monthly unit test
Nov 6, 2024
e984265
De-duplicate bitmask definition for SH
trey-stafford Nov 7, 2024
53accf2
Avoid hard-coding monthly qa range. Calculate max from bitmasks
trey-stafford Nov 7, 2024
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
86 changes: 42 additions & 44 deletions seaice_ecdr/intermediate_monthly.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ def get_daily_ds_for_month(
)

# TODO: rename. This is actually a bit mask (except the fill_value)
CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS = OrderedDict(
CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS_NORTH = OrderedDict(
{
"average_concentration_exceeds_0.15": 1,
"average_concentration_exceeds_0.30": 2,
Expand All @@ -217,6 +217,13 @@ def get_daily_ds_for_month(
}
)

CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS_SOUTH = (
CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS_NORTH.copy()
)
CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS_SOUTH.pop(
"at_least_one_day_during_month_has_melt_detected"
)


def _qa_field_has_flag(*, qa_field: xr.DataArray, flag_value: int) -> xr.DataArray:
"""Returns a boolean DataArray indicating where a flag value occurs in the given `qa_field`."""
Expand All @@ -232,8 +239,14 @@ def calc_cdr_seaice_conc_monthly_qa_flag(
*,
daily_ds_for_month: xr.Dataset,
cdr_seaice_conc_monthly: xr.DataArray,
hemisphere: Hemisphere,
) -> xr.DataArray:
"""Create `cdr_seaice_conc_monthly_qa_flag`."""
if hemisphere == "north":
qa_flag_bitmasks = CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS_NORTH
else:
qa_flag_bitmasks = CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS_SOUTH

# initialize the variable
cdr_seaice_conc_monthly_qa_flag = xr.full_like(
cdr_seaice_conc_monthly,
Expand All @@ -246,18 +259,14 @@ def calc_cdr_seaice_conc_monthly_qa_flag(
cdr_seaice_conc_monthly_qa_flag = cdr_seaice_conc_monthly_qa_flag.where(
~average_exceeds_15,
cdr_seaice_conc_monthly_qa_flag
+ CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS[
"average_concentration_exceeds_0.15"
],
+ qa_flag_bitmasks["average_concentration_exceeds_0.15"],
)

average_exceeds_30 = cdr_seaice_conc_monthly > 0.30
cdr_seaice_conc_monthly_qa_flag = cdr_seaice_conc_monthly_qa_flag.where(
~average_exceeds_30,
cdr_seaice_conc_monthly_qa_flag
+ CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS[
"average_concentration_exceeds_0.30"
],
+ qa_flag_bitmasks["average_concentration_exceeds_0.30"],
)

days_in_ds = len(daily_ds_for_month.time)
Expand All @@ -269,9 +278,7 @@ def calc_cdr_seaice_conc_monthly_qa_flag(
cdr_seaice_conc_monthly_qa_flag = cdr_seaice_conc_monthly_qa_flag.where(
~at_least_half_have_sic_gt_15,
cdr_seaice_conc_monthly_qa_flag
+ CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS[
"at_least_half_the_days_have_sea_ice_conc_exceeds_0.15"
],
+ qa_flag_bitmasks["at_least_half_the_days_have_sea_ice_conc_exceeds_0.15"],
)

at_least_half_have_sic_gt_30 = (daily_ds_for_month.cdr_seaice_conc > 0.30).sum(
Expand All @@ -280,9 +287,7 @@ def calc_cdr_seaice_conc_monthly_qa_flag(
cdr_seaice_conc_monthly_qa_flag = cdr_seaice_conc_monthly_qa_flag.where(
~at_least_half_have_sic_gt_30,
cdr_seaice_conc_monthly_qa_flag
+ CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS[
"at_least_half_the_days_have_sea_ice_conc_exceeds_0.30"
],
+ qa_flag_bitmasks["at_least_half_the_days_have_sea_ice_conc_exceeds_0.30"],
)

# Use "invalid_ice_mask_applied", which is actually the invalid ice mask.
Expand All @@ -292,8 +297,7 @@ def calc_cdr_seaice_conc_monthly_qa_flag(
).any(dim="time")
cdr_seaice_conc_monthly_qa_flag = cdr_seaice_conc_monthly_qa_flag.where(
~invalid_ice_mask_applied,
cdr_seaice_conc_monthly_qa_flag
+ CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS["invalid_ice_mask_applied"],
cdr_seaice_conc_monthly_qa_flag + qa_flag_bitmasks["invalid_ice_mask_applied"],
)

at_least_one_day_during_month_has_spatial_interpolation = _qa_field_has_flag(
Expand All @@ -305,9 +309,7 @@ def calc_cdr_seaice_conc_monthly_qa_flag(
cdr_seaice_conc_monthly_qa_flag = cdr_seaice_conc_monthly_qa_flag.where(
~at_least_one_day_during_month_has_spatial_interpolation,
cdr_seaice_conc_monthly_qa_flag
+ CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS[
"at_least_one_day_during_month_has_spatial_interpolation"
],
+ qa_flag_bitmasks["at_least_one_day_during_month_has_spatial_interpolation"],
)

at_least_one_day_during_month_has_temporal_interpolation = _qa_field_has_flag(
Expand All @@ -319,34 +321,29 @@ def calc_cdr_seaice_conc_monthly_qa_flag(
cdr_seaice_conc_monthly_qa_flag = cdr_seaice_conc_monthly_qa_flag.where(
~at_least_one_day_during_month_has_temporal_interpolation,
cdr_seaice_conc_monthly_qa_flag
+ CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS[
"at_least_one_day_during_month_has_temporal_interpolation"
],
)
+ qa_flag_bitmasks["at_least_one_day_during_month_has_temporal_interpolation"],
)

if hemisphere == "north":
at_least_one_day_during_month_has_melt_detected = _qa_field_has_flag(
qa_field=daily_ds_for_month.cdr_seaice_conc_qa_flag,
flag_value=CDR_SEAICE_CONC_QA_FLAG_DAILY_BITMASKS["start_of_melt_detected"],
).any(dim="time")
cdr_seaice_conc_monthly_qa_flag = cdr_seaice_conc_monthly_qa_flag.where(
~at_least_one_day_during_month_has_melt_detected,
cdr_seaice_conc_monthly_qa_flag
+ qa_flag_bitmasks["at_least_one_day_during_month_has_melt_detected"],
)

at_least_one_day_during_month_has_melt_detected = _qa_field_has_flag(
qa_field=daily_ds_for_month.cdr_seaice_conc_qa_flag,
flag_value=CDR_SEAICE_CONC_QA_FLAG_DAILY_BITMASKS["start_of_melt_detected"],
).any(dim="time")
cdr_seaice_conc_monthly_qa_flag = cdr_seaice_conc_monthly_qa_flag.where(
~at_least_one_day_during_month_has_melt_detected,
cdr_seaice_conc_monthly_qa_flag
+ CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS[
"at_least_one_day_during_month_has_melt_detected"
],
)
monthly_qa_values = [np.uint8(value) for value in qa_flag_bitmasks.values()]

cdr_seaice_conc_monthly_qa_flag = cdr_seaice_conc_monthly_qa_flag.assign_attrs(
long_name="NOAA/NSIDC CDR of Passive Microwave Monthly Northern Hemisphere Sea Ice Concentration QA flags",
standard_name="status_flag",
flag_meanings=" ".join(
k for k in CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS.keys()
),
flag_masks=[
np.uint8(v) for v in CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS.values()
],
flag_meanings=" ".join(k for k in qa_flag_bitmasks.keys()),
flag_masks=monthly_qa_values,
grid_mapping="crs",
valid_range=(np.uint8(0), np.uint8(255)),
valid_range=(np.uint8(0), np.uint8(sum(monthly_qa_values))),
)

cdr_seaice_conc_monthly_qa_flag.encoding = dict(
Expand Down Expand Up @@ -612,6 +609,7 @@ def make_intermediate_monthly_ds(
cdr_seaice_conc_monthly_qa_flag = calc_cdr_seaice_conc_monthly_qa_flag(
daily_ds_for_month=daily_ds_for_month,
cdr_seaice_conc_monthly=cdr_seaice_conc_monthly,
hemisphere=hemisphere,
)

# Set stdev to invalid and QA to all-missing if this is an empty month
Expand Down Expand Up @@ -663,10 +661,10 @@ def make_intermediate_monthly_ds(
temporality="monthly",
aggregate=False,
source=", ".join([fp.item().name for fp in daily_ds_for_month.filepaths]),
# TODO: consider providing all platforms that went into month? This would be
# consistent with how we handle the aggregate filenames. Is it
# misleading to indicate that a month is a single platform when it may not
# really be?
# TODO: consider providing all platforms that went into month?
# This would be consistent with how we handle the aggregate filenames.
# Is it misleading to indicate that a month is a single platform
# when it may not really be?
platform_ids=[platform_id],
resolution=resolution,
hemisphere=hemisphere,
Expand Down
6 changes: 5 additions & 1 deletion seaice_ecdr/tests/unit/test_monthly.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
from seaice_ecdr.constants import ECDR_PRODUCT_VERSION
from seaice_ecdr.intermediate_daily import get_ecdr_dir
from seaice_ecdr.intermediate_monthly import (
CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS,
CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS_NORTH,
CDR_SEAICE_CONC_QA_FLAG_DAILY_BITMASKS,
_get_daily_complete_filepaths_for_month,
_platform_id_for_month,
Expand Down Expand Up @@ -301,6 +301,9 @@ def _mock_daily_ds_for_month():

def test_calc_cdr_seaice_conc_monthly_qa_flag():
_mock_daily_ds = _mock_daily_ds_for_month()
CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS = (
CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS_NORTH
)
expected_flags = np.array(
[
CDR_SEAICE_CONC_MONTHLY_QA_FLAG_BITMASKS[
Expand Down Expand Up @@ -357,6 +360,7 @@ def test_calc_cdr_seaice_conc_monthly_qa_flag():
actual = calc_cdr_seaice_conc_monthly_qa_flag(
daily_ds_for_month=_mock_daily_ds,
cdr_seaice_conc_monthly=_mean_daily_conc,
hemisphere="north",
)

nptesting.assert_array_equal(expected_flags, actual.values)
Expand Down