Commit 88ed251c authored by Timm Schoening's avatar Timm Schoening
Browse files

Update MareHub_AGVI_iFDO.md

parent d21e7c9d
......@@ -2,14 +2,13 @@
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 header and detail fields for the image set. 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 can be part of the image-set block 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, 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 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.
# iFDO fields:
# iFDO core section fields:
## Header information
## Header information in the image-set-header subsection
### Required
| Field | Format / Values / Unit | Comment |
| ----- | ---------------------- | ------- |
| image-set-name | Needs to include `<project>, <event>, <sensor>` and purpose | A unique name for the image set |
......@@ -31,22 +30,8 @@ All metadata fields can be part of the image-set block in case they are static (
| image-set-type | String | Video, Photo, Microscopy, ... |
| image-set-coordinate-uncertainty | Float [m] | Average/static uncertainty of coordinates in this dataset, given in meters |
### Optional (domain-specific)
| Field | Format / Values / Unit | Comment |
| ----- | ---------------------- | ------- |
| image-set-doi | DOI | Added after publication |
| image-set-event-information | Text | general information on the event (aka station, experiment), e.g. overlap between images/frames, parameters on platform movement, reference system used for scaling images like laser points |
| image-set-reference-calibration | Text | Calibration data and information on calibration process |
| image-set-time-synchronisation | Text | Synchronisation procedure and determined time offsets between camera recording values and UTC |
| image-set-item-identification-scheme | Text | How the images file names are constructed. Should be like this `<project>_<event>_<sensor>_<date>_<time>.<ext>` |
| image-set-curation-protocol | Text | A description of the image and metadata curation steps and results |
| image-set-acquisition-settings | **yaml**/json, free keys | Camera and lens settings (e.g. f number, acquisition time) |
| image-set-camera-intrinsics | **yaml**/json, free keys | focal lengths etc. |
| image-set-camera-extrinsics | **yaml**/json, free keys | x,y,z position offsets of the camera on the deployment frame and yaw, pitch, roll offsets of the camera mounting on the frame |
## Image item information (Frequency: per image or per second of video):
## Image item information in the image-set-items subsection (frequency: per image or per second of video):
### Required
| Field | Format / Values / Unit | Comment |
| ----- | ---------------------- | ------- |
| image-uuid | UUID | UUID (**version 4 - random**) for the image file (still or moving) |
......@@ -58,15 +43,5 @@ All metadata fields can be part of the image-set block in case they are static (
| image-depth | Float [m] | Use when camera below water, then it has positive values |
| image-altitude | Float [m] | Use wenn camera above water, then it has positive values |
### Optional (domain-specific)
| Field | Format / Values / Unit | Comment |
| ----- | ---------------------- | ------- |
| image-pixel-per-millimeter | Float [px/mm^2 = MPx/m^2] | Resolution of the imagery in pixels / millimeter which is identical to megapixel / square meter |
| image-meters-above-ground | Float [m] | Distance of the camera to the seafloor |
| image-coordinate-uncertainty | Float [m] | Optional, only needed when no static value is given for the image-set |
| image-acquisition-settings | **yaml**/json, free keys | Optional, only needed when no static value is given for the image-set |
| image-camera-intrinsics | **yaml**/json, free keys | Optional, only needed when no static value is given for the image-set |
| image-camera-extrinsics | **yaml**/json, free keys | Optional, only needed when no static value is given for the image-set |
# Example:
[iFDO example](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/metadata-vocabulary-profile/-/blob/master/SO268-1_021-1_GMR_CAM-23_example-iFDO.yaml): SO268-1_021-1_GMR_CAM-23_example-iFDO.yaml
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