GA Contributing Hub Layer and File Name Convention
Layer name convention
Display names for AusSeabed layers on the AusSeabed Marine Data Portal
{Mandatory} | ({Conditional}) | [{Optional}]
{Location} {Product Type} {Publication Date} {Resolution} ({Organisation if not GA}) [{Identifier}]
Element | Value |
Location | Name of survey feature (AMP/ Geomorphic Unit/Sea/Transit) CSIRO preference to have survey ID 1- If survey is in an Australian Marine Park, use this name, if not 2- If the survey is near a geomorphic unit based on the Gazetteer (https://placenames.fsdf.org.au/) /Gebco, use this name 3- If covering an area that isn’t defined by above, but a Sea/Ocean, use this name. 4- Otherwise, if it is a transit, include Transit in title (after Location/Survey ID) |
Product Type | Bathymetry (for extension to Backscatter) |
Publication Date | Year of publication (with publication style referencing when multiple publications in the same year) |
Resolution -Horizontal | 1m (with metric unit name attached) |
Organisation (Conditional) | For organisations other than Geoscience Australia use a short name (e.g. CSIRO, SOI) |
Identifier (Optional) | For non-GA records, an identifier that is used in other catalogues |
Transit: to include in title, have a separate tab for Transit
Examples:
Beagle Commonwealth Marine Reserve Bathymetry 2018 1m
Element | Value |
Location | Beagle Commonwealth Marine Reserve |
Product Type | Bathymetry |
Publication Date | 2018 |
Resolution | 1m |
Organisation | GA |
Identifier | N/A |
Boags Marine Reserve Bathymetry 2018 1m (CSIRO) bf2018_v01
Element | Value |
Location | Boags Marine Reserve |
Product Type | Bathymetry |
Publication Date | 2018 |
Resolution | 1m |
Organisation | CSIRO |
Identifier | bf2018_v01 |
Name of the layer: name of the survey/file name rather than grouped layer
File name convention
Individual AusSeabed Data Hubs may have limitations on their capacity to define file names (i.e. because of integration with other systems). However, where they do have capacity to define names, the following convention may be useful:
{Location}_{Product Type}_{Survey Date}_{Resolution}_[{Identifier}]_{Vertical Datum}_{Horizontal Datum}_[{Version Identifier}].{Format Extension}
We would want to replace any special characters with _, and version information could simply be the date in an appropriate text format, Lower case characters used for survey identifiers, with a file name character limit of 255.
Element | Value |
Location | Name of survey feature External contributing hubs (CSIRO to use Survey ID e.g. in2019_e01) GA (GA survey number e.g. GA) |
Product Type | Bathymetry (for extension to Backscatter) |
Survey Date | Year of survey (with publication style referencing when multiple publications in the same year) (e.g. 2020, for derived products like compilations, publication date is used) |
Resolution (Horizontal) | 1m (with metric unit name attached) |
Identifier (Optional) | For GA records, an identifier that is used in other catalogues (other survey ID’s e.g. FK201122) For non-GA records, an identifier that is used in other catalogues (other survey ID’s e.g. FK201122 or an alternative code to denote Instrument and/or Algorithm used CUBE, EM122) |
Vertical Datum | ‘MSL’, ‘LAT’, ‘EGM2008’ |
Horizontal Datum | EPSG4326 (Lat/Long WGS 84) |
Version Identifier | An appropriate mechanism for distinguishing between versions. At GA, the plan is to use a date timestamp in ISO format – universal time without separators. |
Format Extension | A standard string defining the format of the product – e.g. “_cog.tif” [AM1] for cloud optimised geotiff. “ov.tif” – overlay “hs.tif” - Hillshade |
GA Example: Prefix with GAID (GA-4867)
GA4867_SouthernGreatBarrierReefShelf_Bathymetry_2020_64m_EGM2008__20200827T053422Z_cog.tif
Element | Value |
Location | Southern Great Barrier Reef Shelf |
Product Type | Bathymetry |
Survey Date | 2020 |
Resolution | 64m |
Identifier | N/A |
Vertical Datum | EGM2008 |
Horizontal Datum | EPSG4326 |
Version Identifier | 20200827T053422Z - The product generated at Thu Aug 27 2020 15:34:22 GMT+1000 (Australian Eastern Standard Time). |
Format Extension | _cog.tif |
CSIRO example: Prefix with SurveyNameID (In2019_e01)
In2019_t03_IndianOceanTransit_Bathymetry_2019_12m_EM122_CUBE_EGM2008_EPSG4326_20201214T052921Z_cog.tiff
Annex Background Discussion
Essentially, I think we need to agree and document:
a) The name that we expect for display purposes on the portal
b) File naming conventions for output products that can be downloaded
Have a read below. I will set up a meeting to discuss. Let me know who needs to be involved.
-------------------------------
A) On the portal we currently have:
Apollo Bay Bathymetry 2020 2m
CSIRO_L3_bf2018_v01_Boags_1m_AHD
Visioning the Coral Sea Bathymetry 2020 64m
As well as compilations:
Antarctic REMA Hillshade Z5 and Bathymetry - (SCAR)
Australian Bathymetry and Topography 2009 250 m
General Bathymetric Chart of the Oceans (GEBCO) 2019 15 arc seconds
And in elevations:
New South Wales - Contours - (GSNSW)
The current elements are:
Element | Present | Example(s) |
Location | All | Apollo Bay, Boags, Antarctic REMA |
Organisation | When not GA | CSIRO_ (GEBCO), (GSNSW) |
Product Type / Processing Level | Most | L3, Bathymetry |
Publication Date | GA | 2020 |
Voyage Date | CSIRO | 2018 |
Voyage Type and Id | CSIRO | v01 – voyage; t01 – transit; e01 – training/calibration |
Vessel Name | CSIRO | Bf |
Version Number | None |
|
Resolution | Most | 2m, 15 arc seconds |
Vertical Datum | CSIRO | AHD |
Project Title | Rare | Visioning the… |
The elements are separated by spaces or underscores, with bracketing of organisation sometimes present.
I suggest we adopt the following naming for the portal:
{Location} {Product Type} {Publication Date} {Resolution} {Vertical Datum} ({Organisation if not GA – Organisation Id})
E.g.
Apollo Bay Bathymetry 2020 2m AHD
Boags Bathymetry 2018 1m AHD (CSIRO – bf2018_v01)
Where Location is preferred to be from https://placenames.fsdf.org.au/. Product Type, Vertical Datum and Organisation are from a fixed vocabularies. Publication Date is most commonly year.
B) For filenames we currently have:
https://ecat.ga.gov.au/geonetwork/srv/eng/catalog.search#/metadata/121620 -> 12160_GEOTIF.zip
https://data.csiro.au/collections/collection/CIcsiro:46110v1#/collection/CIcsiro:46110 -> CSIRO Data Access Portal is currently unavailable due to a scheduled outage. Reason: To perform routine storage maintenance. The application is expected to be back online by Thursday, 3 September 2020 10:00:00 AEST
I suggest we adopt the following naming for files:
{Location}_{Product Type}_{Publication Date}_{Resolution}_{Projection?}_{Vertical Datum}_{Version Identifier}
Although this would be another option
{Vessel}_{Start Date of Journey}_{Voyage Number}_{Product Type}_{Resolution}_{Projection}_{Vertical Datum}_{Version Identifier}
Or we could leave it to the institution.
We would want to replace any special characters with _, and version information could simply be the date in an appropriate text format.
[AM1]MT/Josh to look into
© Commonwealth of Australia (Geoscience Australia) year of publication.
With the exception of the Commonwealth Coat of Arms and where otherwise noted, this product is provided under a Creative Commons Attribution 4.0 International Licence.