Updates necessary to support 25km platforms for the ECDR

CHANGELOG.md

@@ -11,8 +11,7 @@
   internal infrastructure and unpublished data. It is now the responsibility of
   other programs utlizing this library to provide masks, input TBs, etc.
 * Replace `BootstrapAlgError` in `get_linfit` with a logged warning. Use default
-  slope and offset values instead of failing when there are less than 125 valid
-  pixels.
+* Separate AMSR2 and AMSRE parameter coefficient specifications.
 
 # v0.2.0
 

pm_icecon/bt/api.py

@@ -4,10 +4,10 @@
 import numpy as np
 import numpy.typing as npt
 import xarray as xr
+from pm_tb_data._types import Hemisphere
 from pm_tb_data.fetch.a2l1c_625 import get_a2l1c_625_tbs
 from pm_tb_data.fetch.amsr.au_si import get_au_si_tbs
 from pm_tb_data.fetch.amsr.util import AMSR_RESOLUTIONS
-from pm_tb_data._types import Hemisphere
 
 import pm_icecon.bt.compute_bt_ic as bt
 from pm_icecon.bt.params.ausi_amsr2 import get_amsr2_params

pm_icecon/bt/compute_bt_ic.py

@@ -9,7 +9,7 @@
 import datetime as dt
 import warnings
 from functools import reduce
-from typing import Literal, Sequence
+from typing import Sequence
 
 import numpy as np
 import numpy.typing as npt
@@ -24,7 +24,6 @@
     WeatherFilterParamsForSeason,
 )
 from pm_icecon.constants import DEFAULT_FLAG_VALUES
-from pm_icecon.errors import UnexpectedSatelliteError
 
 
 # TODO: this function very similar to `get_invalid_tbs_mask` in `compute_nt_ic`.
@@ -56,43 +55,6 @@ def _is_outofrange_tb(tb, min_tb, max_tb):
     return is_bad_tb
 
 
-def xfer_class_tbs(
-    *,
-    tb_v37: npt.NDArray,
-    tb_h37: npt.NDArray,
-    tb_v19: npt.NDArray,
-    tb_v22: npt.NDArray,
-    sat: Literal["f17", "f18"],
-) -> dict[str, npt.NDArray[np.float32]]:
-    """Transform selected CLASS (NRT) TBs for consistentcy with timeseries.
-
-    Some CLASS data should be transformed via linear regression for consistenicy
-    with other data sources (TODO: which ones exactly?)
-
-    TODO: make sure this description is...descriptive enough.
-    """
-    # NRT regressions
-    if sat == "f17":
-        tb_v37 = (1.0170066 * tb_v37) + -4.9383355
-        tb_h37 = (1.0009720 * tb_h37) + -1.3709822
-        tb_v19 = (1.0140723 * tb_v19) + -3.4705583
-        tb_v22 = (0.99652931 * tb_v22) + -0.82305684
-    elif sat == "f18":
-        tb_v37 = (1.0104497 * tb_v37) + -3.3174017
-        tb_h37 = (0.98914390 * tb_h37) + 1.2031835
-        tb_v19 = (1.0057373 * tb_v19) + -0.92638520
-        tb_v22 = (0.98793409 * tb_v22) + 1.2108198
-    else:
-        raise UnexpectedSatelliteError(f"No such tb xform: {sat}")
-
-    return {
-        "tb_v37": tb_v37,
-        "tb_h37": tb_h37,
-        "tb_v19": tb_v19,
-        "tb_v22": tb_v22,
-    }
-
-
 def get_adj_ad_line_offset(
     *,
     wtp_x: Tiepoint,

pm_icecon/bt/params/ausi_amsr2.py

@@ -175,7 +175,7 @@ def get_amsr2_params(
     return bt_params
 
 
-def get_ausi_bootstrap_params(
+def get_ausi_amsr2_bootstrap_params(
     *,
     date: dt.date,
     satellite: str,

pm_icecon/bt/params/ausi_amsre.py

@@ -0,0 +1,204 @@
+"""AMSRE Bootstrap parameters.
+
+Bootstrap parameters for use with AMSRE derived from AU_SI products
+
+For now, these parameters are copied from the AMSR2 Bootstrap parameters
+CDR.
+"""
+import datetime as dt
+from typing import cast
+
+from pm_tb_data._types import Hemisphere
+
+from pm_icecon.bt._types import Line, Tiepoint
+from pm_icecon.bt.params._types import ParamsDict
+from pm_icecon.bt.params.util import setup_bootstrap_params_dict
+from pm_icecon.config.models.bt import (
+    BootstrapParams,
+    TbSetParams,
+    WeatherFilterParams,
+    WeatherFilterParamsForSeason,
+)
+from pm_icecon.gridid import get_gridid_hemisphere
+
+GODDARD_AMSRE_NORTH_PARAMS = ParamsDict(
+    vh37_params=TbSetParams(
+        water_tie_point_set=(Tiepoint(207.2), Tiepoint(131.9)),
+        ice_tie_point_set=(Tiepoint(256.3), Tiepoint(241.2)),
+        lnline=Line(offset=-71.99, slope=1.20),
+    ),
+    v1937_params=TbSetParams(
+        water_tie_point_set=(Tiepoint(207.2), Tiepoint(182.4)),
+        ice_tie_point_set=(Tiepoint(256.3), Tiepoint(258.9)),
+        lnline=Line(offset=48.26, slope=0.8048),
+    ),
+    weather_filter_seasons=[
+        # November through April (`seas=1` in `boot_ice_amsru2_np.f`)
+        WeatherFilterParamsForSeason(
+            start_month=11,
+            end_month=4,
+            weather_filter_params=WeatherFilterParams(
+                wintrc=84.73,
+                wslope=0.5352,
+                wxlimt=18.39,
+            ),
+        ),
+        # May (`seas=2`) will get interpolated from the previous and next season
+        # June through Sept. (`seas=3`)
+        WeatherFilterParamsForSeason(
+            start_month=6,
+            end_month=9,
+            weather_filter_params=WeatherFilterParams(
+                wintrc=82.71,
+                wslope=0.5352,
+                wxlimt=23.34,
+            ),
+        ),
+        # October (`seas=4`) will get interpolated from the previous and next
+        # (first in this list) season.
+    ],
+)
+
+GODDARD_AMSRE_SOUTH_PARAMS = ParamsDict(
+    vh37_params=TbSetParams(
+        water_tie_point_set=(Tiepoint(207.6), Tiepoint(131.9)),
+        ice_tie_point_set=(Tiepoint(259.4), Tiepoint(247.3)),
+        lnline=Line(offset=-90.62, slope=1.2759),
+    ),
+    v1937_params=TbSetParams(
+        water_tie_point_set=(Tiepoint(207.6), Tiepoint(182.7)),
+        ice_tie_point_set=(Tiepoint(259.4), Tiepoint(261.6)),
+        lnline=Line(offset=62.89, slope=0.7618),
+    ),
+    weather_filter_seasons=[
+        # Just one season for the S. hemisphere.
+        WeatherFilterParamsForSeason(
+            start_month=1,
+            end_month=12,
+            weather_filter_params=WeatherFilterParams(
+                wintrc=85.13,
+                wslope=0.5379,
+                wxlimt=18.596,
+            ),
+        ),
+    ],
+)
+
+BOOTSTRAP_PARAMS_INITIAL_AMSRE_NORTH = dict(
+    bt_wtp_v37=GODDARD_AMSRE_NORTH_PARAMS["vh37_params"].water_tie_point_set[0],
+    bt_wtp_h37=GODDARD_AMSRE_NORTH_PARAMS["vh37_params"].water_tie_point_set[1],
+    bt_wtp_v19=GODDARD_AMSRE_NORTH_PARAMS["v1937_params"].water_tie_point_set[1],
+    bt_itp_v37=GODDARD_AMSRE_NORTH_PARAMS["vh37_params"].ice_tie_point_set[0],
+    bt_itp_h37=GODDARD_AMSRE_NORTH_PARAMS["vh37_params"].ice_tie_point_set[1],
+    bt_itp_v19=GODDARD_AMSRE_NORTH_PARAMS["v1937_params"].ice_tie_point_set[1],
+    vh37_lnline=GODDARD_AMSRE_NORTH_PARAMS["vh37_params"].lnline,
+    v1937_lnline=GODDARD_AMSRE_NORTH_PARAMS["v1937_params"].lnline,
+    weather_filter_seasons=[
+        # November through April (`seas=1` in `boot_ice_amsru2_np.f`)
+        WeatherFilterParamsForSeason(
+            start_month=11,
+            end_month=4,
+            weather_filter_params=WeatherFilterParams(
+                wintrc=84.73,
+                wslope=0.5352,
+                wxlimt=13.7,
+            ),
+        ),
+        # May (`seas=2`) will get interpolated from the previous and next season
+        # June through Sept. (`seas=3`)
+        WeatherFilterParamsForSeason(
+            start_month=6,
+            end_month=9,
+            weather_filter_params=WeatherFilterParams(
+                wintrc=82.71,
+                wslope=0.5352,
+                wxlimt=21.7,
+            ),
+        ),
+        # October (`seas=4`) will get interpolated from the previous and next
+        # (first in this list) season.
+    ],
+)
+
+BOOTSTRAP_PARAMS_INITIAL_AMSRE_SOUTH = dict(
+    bt_wtp_v37=GODDARD_AMSRE_SOUTH_PARAMS["vh37_params"].water_tie_point_set[0],
+    bt_wtp_h37=GODDARD_AMSRE_SOUTH_PARAMS["vh37_params"].water_tie_point_set[1],
+    bt_wtp_v19=GODDARD_AMSRE_SOUTH_PARAMS["v1937_params"].water_tie_point_set[1],
+    bt_itp_v37=GODDARD_AMSRE_SOUTH_PARAMS["vh37_params"].ice_tie_point_set[0],
+    bt_itp_h37=GODDARD_AMSRE_SOUTH_PARAMS["vh37_params"].ice_tie_point_set[1],
+    bt_itp_v19=GODDARD_AMSRE_SOUTH_PARAMS["v1937_params"].ice_tie_point_set[1],
+    vh37_lnline=GODDARD_AMSRE_SOUTH_PARAMS["vh37_params"].lnline,
+    v1937_lnline=GODDARD_AMSRE_SOUTH_PARAMS["v1937_params"].lnline,
+    weather_filter_seasons=[
+        # Just one season for the S. hemisphere.
+        WeatherFilterParamsForSeason(
+            start_month=1,
+            end_month=12,
+            weather_filter_params=WeatherFilterParams(
+                wintrc=85.13,
+                wslope=0.5379,
+                wxlimt=14.3,
+            ),
+        ),
+    ],  # noqa (ignore "not used" flake8 warning)
+)
+
+
+CDR_AMSRE_NORTH_PARAMS = GODDARD_AMSRE_NORTH_PARAMS.copy()
+_bt_north_weather_filter_seasons = BOOTSTRAP_PARAMS_INITIAL_AMSRE_NORTH[
+    "weather_filter_seasons"
+]
+_bt_north_weather_filter_seasons = cast(
+    list[WeatherFilterParamsForSeason], _bt_north_weather_filter_seasons
+)
+CDR_AMSRE_NORTH_PARAMS["weather_filter_seasons"] = _bt_north_weather_filter_seasons
+
+CDR_AMSRE_SOUTH_PARAMS = GODDARD_AMSRE_SOUTH_PARAMS.copy()
+_bt_south_weather_filter_seasons = BOOTSTRAP_PARAMS_INITIAL_AMSRE_SOUTH[
+    "weather_filter_seasons"
+]
+_bt_south_weather_filter_seasons = cast(
+    list[WeatherFilterParamsForSeason], _bt_south_weather_filter_seasons
+)
+CDR_AMSRE_SOUTH_PARAMS["weather_filter_seasons"] = _bt_south_weather_filter_seasons
+
+
+def get_amsre_params(
+    *,
+    hemisphere: Hemisphere,
+) -> BootstrapParams:
+    bt_params = BootstrapParams(
+        **(CDR_AMSRE_NORTH_PARAMS if hemisphere == "north" else CDR_AMSRE_SOUTH_PARAMS),
+    )
+
+    return bt_params
+
+
+def get_ausi_amsre_bootstrap_params(
+    *,
+    date: dt.date,
+    satellite: str,
+    gridid: str,
+) -> dict:
+    """Assign the bootstrap parameters for this date, sat, grid."""
+    hemisphere = get_gridid_hemisphere(gridid)
+    if satellite == "amsre":
+        if hemisphere == "north":
+            initial_bt_params = BOOTSTRAP_PARAMS_INITIAL_AMSRE_NORTH
+        elif hemisphere == "south":
+            initial_bt_params = BOOTSTRAP_PARAMS_INITIAL_AMSRE_SOUTH
+        else:
+            raise ValueError(
+                "Could not initialize Bootstrap params for:\n"
+                f"satellite: {satellite}\n  hemisphere: {hemisphere}"
+            )
+    else:
+        raise ValueError(
+            f"Bootstrap params not yet defined for:\n  satellite: {satellite}"
+        )
+
+    bt_params = setup_bootstrap_params_dict(
+        initial_params_dict=initial_bt_params, date=date
+    )
+
+    return bt_params