grdwindinversion 0.3.6__py3-none-any.whl → 0.3.8__py3-none-any.whl

grdwindinversion/config_prod_v3.yaml

@@ -0,0 +1,70 @@
+no_subdir: True
+winddir_convention: "meteorological"
+add_gradientsfeatures: False
+add_nrcs_model: False
+S1A:
+    GMF_HH_NAME: "nc_lut_gmf_cmod5n_Rhigh_hh_mouche1"
+    GMF_VV_NAME: "gmf_cmod5n"
+    GMF_VH_NAME: "gmf_s1_v2"
+    dsig_VH_NAME: "gmf_s1_v2"
+    dsig_cr_step: "nrcs"
+    apply_flattening: True
+    S1_EW_calG>20190731:
+        GMF_HH_NAME: "nc_lut_gmf_cmod5n_Rhigh_hh_mouche1"
+        GMF_VV_NAME: "gmf_cmod5n"
+        GMF_VH_NAME: "gmf_s1_v3_ew_rec"
+        dsig_VH_NAME: "dsig_wspd_s1_ew_rec_v3"
+        dsig_cr_step: "wspd"
+        apply_flattening: True
+    recalibration: False
+    ancillary: "ecmwf"
+    inc_step: 0.1
+    wspd_step: 0.1
+    phi_step: 1.0
+    resolution: "high"
+S1B:
+    GMF_HH_NAME: "nc_lut_gmf_cmod5n_Rhigh_hh_mouche1"
+    GMF_VV_NAME: "gmf_cmod5n"
+    GMF_VH_NAME: "gmf_s1_v2"
+    dsig_VH_NAME: "gmf_s1_v2"
+    dsig_cr_step: "nrcs"
+    apply_flattening: True
+    S1_EW_calG>20190731:
+        GMF_HH_NAME: "nc_lut_gmf_cmod5n_Rhigh_hh_mouche1"
+        GMF_VV_NAME: "gmf_cmod5n"
+        GMF_VH_NAME: "gmf_s1_v3_ew_rec"
+        dsig_VH_NAME: "dsig_wspd_s1_ew_rec_v3"
+        dsig_cr_step: "wspd"
+        apply_flattening: True
+    recalibration: False
+    ancillary: "ecmwf"
+    inc_step: 0.1
+    wspd_step: 0.1
+    phi_step: 1.0
+    resolution: "high"
+RS2:
+    GMF_HH_NAME: "nc_lut_gmf_cmod5n_Rhigh_hh_mouche1"
+    GMF_VV_NAME: "gmf_cmod5n"
+    GMF_VH_NAME: "gmf_rs2_v3"
+    dsig_VH_NAME: "dsig_wspd_rs2_v3"
+    dsig_cr_step: "wspd"
+    apply_flattening: False
+    recalibration: False
+    ancillary: "ecmwf"
+    inc_step: 0.1
+    wspd_step: 0.1
+    phi_step: 1.0
+    resolution: "high"
+RCM:
+    GMF_HH_NAME: "nc_lut_gmf_cmod5n_Rhigh_hh_mouche1"
+    GMF_VV_NAME: "gmf_cmod5n"
+    GMF_VH_NAME: "gmf_rcm_v3"
+    dsig_VH_NAME: "dsig_wspd_rcm_v3"
+    dsig_cr_step: "wspd"
+    apply_flattening: True
+    recalibration: False
+    ancillary: "ecmwf"
+    inc_step: 0.1
+    wspd_step: 0.1
+    phi_step: 1.0
+    resolution: "high"

grdwindinversion/inversion.py

@@ -189,7 +189,6 @@ def getAncillary(meta, ancillary_name="ecmwf"):
     """
 
     if ancillary_name == "ecmwf":
-
         logging.debug("conf: %s", getConf())
         ec01 = getConf()["ecmwf_0100_1h"]
         ec0125 = getConf()["ecmwf_0125_1h"]
@@ -282,6 +281,93 @@ def getAncillary(meta, ancillary_name="ecmwf"):
             "ancillary_name must be ecmwf/era5, got %s" % ancillary_name)
 
 
+@timing(logger=logger.debug)
+def inverse_dsig_wspd(
+    dual_pol,
+    inc,
+    sigma0,
+    sigma0_dual,
+    ancillary_wind,
+    nesz_cr,
+    dsig_cr_name,
+    model_co,
+    model_cross,
+    **kwargs,
+):
+    """
+    Invert sigma0 to retrieve wind using model (lut or gmf).
+
+    Parameters
+    ----------
+    dual_pol: bool
+        True if dualpol, False if singlepol
+    inc: xarray.DataArray
+        incidence angle
+    sigma0: xarray.DataArray
+        sigma0 to be inverted
+    sigma0_dual: xarray.DataArray
+        sigma0 to be inverted for dualpol
+    ancillary_wind=: xarray.DataArray (numpy.complex28)
+        ancillary wind
+            | (for example ecmwf winds), in **ANTENNA convention**,
+    nesz_cr: xarray.DataArray
+        noise equivalent sigma0 | flattened or not 
+    dsig_cr_name:  str
+        dsig_cr name
+    model_co: str
+        model to use for VV or HH polarization.
+    model_cross: str
+        model to use for VH or HV polarization.
+
+    Returns
+    -------
+    xarray.DataArray 
+        inverted wind in copol in ** antenna convention** .
+    xarray.DataArray 
+        inverted wind in dualpol in ** antenna convention** .
+    xarray.DataArray 
+        inverted wind in crosspol in ** antenna convention** .
+    xarray.DataArray | array
+        alpha (ponderation between co and crosspol)
+
+    See Also
+    --------
+    xsarsea documentation
+    https://cerweb.ifremer.fr/datarmor/doc_sphinx/xsarsea/
+    """
+
+    # dsig_cr_step == "wspd":
+
+    wind_co = xsarsea.windspeed.invert_from_model(
+        inc,
+        sigma0,
+        ancillary_wind=ancillary_wind,
+        model=model_co,
+        **kwargs
+    )
+
+    if dual_pol:
+
+        wind_cross = windspeed.invert_from_model(
+            inc.values,
+            sigma0_dual.values,
+            model=model_cross,
+            **kwargs,
+        )
+
+        wspd_co = np.abs(wind_co)
+        wspd_cross = np.abs(wind_cross)
+        SNR_cross = sigma0_dual.values/nesz_cr.values
+        alpha = windspeed.get_dsig_wspd(dsig_cr_name, wind_cross, SNR_cross)
+
+        wpsd_dual = alpha * wspd_co + (1 - alpha) * wspd_cross
+        wind_dual = wpsd_dual * np.exp(1j * np.angle(wind_co))
+
+        return wind_co, wind_dual, wind_cross, alpha
+
+    return wind_co, None, None, None
+
+
 @timing(logger=logger.debug)
 def inverse(
     dual_pol,
@@ -321,8 +407,12 @@ def inverse(
 
     Returns
     -------
-    xarray.DataArray or tuple
-        inverted wind in ** antenna convention** .
+    xarray.DataArray 
+        inverted wind in copol in ** antenna convention** .
+    xarray.DataArray 
+        inverted wind in dualpol in ** antenna convention** .
+    xarray.DataArray 
+        inverted wind in crosspol in ** antenna convention** .
 
     See Also
     --------
@@ -519,8 +609,15 @@ def makeL2asOwi(xr_dataset, config):
         )
 
     if config["l2_params"]["dual_pol"]:
+        if config["dsig_cr_step"] == "nrcs":
+            xr_dataset = xr_dataset.rename({
+                'dsig_cross': 'owiDsig_cross',
+            })
+        else:
+            xr_dataset = xr_dataset.rename({
+                'alpha': 'owiAlpha',
+            })
         xr_dataset = xr_dataset.rename({
-            'dsig_cross': 'owiDsig_cross',
             'winddir_cross': 'owiWindDirection_cross',
             'winddir_dual': 'owiWindDirection',
             'windspeed_cross': 'owiWindSpeed_cross',
@@ -784,6 +881,7 @@ def preprocess(
         )
 
     try:
+        logging.info(f"recalibration = {recalibration}")
         if (recalibration) & ("SENTINEL" in sensor_longname):
             logging.info(
                 f"recalibration is {recalibration} : Kersten formula is applied"
@@ -855,8 +953,23 @@ def preprocess(
         copol_gmf = "HH"
         crosspol_gmf = "VH"
 
-    model_co = config["GMF_" + copol_gmf + "_NAME"]
-    model_cross = config["GMF_" + crosspol_gmf + "_NAME"]
+    cond_aux_cal = (sensor == "S1A" or sensor == "S1B") and (
+        xsar_dataset.dataset.attrs["aux_cal"].split("_")[-1][1:9] > '20190731')
+    if cond_aux_cal and xr_dataset.attrs["swath"] == "EW" and "S1_EW_calG>20190731" in config.keys():
+        model_co = config["S1_EW_calG>20190731"]["GMF_" + copol_gmf + "_NAME"]
+        model_cross = config["S1_EW_calG>20190731"]["GMF_" +
+                                                    crosspol_gmf + "_NAME"]
+        dsig_cr_name = config["S1_EW_calG>20190731"]["dsig_" +
+                                                     crosspol_gmf + "_NAME"]
+        apply_flattening = config["S1_EW_calG>20190731"]["apply_flattening"]
+        dsig_cr_step = config["S1_EW_calG>20190731"]["dsig_cr_step"]
+
+    else:
+        model_co = config["GMF_" + copol_gmf + "_NAME"]
+        model_cross = config["GMF_" + crosspol_gmf + "_NAME"]
+        dsig_cr_name = config["dsig_" + crosspol_gmf + "_NAME"]
+        apply_flattening = config["apply_flattening"]
+        dsig_cr_step = config["dsig_cr_step"]
 
     # register paramaters in config
     config["l2_params"]["dual_pol"] = dual_pol
@@ -868,6 +981,9 @@ def preprocess(
     config["l2_params"]["model_cross"] = model_cross
     config["sensor_longname"] = sensor_longname
     config["sensor"] = sensor
+    config["dsig_cr_step"] = dsig_cr_step
+    config["dsig_cr_name"] = dsig_cr_name
+    config["apply_flattening"] = apply_flattening
 
     # need to load LUTs before inversion
     nc_luts = [x for x in [model_co, model_cross] if x.startswith("nc_lut")]
@@ -1048,35 +1164,35 @@ def preprocess(
         xr_dataset['nesz_cross_flattened'].attrs[
             "comment"] = 'nesz has been flattened using windspeed.nesz_flattening'
 
-        if config["apply_flattening"]:
+        if dsig_cr_step == "nrcs":
             # dsig
-            xr_dataset["dsig_cross"] = windspeed.get_dsig(
-                config["dsig_" + crosspol_gmf + "_NAME"],
-                xr_dataset.incidence,
-                xr_dataset["sigma0_ocean"].sel(pol=crosspol),
-                xr_dataset.nesz_cross_flattened,
-            )
+            if apply_flattening:
+                xr_dataset["dsig_cross"] = windspeed.get_dsig(
+                    dsig_cr_name,
+                    xr_dataset.incidence,
+                    xr_dataset["sigma0_ocean"].sel(pol=crosspol),
+                    xr_dataset.nesz_cross_flattened,
+                )
 
-            xr_dataset.dsig_cross.attrs["formula_used"] = config[
-                "dsig_" + crosspol_gmf + "_NAME"
-            ]
+                xr_dataset.dsig_cross.attrs["formula_used"] = config[
+                    "dsig_" + crosspol_gmf + "_NAME"
+                ]
 
-        else:
-            # dsig
-            xr_dataset["dsig_cross"] = windspeed.get_dsig(
-                config["dsig_" + crosspol_gmf + "_NAME"],
-                xr_dataset.incidence,
-                xr_dataset["sigma0_ocean"].sel(pol=crosspol),
-                xr_dataset.nesz.sel(pol=crosspol),
-            )
+            else:
+                xr_dataset["dsig_cross"] = windspeed.get_dsig(
+                    dsig_cr_name,
+                    xr_dataset.incidence,
+                    xr_dataset["sigma0_ocean"].sel(pol=crosspol),
+                    xr_dataset.nesz.sel(pol=crosspol),
+                )
 
-        xr_dataset.dsig_cross.attrs["comment"] = (
-            "variable used to ponderate copol and crosspol"
-        )
+            xr_dataset.dsig_cross.attrs["comment"] = (
+                "variable used to ponderate copol and crosspol. this ponderation is done will combining cost functions during inversion process"
+            )
 
-        xr_dataset.dsig_cross.attrs["apply_flattening"] = str(
-            config["apply_flattening"]
-        )
+            xr_dataset.dsig_cross.attrs["apply_flattening"] = str(
+                apply_flattening
+            )
 
     if (recalibration) & ("SENTINEL" in sensor_longname):
         xr_dataset.attrs["aux_cal_recal"] = xsar_dataset.datatree["recalibration"].attrs["aux_cal_new"]
@@ -1254,6 +1370,7 @@ def makeL2(
         input filename
     outdir : str
         output folder
+
     config_path : str
         configuration file path
     overwrite : bool, optional
@@ -1289,10 +1406,15 @@ def makeL2(
     dual_pol = config["l2_params"]["dual_pol"]
     ancillary_name = config["ancillary"]
     sensor_longname = config["sensor_longname"]
-
+    dsig_cr_step = config["dsig_cr_step"]
+    dsig_cr_name = config["dsig_cr_name"]
+    apply_flattening = config["apply_flattening"]
     if dual_pol:
         sigma0_ocean_cross = xr_dataset["sigma0_ocean"].sel(pol=crosspol)
-        dsig_cross = xr_dataset["dsig_cross"]
+        if dsig_cr_step == "nrcs":
+            dsig_cross = xr_dataset["dsig_cross"]
+        else:
+            dsig_cross = 0.1
     else:
         sigma0_ocean_cross = None
         dsig_cross = 0.1  # default value set in xsarsea
@@ -1312,18 +1434,50 @@ def makeL2(
     inc_check_co, inc_check_cross = check_incidence_range(
         xr_dataset["incidence"], [model_co, model_cross], **kwargs
     )
+    if dsig_cr_step == "nrcs":
+        logging.info(
+            "dsig_cr_step is nrcs : polarization are mixed at cost function step")
+        wind_co, wind_dual, windspeed_cr = inverse(
+            dual_pol,
+            inc=xr_dataset["incidence"],
+            sigma0=xr_dataset["sigma0_ocean"].sel(pol=copol),
+            sigma0_dual=sigma0_ocean_cross,
+            ancillary_wind=xr_dataset["ancillary_wind"],
+            dsig_cr=dsig_cross,
+            model_co=model_co,
+            model_cross=model_cross,
+            **kwargs,
+        )
+    elif dsig_cr_step == "wspd":
+        logging.info(
+            "dsig_cr_step is wspd : polarization are mixed at winds speed step")
+
+        if apply_flattening:
+            nesz_cross = xr_dataset["nesz_cross_flattened"]
+        else:
+            nesz_cross = xr_dataset.nesz.sel(pol=crosspol)
+
+        wind_co, wind_dual, windspeed_cr, alpha = inverse_dsig_wspd(
+            dual_pol,
+            inc=xr_dataset["incidence"],
+            sigma0=xr_dataset["sigma0_ocean"].sel(pol=copol),
+            sigma0_dual=sigma0_ocean_cross,
+            ancillary_wind=xr_dataset["ancillary_wind"],
+            nesz_cr=nesz_cross,
+            dsig_cr_name=dsig_cr_name,
+            model_co=model_co,
+            model_cross=model_cross,
+            **kwargs
+        )
+        xr_dataset["alpha"] = xr.DataArray(
+            data=alpha, dims=xr_dataset["incidence"].dims, coords=xr_dataset["incidence"].coords)
+        xr_dataset["alpha"].attrs["apply_flattening"] = str(apply_flattening)
+        xr_dataset["alpha"].attrs["comments"] = "alpha used to ponderate copol and crosspol. this ponderation is done will combining wind speeds."
+
+    else:
+        raise ValueError(
+            f"dsig_cr_step must be 'nrcs' or 'wspd', got {dsig_cr_step}")
 
-    wind_co, wind_dual, windspeed_cr = inverse(
-        dual_pol,
-        inc=xr_dataset["incidence"],
-        sigma0=xr_dataset["sigma0_ocean"].sel(pol=copol),
-        sigma0_dual=sigma0_ocean_cross,
-        ancillary_wind=xr_dataset["ancillary_wind"],
-        dsig_cr=dsig_cross,
-        model_co=model_co,
-        model_cross=model_cross,
-        **kwargs,
-    )
     # windspeed_co
     xr_dataset["windspeed_co"] = np.abs(wind_co)
     xr_dataset["windspeed_co"].attrs["units"] = "m.s⁻1"
@@ -1351,8 +1505,11 @@ def makeL2(
             % (model_co, copol, model_cross, crosspol)
         )
         xr_dataset["windspeed_dual"].attrs["standart_name"] = "wind_speed"
-        xr_dataset["windspeed_dual"].attrs["model"] = wind_dual.attrs["model"]
-        del xr_dataset["windspeed_dual"].attrs["comment"]
+        xr_dataset["windspeed_dual"].attrs["model"] = (model_co, model_cross)
+        xr_dataset["windspeed_dual"].attrs["combining_method"] = dsig_cr_step
+
+        if "comment" in xr_dataset["windspeed_dual"].attrs:
+            del xr_dataset["windspeed_dual"].attrs["comment"]
 
         xr_dataset["winddir_dual"] = transform_winddir(
             wind_dual,

{grdwindinversion-0.3.6.dist-info → grdwindinversion-0.3.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: grdwindinversion
-Version: 0.3.6
+Version: 0.3.8
 Summary: Package to perform Wind inversion from GRD Level-1 SAR images
 Author-email: Antoine Grouazel <antoine.grouazel@ifremer.fr>
 License: MIT
@@ -27,6 +27,8 @@ Requires-Dist: numpy
 Requires-Dist: scipy
 Requires-Dist: fsspec
 Requires-Dist: aiohttp
+Requires-Dist: xmlschema==3.4.3
+Dynamic: license-file
 
 
 [![Python Version](https://img.shields.io/pypi/pyversions/grdwindinversion.svg)](https://pypi.org/project/grdwindinversion/)

{grdwindinversion-0.3.6.dist-info → grdwindinversion-0.3.8.dist-info}/RECORD

@@ -5,18 +5,19 @@ grdwindinversion/config_prod_recal.yaml,sha256=74n2J4tzSx1I5vaat3ydwig1jyfDgxGTG
 grdwindinversion/config_prod_recal_streaks_nrcsmod.yaml,sha256=ob0YmzHrwkI4GLxaR9HzidYtXBrTOAlEYwPYdCK7AqA,1092
 grdwindinversion/config_prod_streaks.yaml,sha256=lJMl4qH6XYqO8ich7yW0WDQsQDrjmWThlLyx1xZy1DA,1313
 grdwindinversion/config_prod_streaks_nrcsmod.yaml,sha256=4yC4KcsC7rUumYHwhpKxM8_LDMe_Je-RIu4-9e1ayp8,1312
+grdwindinversion/config_prod_v3.yaml,sha256=J6lb8swIa7M-P4DjnTqKP1Bzp3b2XWNZp_E1FCrPGXQ,1953
 grdwindinversion/data_config.yaml,sha256=FnglUHbAtGwHWg8w86hwZt3-vo-dY8uIjxqyI1jZpv8,567
 grdwindinversion/gradientFeatures.py,sha256=NIeAJzb1zrlJPBq1th7wjEZoNJMxwqDpNHLMWP6FQN0,18198
-grdwindinversion/inversion.py,sha256=gCjuhTbLRvh_vHdx1Ut9XluuqaBPSPOgMYiGTnnrNc4,56099
+grdwindinversion/inversion.py,sha256=4AM5CUyLexHW4yX7yMspfW2osA4DTGm8I0KTWZbPiUA,61752
 grdwindinversion/load_config.py,sha256=ZPozOWt0rf2Pmyc6P2D75cE_9wKUfKfr7RUzlE3WoiY,833
 grdwindinversion/main.py,sha256=Cwmxxz-PEt53JvpTL0Jx1WKLJpWvlIXZ9xtnyGKrGHY,3254
 grdwindinversion/utils.py,sha256=2BRq_UEbKbP5yCy_0X-nV-SQFmmp4aKrFaRgrs5MqJo,4347
 grdwindinversion/utils_memory.py,sha256=NA0bvkpCTkEiqCcJuldG1XsrP40-3AQUUt3HLeoRpbY,1432
 grdwindinversion/.github/ISSUE_TEMPLATE.md,sha256=qiM_a7CCUz3fSrz3Q20Se1nwPNFS8QCc8tkwK_0DSCo,327
-grdwindinversion-0.3.6.dist-info/AUTHORS.rst,sha256=KmhW_5LBKGTIGwWEVkoTm1qx_bvdDR3yYL-1cwbDOFQ,218
-grdwindinversion-0.3.6.dist-info/LICENSE,sha256=-B8mBiTeY3J7OLuayiV1myqmc7yeijBc7s34kc8RTmg,1075
-grdwindinversion-0.3.6.dist-info/METADATA,sha256=XifamxABLa3IIQ7oyioa6ozPB3qQFDXFThmKM2TPUY0,2475
-grdwindinversion-0.3.6.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-grdwindinversion-0.3.6.dist-info/entry_points.txt,sha256=2rjvlVCy0iasRXjOz3kOIGuy2OCGQ-VTNuwuViQ6cMM,95
-grdwindinversion-0.3.6.dist-info/top_level.txt,sha256=z6lPix3QPEYOo37qq8plA2hY7S3C8MQZY81agRlksMI,17
-grdwindinversion-0.3.6.dist-info/RECORD,,
+grdwindinversion-0.3.8.dist-info/licenses/AUTHORS.rst,sha256=KmhW_5LBKGTIGwWEVkoTm1qx_bvdDR3yYL-1cwbDOFQ,218
+grdwindinversion-0.3.8.dist-info/licenses/LICENSE,sha256=-B8mBiTeY3J7OLuayiV1myqmc7yeijBc7s34kc8RTmg,1075
+grdwindinversion-0.3.8.dist-info/METADATA,sha256=Zhr0ANP7Ek5Kb5zzEBoh8cheWMmvI91EwfbclEOlens,2529
+grdwindinversion-0.3.8.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+grdwindinversion-0.3.8.dist-info/entry_points.txt,sha256=2rjvlVCy0iasRXjOz3kOIGuy2OCGQ-VTNuwuViQ6cMM,95
+grdwindinversion-0.3.8.dist-info/top_level.txt,sha256=z6lPix3QPEYOo37qq8plA2hY7S3C8MQZY81agRlksMI,17
+grdwindinversion-0.3.8.dist-info/RECORD,,

{grdwindinversion-0.3.6.dist-info → grdwindinversion-0.3.8.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.2)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any