GRIB2: PDT selection for probability forecasts

Author: shahramn

definitions/grib2/section.1.def

@@ -105,6 +105,8 @@ meta is_chemical_srcsink g2_chemical(productDefinitionTemplateNumber, stepType,
 meta is_aerosol          g2_aerosol(productDefinitionTemplateNumber, stepType, 0);
 meta is_aerosol_optical  g2_aerosol(productDefinitionTemplateNumber, stepType, 1);
 
+meta is_probability_fcst g2_probability(productDefinitionTemplateNumber, stepType);
+
 transient setCalendarId = 0 ;
 transient deleteCalendarId = 0 ;
 alias calendarIdPresent = false;

src/eccodes/CMakeLists.txt

@@ -273,6 +273,7 @@ list( APPEND eccodes_src_files
     accessor/DataRunLengthPacking.cc
     accessor/GridSpec.cc
     accessor/G2ParamConceptFilename.cc
+    accessor/G2Probability.cc
 
     grib_jasper_encoding.cc
     grib_openjpeg_encoding.cc

src/eccodes/accessor/Concept.cc

@@ -242,8 +242,7 @@ static int rectify_concept_apply(grib_handle* h, const char* key)
         { "constituentType",                   { "is_chemical", 1 }                       },
         { "sourceSinkChemicalPhysicalProcess", { "is_chemical_srcsink", 1 }               },
         { "randomFieldNumber",                 { "productDefinitionTemplateNumber", 143 } },
-        // TODO(masn): Add a new key e.g. is_probability_forecast
-        { "probabilityType",                   { "productDefinitionTemplateNumber", 5 }   }
+        { "probabilityType",                   { "is_probability_fcst", 1 }   }
     };
     const auto mapIter = keyMap.find(key);
     if (mapIter != keyMap.end()) {

src/eccodes/accessor/G2Probability.cc

@@ -0,0 +1,79 @@
+/*
+ * (C) Copyright 2005- ECMWF.
+ *
+ * This software is licensed under the terms of the Apache Licence Version 2.0
+ * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * In applying this licence, ECMWF does not waive the privileges and immunities granted to it by
+ * virtue of its status as an intergovernmental organisation nor does it submit to any jurisdiction.
+ */
+
+#include "G2Probability.h"
+
+eccodes::accessor::G2Probability _grib_accessor_g2_probability;
+eccodes::Accessor* grib_accessor_g2_probability = &_grib_accessor_g2_probability;
+
+namespace eccodes::accessor
+{
+
+void G2Probability::init(const long l, grib_arguments* c)
+{
+    Unsigned::init(l, c);
+    grib_handle* hand = get_enclosing_handle();
+    int n = 0;
+
+    productDefinitionTemplateNumber_ = c->get_name(hand, n++);
+    stepType_ = c->get_name(hand, n++);
+}
+
+int G2Probability::unpack_long(long* val, size_t* len)
+{
+    long productDefinitionTemplateNumber = 0;
+    grib_get_long(get_enclosing_handle(), productDefinitionTemplateNumber_, &productDefinitionTemplateNumber);
+    *val = (productDefinitionTemplateNumber == 5 || productDefinitionTemplateNumber == 9);
+
+    return GRIB_SUCCESS;
+}
+
+int G2Probability::pack_long(const long* val, size_t* len)
+{
+    grib_handle* hand                       = get_enclosing_handle();
+    long productDefinitionTemplateNumber    = -1;
+    long productDefinitionTemplateNumberNew = -1;
+    char stepType[15] = {0,};
+    size_t slen = 15;
+    int isInstant = 0;
+    int ret = 0;
+
+    if (grib_get_long(hand, productDefinitionTemplateNumber_, &productDefinitionTemplateNumber) != GRIB_SUCCESS)
+        return GRIB_SUCCESS;
+
+    ret = grib_get_string(hand, stepType_, stepType, &slen);
+    ECCODES_ASSERT(ret == GRIB_SUCCESS);
+
+    // long eps = grib_is_defined(hand, "perturbationNumber");
+
+    if (!strcmp(stepType, "instant"))
+        isInstant = 1;
+
+    if (isInstant) {
+        productDefinitionTemplateNumberNew = 5;
+    }
+    else {
+        productDefinitionTemplateNumberNew = 9;
+    }
+
+    if (productDefinitionTemplateNumber != productDefinitionTemplateNumberNew) {
+        grib_set_long(hand, productDefinitionTemplateNumber_, productDefinitionTemplateNumberNew);
+    }
+
+    return 0;
+}
+
+int G2Probability::value_count(long* count)
+{
+    *count = 1;
+    return 0;
+}
+
+}  // namespace eccodes::accessor

src/eccodes/accessor/G2Probability.h

@@ -0,0 +1,34 @@
+/*
+ * (C) Copyright 2005- ECMWF.
+ *
+ * This software is licensed under the terms of the Apache Licence Version 2.0
+ * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * In applying this licence, ECMWF does not waive the privileges and immunities granted to it by
+ * virtue of its status as an intergovernmental organisation nor does it submit to any jurisdiction.
+ */
+
+#pragma once
+
+#include "Unsigned.h"
+
+namespace eccodes::accessor
+{
+
+class G2Probability : public Unsigned
+{
+public:
+    G2Probability() :
+        Unsigned() { class_name_ = "g2_probability"; }
+    grib_accessor* create_empty_accessor() override { return new G2Probability{}; }
+    int pack_long(const long* val, size_t* len) override;
+    int unpack_long(long* val, size_t* len) override;
+    int value_count(long*) override;
+    void init(const long, grib_arguments*) override;
+
+private:
+    const char* productDefinitionTemplateNumber_ = nullptr;
+    const char* stepType_ = nullptr;
+};
+
+}  // namespace eccodes::accessor

src/eccodes/grib_accessor_class.h

@@ -92,6 +92,7 @@ extern grib_accessor* grib_accessor_g2_concept_dir;
 extern grib_accessor* grib_accessor_g2_eps;
 extern grib_accessor* grib_accessor_g2_mars_labeling;
 extern grib_accessor* grib_accessor_g2_param_concept_filename;
+extern grib_accessor* grib_accessor_g2_probability;
 extern grib_accessor* grib_accessor_g2bitmap;
 extern grib_accessor* grib_accessor_g2bitmap_present;
 extern grib_accessor* grib_accessor_g2date;