extract bounding box from NetCDF/HDF5 files and insert into the geospatial metadata block #9541

pdurbin · 2023-04-19T20:58:47Z

insert the bounding box into the geospatial metadata block

What this PR does / why we need it:

Prevent users from having to manually enter bounding box values. As with FITS, we get the values from the files themselves.

Which issue(s) this PR closes:

Closes Extracting lat/long and insert into geospatial bounding box fields #9331

Special notes for your reviewer:

~~I tried pretty hard to get the compound field code working but ended up switching to something that works, jsonParser.parseField which is also used by the native API.~~ I switched it back in 189c774.

If the longitude "domain" is 0 to 360 instead of -180 to 180, we convert it. See also this issue:

Lon and lat ranges (max of 180 vs 360 deg) in geospatial data cf-convention/cf-conventions#435

Suggestions on how to test this:

Upload various NetCDF files, especially ones that have a bounding box. Here's a nice small one with a bounding box that the code tests: https://www.ncei.noaa.gov/data/international-comprehensive-ocean-atmosphere/v3/archive/nrt/ICOADS_R3.0.0_1662-10.nc

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Not really. The bounding box is populated. Here's what it looks like when you are just looking at (not editing) a dataset:

It seems a little weird that we don't show any labels (north, south, east, west). There's an open issue for this at #6589 but it's out of scope.

The values look more reasonable when you are editing:

Update: this seems like an easy fix so I made a PR:

add displayFormat (NAME) to bounding box #9593 #9595

Is there a release notes update needed for this change?:

Yes, included.

Additional documentation:

Included. I updated the User Guide.

insert the bounding box into the geospatial metadata block

pdurbin · 2023-05-01T18:57:54Z

I've been saying at standup that I need to tweak something for S3 but I was wrong. S3 works fine so in f5be4a8 I removed the FIXME and replaced it with some details.

I'll note that @JR-1991 @atrisovic and I are still discussing a bit the getStandardLongitude method in this PR. I'm happy to discus this more with a reviewer. Here's an awesome diagram Jan made and posted:

I'm putting this in "ready for review".

sekmiller · 2023-05-02T20:57:28Z

.../iq/dataverse/ingest/metadataextraction/impl/plugins/netcdf/NetcdfFileMetadataExtractor.java

+            return null;
+        }
+        if (westAsFloat > 180 || eastAsFloat > 180) {
+            Float westStandard = westAsFloat - 360;


I think that if we're converting 0-360 to -180-180 then we need to subtract just 180 from the given value, not 360.

@sekmiller I was also puzzled with this at the beginning, but subtracting 360° is the correct procedure. The math only tells half the truth, because the prime meridian (0° longitude) needs to stay at Greenwich and thus the interval's "cycle point" where both ends meet changes by 180°. Thus, this has to be attributed for, which leads to the 360°.

That's how I understood it so far, but this illustration may explain it better:

@JR-1991 thanks! Even with that explanation, it's hard to keep straight in my head.

I was relying on a tool to check that maps are the same. That is these two URLs (minus 360) show the same map:

https://linestrings.com/bbox/#343.68,41.8,353.78,49.62

https://linestrings.com/bbox/#-16.320007,41.8,-6.220001,49.62

Here's a screenshot of the maps (and a bit more commentary) I originally posted at https://dataverse.zulipchat.com/#narrow/stream/376593-geospatial/topic/extract.20lat.2Flong.20.239331/near/348542658

@JR-1991 OK. Looking at the globe and the example location makes sense when the value is between 180 and 360, but what the code does here is if the value for either is over 180 it subtracts 360 from both so there is a potential for a situation where one val is > 180 and the other is less and in that case, say 170, and subtracting 360 results in -190 which is off the scale below -180.

@sekmiller thanks for the review! Indeed subtracting from both would lead to a failure. I tested it visually and in the case of $\theta_1 = [280°, 170°]$ the result should translate to $\theta_2 = [-80°, 170°]$ - Hence if a degree is under 180 it should not be subtracted. I have updated the illustration:

I understand it in this way, that within this domain transformation only one half of the circle is changing. Note, in 0° - 360° domain the first half is the same as in the domain of (-180°) - 180° and thus there is a 1:1 relation if degrees are within 0-180. Yet, the other half does change to another range in a more drastic way. Tipping over 180° by a degree suddenly leads you to -179° which in the other domain corresponds to 181° - Hence the 360° provides a valid transformation for this case.

It's quite complicated though 😅

Maybe I should add to the figure, that $f(\theta)$ is defined for $\theta \in [0°, 360°]$ and if $\theta < 0°$ its already in the desired domain.

I tried to address all this in 690b8a4 just now and left this comment about it: #9541 (comment)

Maybe I should have resolve other conversation and gotten it down to just this one. Oh well. Please see the other comment.

I read through the thread and agree with the comments! Instead of the lines 154-182, we can check each coordinate by itself and it would work well, ie:

Float westStandard = westAsFloat; Float eastStandard = eastAsFloat; if (westAsFloat > 180) { westStandard = westAsFloat - 360; } if (eastAsFloat > 180){ eastStandard = eastAsFloat - 360; } WestAndEastLongitude updatedWeLong = new WestAndEastLongitude(westStandard.toString(), eastStandard.toString()); return updatedWeLong;

sekmiller · 2023-05-03T14:05:15Z

...dataverse/ingest/metadataextraction/impl/plugins/netcdf/NetcdfFileMetadataExtractorTest.java

+        assertEquals(new WestAndEastLongitude("-16.320007", "-6.220001"), extractor.getStandardLongitude(new WestAndEastLongitude("343.68", "353.78")));
+        // One is over 180. Change
+        assertEquals(new WestAndEastLongitude("-260.0", "-179.0"), extractor.getStandardLongitude(new WestAndEastLongitude("100", "181")));
+        // Both are under 180. No change.


@JR-1991 it seems to me that the test above should fail as the result of -260 is outside the range of -180 - 180.

Yes, I agree. I'll ping Jan for some input on this.

@pdurbin just for clarification, the right hand-side extractor transforms by subtracting 360° from both?

If so, then I have to agree, this test should fail and truly evaluate to $[100°, -179°]$ due to the above comment and that there can't be -260° since the domain has it's lower bound at -180°.

Given the proposed change in the calculation, the test should look like this:

assertEquals( new WestAndEastLongitude("100.0", "-179.0"), extractor.getStandardLongitude(new WestAndEastLongitude("100", "181")) );

What do you think?

I think it's late on a Friday but I powered through and pushed some fixes around longitude at 2edb351.

Almost as importantly, I added docs! Rules in the User Guide about how users (and QA) should expect the code to behave. I'd love to hear what you (@JR-1991) and @atrisovic and @sekmiller (whom I've been bugging all day) think! Here they are:

West Longitude and East Longitude are expected to be in the range of -180 and 180. (When using :ref:geospatial-search, you should use this range for longitude.)

If West Longitude and East Longitude are both over 180 (outside the expected -180:180 range), 360 will be subtracted to shift the values from the 0:360 range to the expected -180:180 range.

If either West Longitude or East Longitude are less than zero but the other latitude is greater than 180 (which would imply an indeterminate domain, a lack of clarity of if the domain is -180:180 or 0:360), metadata will be not be extracted.

I also added more tests. I'm happy to add more if you all think of more edge cases. I don't have real NetCDF files to test with that have wacky values. It might be a challenge for QA to find NetCDF files to exercise all the rules.

It seems to be working! \o/

pdurbin · 2023-05-04T21:23:15Z

src/main/java/edu/harvard/iq/dataverse/ingest/IngestServiceBean.java

@@ -1531,72 +1654,71 @@ private void processDatasetMetadata(FileMetadataIngest fileMetadataIngest, Datas
                        // create a new compound field value and its child 
                        // 
                        DatasetFieldCompoundValue compoundDsfv = new DatasetFieldCompoundValue();
-                        int nonEmptyFields = 0; 


This whitespace change and below is from me removing this code and then (just) re-adding it because it seems to be working afterall! My test still passes at least. 😅

coveralls · 2023-05-05T21:17:55Z

Coverage: 20.221% (+0.08%) from 20.146% when pulling 690b8a4 on 9331-extract-bounding-box2 into c07f3a8 on develop.

pdurbin · 2023-05-05T21:25:45Z

I'm ready for more review so I'm removing myself from this PR. Here are the changes since the last round:

1fb2798 add API test for FITS file metadata extraction #9331
189c774 restore original "extract from compound" code #9331
2edb351 document and fix up the rules for longitude, add tests #9331

Yes, I was convince the code to extract from compound fields wasn't working. I put it back and now it works! Well, it was always working, I suppose. Now I'm feeding it the data it expects!

sekmiller

Looks good. thanks for the changes

atrisovic · 2023-05-08T18:22:22Z

.../iq/dataverse/ingest/metadataextraction/impl/plugins/netcdf/NetcdfFileMetadataExtractor.java

+            return null;
+        }
+        if (westAsFloat > 180 || eastAsFloat > 180) {
+            Float westStandard = westAsFloat - 360;


I read through the thread and agree with the comments! Instead of the lines 154-182, we can check each coordinate by itself and it would work well, ie:

Float westStandard = westAsFloat; Float eastStandard = eastAsFloat; if (westAsFloat > 180) { westStandard = westAsFloat - 360; } if (eastAsFloat > 180){ eastStandard = eastAsFloat - 360; } WestAndEastLongitude updatedWeLong = new WestAndEastLongitude(westStandard.toString(), eastStandard.toString()); return updatedWeLong;

kcondon · 2023-05-09T15:42:50Z

Issues found:

Preview for netcdf file shows permissions issue:

Removing a netcdf file with bounding box does not remove the bounding box info from dataset metadata. [Kevin] I'm told this is unsupported so maybe a note as discussed that extraction is "add only".
Not sure whether all files with spatial data can be extracted https://thredds.daac.ornl.gov/thredds/catalog/ornldaac/2129/tiles/1950/9597_1950/catalog.html?dataset=2129t/1950/9597_1950/dayl.nc , https://git.earthdata.nasa.gov/projects/LPDUR/repos/appeears-tutorials/raw/MCD12Q1.006_500m_aid0001.nc?at=refs%2Fheads%2Fmain&_ga=2.149397558.1682554425.1683648699-1018054437.1683648699 , https://data.isimip.org/files/cbe2b84e-4984-4f6b-ab68-263e7e862181/ so as discussed, maybe add a note about which fields we look for: geospatial_lon_min
geospatial_lon_max
geospatial_lat_max
geospatial_lat_min

pdurbin · 2023-05-09T18:19:02Z

Preview for netcdf file shows permissions issue:

Sadly, this is a known issue. It's in "sprint ready", at least:

NcML previewer doesn't work with drafts #9416

The fix will need to happen over in the previewers repo so there's an issue to track it there:

NcML previewer doesn't work with drafts gdcc/dataverse-previewers#25

github-actions · 2023-05-09T18:40:59Z

📦 Pushed preview application image as

ghcr.io/gdcc/dataverse:9331-extract-bounding-box2

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.

ErykKul · 2023-05-19T10:02:19Z

src/main/java/edu/harvard/iq/dataverse/ingest/IngestServiceBean.java

@@ -367,7 +369,20 @@ public List<DataFile> saveAndAddFilesToDataset(DatasetVersion version,
 						} else {
 							logger.fine("Failed to extract indexable metadata from file " + fileName);
 						}
-					} else if (FileUtil.MIME_TYPE_INGESTED_FILE.equals(dataFile.getContentType())) {
+                                        } else if (fileMetadataExtractableFromNetcdf(dataFile, tempLocationPath)) {


This breaks direct uploads for me. When using a direct upload, the file is unattached and the owner is set to 'null' on line 336. However, 'fileMetadataExtractableFromNetcdf' needs the owner dataset to determine the folder inside storageIO.open();. This results in a NullPointerException, preventing adding the files to the dataset. I have only tested with the local filesystem, but from looking at the code, this probably also breaks uploading files directly to S3. Can you investigate and fix it? Thanks.

@ErykKul yikes! This has already been merged. 😬 Could you please create an issue about this?

I've reproduced this in develop: direct file upload via UI appears to upload correctly, ie the progress bar completes and the file is present in the uploaded file list but fails on save with a grayed out screen as if waiting for a completion signal and a server log error:
diredct_upload_ui_err.txt

Note that direct file upload continues to work via API. Also, deleting the file continues to work via ui.

I can reproduce it too. I created an issue:

fileMetadataExtractableFromNetcdf causing regression for S3 direct upload #9601

Thanks, both!

extract bounding box from netcdf/hdf5 files #9331

de0c421

insert the bounding box into the geospatial metadata block

This was referenced Apr 19, 2023

extract bounding box from netcdf/hdf5 files and insert into the geospatial metadata block #9523

Closed

Add validation for entered coordinate values in Geospatial metadata (bounding boxes, etc) #9547

Closed

pdurbin added 2 commits April 24, 2023 16:19

improve getStandardLongitude method #9331

1ee2ea7

enable geospatial block in test #9331

09490f0

mreekie added the Size: 3 A percentage of a sprint. 2.1 hours. label Apr 26, 2023

mreekie assigned pdurbin Apr 26, 2023

JR-1991 mentioned this pull request Apr 27, 2023

Add NetCDF data extraction and mapping gdcc/easyDataverse#12

Closed

pdurbin added 2 commits May 1, 2023 14:52

confirm that it works on S3, leave note #9331

f5be4a8

Merge branch 'develop' into 9331-extract-bounding-box2 #9331

27e60ef

pdurbin removed their assignment May 1, 2023

sekmiller self-assigned this May 2, 2023

sekmiller reviewed May 2, 2023

View reviewed changes

sekmiller reviewed May 3, 2023

View reviewed changes

pdurbin self-assigned this May 3, 2023

add API test for FITS file metadata extraction #9331

1fb2798

This comment has been minimized.

Sign in to view

restore original "extract from compound" code #9331

189c774

It seems to be working! \o/

pdurbin commented May 4, 2023

View reviewed changes

pdurbin added 2 commits May 5, 2023 17:13

document and fix up the rules for longitude, add tests #9331

2edb351

Merge branch 'develop' into 9331-extract-bounding-box2 #9331

690b8a4

pdurbin removed their assignment May 5, 2023

sekmiller approved these changes May 8, 2023

View reviewed changes

sekmiller removed their assignment May 8, 2023

pdurbin added 2 commits May 8, 2023 11:57

fix typo #9331

719439d

Merge branch 'develop' into 9331-extract-bounding-box2 #9331

ed3d4d9

This comment has been minimized.

Sign in to view

atrisovic suggested changes May 8, 2023

View reviewed changes

kcondon self-assigned this May 8, 2023

improve docs based on feedback #9331

85d4bf2

kcondon merged commit 85bde07 into develop May 9, 2023

kcondon deleted the 9331-extract-bounding-box2 branch May 9, 2023 18:58

This was referenced May 9, 2023

MCD12Q1.006_500m_aid0001.nc - NetCDF file with geospatial data IQSS/dataverse-sample-data#37

Open

dayl.nc - NetCDF file with geospatial data IQSS/dataverse-sample-data#38

Open

pdurbin added this to the 5.14 milestone May 10, 2023

ErykKul reviewed May 19, 2023

View reviewed changes

This was referenced May 19, 2023

fileMetadataExtractableFromNetcdf causing regression for S3 direct upload #9601

Closed

disable NetCDF/HDF5 metadata extraction for S3 direct upload #9609

Closed

fix S3 direct upload NPE and NetCDF/HDF5 and keep geospatial metadata extraction #9611

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

extract bounding box from NetCDF/HDF5 files and insert into the geospatial metadata block #9541

extract bounding box from NetCDF/HDF5 files and insert into the geospatial metadata block #9541

pdurbin commented Apr 19, 2023 •

edited

Loading

pdurbin commented May 1, 2023

sekmiller May 2, 2023

JR-1991 May 3, 2023 •

edited

Loading

pdurbin May 3, 2023

sekmiller May 3, 2023

JR-1991 May 5, 2023 •

edited

Loading

JR-1991 May 5, 2023

pdurbin May 5, 2023

atrisovic May 8, 2023 •

edited

Loading

sekmiller May 3, 2023

pdurbin May 4, 2023

JR-1991 May 5, 2023

pdurbin May 5, 2023

This comment has been minimized.

pdurbin May 4, 2023

coveralls commented May 5, 2023

pdurbin commented May 5, 2023

sekmiller left a comment

This comment has been minimized.

atrisovic May 8, 2023 •

edited

Loading

kcondon commented May 9, 2023 •

edited

Loading

pdurbin commented May 9, 2023

github-actions bot commented May 9, 2023

ErykKul May 19, 2023

pdurbin May 19, 2023

kcondon May 19, 2023 •

edited

Loading

pdurbin May 19, 2023

extract bounding box from NetCDF/HDF5 files and insert into the geospatial metadata block #9541

extract bounding box from NetCDF/HDF5 files and insert into the geospatial metadata block #9541

Conversation

pdurbin commented Apr 19, 2023 • edited Loading

pdurbin commented May 1, 2023

Choose a reason for hiding this comment

JR-1991 May 3, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JR-1991 May 5, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

atrisovic May 8, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment has been minimized.

Choose a reason for hiding this comment

coveralls commented May 5, 2023

pdurbin commented May 5, 2023

sekmiller left a comment

Choose a reason for hiding this comment

This comment has been minimized.

atrisovic May 8, 2023 • edited Loading

Choose a reason for hiding this comment

kcondon commented May 9, 2023 • edited Loading

pdurbin commented May 9, 2023

github-actions bot commented May 9, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kcondon May 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pdurbin commented Apr 19, 2023 •

edited

Loading

JR-1991 May 3, 2023 •

edited

Loading

JR-1991 May 5, 2023 •

edited

Loading

atrisovic May 8, 2023 •

edited

Loading

atrisovic May 8, 2023 •

edited

Loading

kcondon commented May 9, 2023 •

edited

Loading

kcondon May 19, 2023 •

edited

Loading