Commit e9fc9981 authored by Timm Schoening's avatar Timm Schoening
Browse files

Update MareHub_AGVI_iFDO-core.md

parent bc295f3b
......@@ -2,12 +2,12 @@
Marine image data collections need a core set of standardized metadata for FAIR and open publication. An entire image set (e.g. deployment) requires header information on the ownership and allowed usage of the collection. Numerical metadata is required for each image on its acquisition position. It is recommended to provide further optional metadata based on the imaging use case. The following list of fields defines the required and optional keys and values that need to be provided to be in accordance with the MareHub protocol on marine imaging.
## File format
All image metadata shall be stored in one image FAIR digital object (iFDO) file. This file shall contain all iFDO sections, most importantly the header and detail fields for the image set (aka the core iFDO sections). The file should be human and machine-readable, hence *.yaml format is recommended. The file name should be: <project>_<event>_<sensor>_iFDO.yaml
All metadata fields of the core section can be part of the image-set-header subsection in case they are static (always the same value for each image). In case they do vary across the dataset, the metadata of each image may also contain this value in the image-set-items subsection, but without the "-set" term (e.g. image-acquisition-settings). The metadata for an image always supersedes the corresponding metadata for the image-set! Bold: suggested best-practice.
All image metadata shall be stored in one image FAIR digital object (iFDO) file. This file shall contain all iFDO fields, most importantly the header and detail fields for the image set (aka the core iFDO fields). The file should be human and machine-readable, hence *.yaml format is recommended. The file name should be: <project>_<event>_<sensor>_iFDO.yaml
All core metadata fields can be part of the image-set-header part in case they are static (always the same value for each image). In case they do vary across the dataset, the metadata of each image may also contain this value in the image-set-items part, but without the "-set" term (e.g. image-acquisition-settings). The metadata for an image always supersedes the corresponding metadata for the image-set! Bold: suggested best-practice.
# iFDO core section fields:
# iFDO core fields:
## Header information in the image-set-header subsection
## Header information in the image-set-header part
| Field | Format / Values / Unit | Comment |
| ----- | ---------------------- | ------- |
......@@ -30,7 +30,7 @@ All metadata fields of the core section can be part of the image-set-header subs
| image-set-type | String | Video, Photo, Microscopy, ... |
| image-set-coordinate-uncertainty | Float [m] | Average/static uncertainty of coordinates in this dataset, given in meters |
## Image item information in the image-set-items subsection (frequency: per image or per second of video):
## Image item information in the image-set-items part (frequency: per image or per second of video):
| Field | Format / Values / Unit | Comment |
| ----- | ---------------------- | ------- |
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment