added era-collection global meta-field

Author: TomBlock

core/src/test/java/com/bc/fiduceo/NCTestUtils.java

@@ -20,6 +20,7 @@
 
 package com.bc.fiduceo;
 
+import com.bc.fiduceo.reader.netcdf.NetCDFReader;
 import com.bc.fiduceo.util.NetCDFUtils;
 import ucar.ma2.Array;
 import ucar.ma2.DataType;
@@ -67,7 +68,7 @@ public static void assert2DVariable(String variableName, int x, int y, double ex
         assertEquals(expected, data.getDouble(0), 1e-8);
     }
 
-    public static void assertVariablePresentAnd1DValueLong(String variableName, final DataType dataType, String dimensions, int x, long expected, NetcdfFile netcdfFile) throws IOException, InvalidRangeException {
+    public static void assertVariablePresentAnd1DValueLong(String variableName, final DataType dataType, String dimensions, int x, long expected, NetcdfFile netcdfFile) throws IOException {
         final Variable variable = assertVariablePresent(variableName, dataType, dimensions, netcdfFile);
         assert1DValueLong(x, expected, variable);
     }
@@ -156,6 +157,18 @@ public static void assertAttribute(Variable variable, String attributeName, Stri
         }
     }
 
+    public static void assertGlobalAttribute(NetcdfFile reader, String attributeName, String expected) {
+        final Attribute attribute = reader.findGlobalAttribute(attributeName);
+        assertNotNull(attribute);
+
+        final DataType dataType = attribute.getDataType();
+        if (dataType == DataType.STRING) {
+            assertEquals(expected, attribute.getStringValue());
+        } else if (dataType == DataType.FLOAT) {
+            assertEquals(Float.parseFloat(expected), attribute.getNumericValue().floatValue(), 1e-8);
+        }
+    }
+
     public static Variable getVariable(String variableName, NetcdfFile netcdfFile, boolean escapeName) {
         final String escapedName;
         if (escapeName) {

post-processing-tool/src/main/java/com/bc/fiduceo/post/plugin/era5/Configuration.java

@@ -3,6 +3,7 @@
 class Configuration {
 
     private String nwpAuxDir;
+    private String era5Collection;
 
     private SatelliteFieldsConfiguration satelliteFields;
     private MatchupFieldsConfiguration matchupFields;
@@ -15,6 +16,14 @@ void setNWPAuxDir(String nwpAuxDir) {
         this.nwpAuxDir = nwpAuxDir;
     }
 
+    String getEra5Collection() {
+        return era5Collection;
+    }
+
+    void setEra5Collection(String era5Collection) {
+        this.era5Collection = era5Collection;
+    }
+
     SatelliteFieldsConfiguration getSatelliteFields() {
         return satelliteFields;
     }

post-processing-tool/src/main/java/com/bc/fiduceo/post/plugin/era5/Era5PostProcessing.java

@@ -2,6 +2,7 @@
 
 import com.bc.fiduceo.FiduceoConstants;
 import com.bc.fiduceo.post.PostProcessing;
+import org.esa.snap.core.util.StringUtils;
 import ucar.ma2.Array;
 import ucar.ma2.Index;
 import ucar.ma2.InvalidRangeException;
@@ -141,6 +142,11 @@ protected void prepare(NetcdfFile reader, NetcdfFileWriter writer) {
             throw new RuntimeException("Expected dimension not present in file: " + FiduceoConstants.MATCHUP_COUNT);
         }
 
+        // @todo 1 tb/tb add generic prepare for global meta
+        // - ERA5 collection string
+
+        prepare(writer);
+
         final SatelliteFieldsConfiguration satFieldsConfig = configuration.getSatelliteFields();
         if (satFieldsConfig != null) {
             satelliteFields = new SatelliteFields();
@@ -154,6 +160,32 @@ protected void prepare(NetcdfFile reader, NetcdfFileWriter writer) {
         }
     }
 
+    private void prepare(NetcdfFileWriter writer) {
+        String collection = getEra5Collection(configuration);
+        writer.addGlobalAttribute("era5-collection", collection);
+    }
+
+    // package access for testing only tb 2021-01-12
+    static String getEra5Collection(Configuration configuration) {
+        String collection = configuration.getEra5Collection();
+        if (StringUtils.isNotNullAndNotEmpty(collection)) {
+            return collection;
+        }
+
+        // we need to find the collection in the path-name
+        final String nwpAuxDir = configuration.getNWPAuxDir();
+        final String upperCaseAuxDir = nwpAuxDir.toUpperCase();
+        collection = "UNKNOWN";
+        if (upperCaseAuxDir.contains("ERA5T") || upperCaseAuxDir.contains("ERA-5T")) {
+            collection = "ERA-5T";
+        } else if (upperCaseAuxDir.contains("ERA51") || upperCaseAuxDir.contains("ERA-51")) {
+            collection = "ERA-51";
+        } else if (upperCaseAuxDir.contains("ERA5") || upperCaseAuxDir.contains("ERA-5")) {
+            collection = "ERA-5";
+        }
+        return collection;
+    }
+
     @Override
     protected void compute(NetcdfFile reader, NetcdfFileWriter writer) throws IOException, InvalidRangeException {
         if (satelliteFields != null) {

post-processing-tool/src/main/java/com/bc/fiduceo/post/plugin/era5/Era5PostProcessingPlugin.java

@@ -3,6 +3,7 @@
 import com.bc.fiduceo.post.PostProcessing;
 import com.bc.fiduceo.post.PostProcessingPlugin;
 import com.bc.fiduceo.util.JDomUtils;
+import org.esa.snap.core.util.StringUtils;
 import org.jdom.Attribute;
 import org.jdom.Element;
 
@@ -14,6 +15,14 @@ static Configuration createConfiguration(Element rootElement) {
         final String nwpAuxDirValue = JDomUtils.getMandatoryChildTextTrim(rootElement, "nwp-aux-dir");
         configuration.setNWPAuxDir(nwpAuxDirValue);
 
+        final Element era5CollectionElement = rootElement.getChild("era5-collection");
+        if (era5CollectionElement != null) {
+            final String value = era5CollectionElement.getValue();
+            if (StringUtils.isNotNullAndNotEmpty(value)) {
+                configuration.setEra5Collection(value);
+            }
+        }
+
         parseSatelliteFields(rootElement, configuration);
         parseMatchupFields(rootElement, configuration);
 

post-processing-tool/src/test/java/com/bc/fiduceo/post/PostProcessingToolIntegrationTest_Era5.java

@@ -75,6 +75,8 @@ public void testAddEra5Variables() throws IOException, InvalidRangeException {
         assertTrue(targetFile.isFile());
 
         try (NetcdfFile mmd = NetcdfFiles.open(targetFile.getAbsolutePath())) {
+            NCTestUtils.assertGlobalAttribute(mmd, "era5-collection", "ERA-5");
+
             Variable variable = NCTestUtils.getVariable("amsre\\.Geostationary_Reflection_Latitude", mmd, false);
             NCTestUtils.assert3DValueDouble(0, 0, 0, 4105, variable);
             NCTestUtils.assert3DValueDouble(1, 0, 0, 4087, variable);

post-processing-tool/src/test/java/com/bc/fiduceo/post/plugin/era5/ConfigurationTest.java

@@ -16,6 +16,15 @@ public void testSetGetNWPAuxDir() {
         assertEquals(nwpAuxDir, config.getNWPAuxDir());
     }
 
+    @Test
+    public void testSetGetEra5Collection() {
+        final String collection = "the-most-recent";
+
+        final Configuration config = new Configuration();
+        config.setEra5Collection(collection);
+        assertEquals(collection, config.getEra5Collection());
+    }
+
     @Test
     public void testSetGetSatelliteFields() {
         final Configuration config = new Configuration();

post-processing-tool/src/test/java/com/bc/fiduceo/post/plugin/era5/Era5PostProcessingPluginTest.java

@@ -53,6 +53,7 @@ public void testCreateConfiguration_nwpAuxDir() throws JDOMException, IOExceptio
     public void testCreateConfiguration_satelliteFields() throws JDOMException, IOException {
         final String XML = "<era5>" +
                 "    <nwp-aux-dir>/where/the/data/is</nwp-aux-dir>" +
+                "    <era5-collection>The-One</era5-collection>" +
                 "    <satellite-fields>" +
                 "        <x_dim name='left' length='5' />" +
                 "        <y_dim name='right' length='7' />" +
@@ -80,6 +81,8 @@ public void testCreateConfiguration_satelliteFields() throws JDOMException, IOEx
         final Element rootElement = TestUtil.createDomElement(XML);
 
         final Configuration configuration = Era5PostProcessingPlugin.createConfiguration(rootElement);
+        assertEquals("The-One", configuration.getEra5Collection());
+
         final SatelliteFieldsConfiguration satConfig = configuration.getSatelliteFields();
         assertNotNull(satConfig);
 

post-processing-tool/src/test/java/com/bc/fiduceo/post/plugin/era5/Era5PostProcessingTest.java

@@ -66,4 +66,46 @@ public void testGetInterpolationContext_singlePixel() {
         assertEquals(2, era5Region.width);
         assertEquals(2, era5Region.height);
     }
+
+    @Test
+    public void testgetEra5Collection_fromConfig() {
+        final Configuration configuration = new Configuration();
+        configuration.setNWPAuxDir("/yamas/strange/path");
+        configuration.setEra5Collection("Hamasuki");
+
+        final String era5Collection = Era5PostProcessing.getEra5Collection(configuration);
+        assertEquals("Hamasuki", era5Collection);
+    }
+
+    @Test
+    public void testgetEra5Collection_fromPath_unknown() {
+        final Configuration configuration = new Configuration();
+        configuration.setNWPAuxDir("/yamas/strange/path");
+
+        final String era5Collection = Era5PostProcessing.getEra5Collection(configuration);
+        assertEquals("UNKNOWN", era5Collection);
+    }
+
+    @Test
+    public void testgetEra5Collection_fromPath() {
+        final Configuration configuration = new Configuration();
+
+        configuration.setNWPAuxDir("/data/era5");
+        assertEquals("ERA-5", Era5PostProcessing.getEra5Collection(configuration));
+
+        configuration.setNWPAuxDir("/data/era-5");
+        assertEquals("ERA-5", Era5PostProcessing.getEra5Collection(configuration));
+
+        configuration.setNWPAuxDir("/data/ERA51");
+        assertEquals("ERA-51", Era5PostProcessing.getEra5Collection(configuration));
+
+        configuration.setNWPAuxDir("/data/era-51");
+        assertEquals("ERA-51", Era5PostProcessing.getEra5Collection(configuration));
+
+        configuration.setNWPAuxDir("/data/era5t");
+        assertEquals("ERA-5T", Era5PostProcessing.getEra5Collection(configuration));
+
+        configuration.setNWPAuxDir("/data/ERA-5T");
+        assertEquals("ERA-5T", Era5PostProcessing.getEra5Collection(configuration));
+    }
 }