Commit 711e2746 authored by Timm Schoening's avatar Timm Schoening
Browse files

Update README.md

parent e3da501e
......@@ -19,21 +19,33 @@ The following wording will be used throughout the document.
All image metadata shall be stored in one FAIR digital object (FDO) 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
## Header information
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.
### Required
| Field | Format / Values / Unit | Comment |
| ----- | ---------------------- | ------- |
| image-set-name | <project>_<event>_<sensor> | A unique name for the image set |
| image-set-context | <project> | Project or expedition or cruise or experiment or ... |
| image-set-event | <event> | One event of a project or expedition or cruise or experiment or ... |
| image-set-platform | <platform> | Sensors URN or Equipment Git ID (Handle) |
| image-set-sensor | <sensor> | Sensors URN or Equipment Git ID |
| image-set-uuid | UUID4 | A UUID (recommended: version 4 - random) for the entire image set |
| image-set-name | **`project>_<event>_<sensor>`** | A unique name for the image set |
| image-set-context | `<project>` | Project or expedition or cruise or experiment or ... |
| image-set-event | `<event>` | One event of a project or expedition or cruise or experiment or ... |
| image-set-platform | `<platform>` | Sensors URN or Equipment Git ID (Handle) |
| image-set-sensor | `<sensor>` | Sensors URN or Equipment Git ID (Handle) |
| image-set-uuid | UUID | A UUID (**version 4 - random**) for the entire image set |
| image-set-data-handle | Handle String | A Handle (using the UUID?) to point from the metadata to the data |
| image-set-metadata-handle | Handle String | A Handle (using the UUID?) to point to this metadata record |
| image-set-crs | EPSG:4326, ... | The coordinate reference system |
| image-set-crs | **EPSG:4326**, ... | The coordinate reference system |
| image-set-type | String | Video, Photo, Microscopy, ... |
| image-set-creator | Orcid | Orcid (or Name, E-Mail) |
| image-set-license | CC-BY-NC / CC-BY / CC-0 | Copyright sentence / contact person or office |
| image-set-coordinate-uncertainty* | Float (m) | Average/static uncertainty of coordinates in this dataset, given in meters |
| image-set-creator | **Orcid** | Orcid (or Name, E-Mail) |
| image-set-license | CC-BY-NC / **CC-BY** / CC-0 | Copyright sentence / contact person or office |
| image-set-coordinate-uncertainty | Float (m) | Average/static uncertainty of coordinates in this dataset, given in meters |
Fields marked by a star * 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.
### Optional (domain-specific)
| Field | Format / Values / Unit | Comment |
| ----- | ---------------------- | ------- |
| 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 |
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