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

Update README.md

parent 89203541
> **Preamble:** We strive to make marine image data [FAIR](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/metadata-profiles-fdos/-/blob/master/FAIR-marine-images.md). We maintain - here in this repository - [data profiles](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/metadata-profiles-fdos) to establish a common language for marine imagery, we develop best-practice [operating procedures](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/standard-operating-procedures) for handling marine images and we develop [software tools](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/software/mar-iqt) to apply the vocabulary and procedures to marine imagery.
# Introduction
Achieving FAIRness and Openness of (marine) image data requires structured and standardized metadata on the image data itself and the visual and semantic image data content. This metadata shall be provided in the form of FAIR digital objects (FDOs). The content of this repository describes how FDOs for images (aka iFDOs) shall be structured. If you want, an iFDO is a human and machine-readable file format for an entire image set except that it does not contain the actual image data, only references to it!
Achieving FAIRness and Openness of (marine) image data requires structured and standardized metadata on the image data itself and the visual and semantic image data content. This metadata shall be provided in the form of FAIR digital objects (FDOs). The content of this repository describes how FDOs for images (aka iFDOs) shall be structured. If you want, an iFDO is a human and machine-readable file format for an entire image set, except that it does not contain the actual image data, only references to it!
## Delicious (marine) image data
iFDOs consist of sections. Some are required, some are recommended, some are optional. You will only have FAIR image data with the required sections. You will only gain visibility and credit for iFDOs with the recommended sections populated. And you will only have awesome image data in case you also populate your domain-specific optional sections.
<img style="margin: auto 0" src="https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/metadata-profiles-fdos/-/raw/master/graphics/delicious_iFDOs.png" title="Delicious iFDOs" width="800"><br>
The iFDO sections can consist of header and item information subsections. For the core iFDO, the header subsection contains all information that is identical for all the image items. The image item information subsection contains all the information where the individual images require their specific metadata value. An example is the coordinate: for a moving camera, all image items require their own image-latitude value. In case of a stationary camera, the image-set-latitude value can be used instead.
iFDOs consist of various metadata fields. Some are required, some are recommended, some are optional. You will only achieve FAIRness of your image data with the required core fields populated. You will only gain visibility and credit for your image data with the recommended capture fields populated. And you will only have awesome image data in case you also populate the content fields. As a bonus you can add your own domain-specific optional fields.
<img style="margin: auto 0" src="https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/metadata-profiles-fdos/-/raw/master/graphics/delicious_iFDOs_CCC.png" title="Delicious iFDOs" width="800"><br>
An iFDO file can consists of a header and item information part. For the core iFDO fields, the header part contains all metadata information that is identical for all the image items. The image item information part contains all the information where the individual images require their specific metadata value. An example is the coordinate: for a moving camera, all image items require their own image-latitude value. In case of a stationary camera, the image-set-latitude value can be used instead.
## iFDO sections
- **Core section (required)**: [iFDO core](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/metadata-vocabulary-profile/-/blob/master/MareHub_AGVI_iFDO.md)
- **Content section (recommended)**: [iFDO content](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/metadata-vocabulary-profile/-/blob/master/MareHub_AGVI_pFDO.md)
- Domain-specific sections: TODO
- **Core fields (required)**: [iFDO core](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/metadata-vocabulary-profile/-/blob/master/MareHub_AGVI_iFDO-core.md)
- **Capture fields (recommended)**: [iFDO capture](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/metadata-vocabulary-profile/-/blob/master/MareHub_AGVI_iFDO-capture.md)
- **Content fields (optional)**: [iFDO content](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/metadata-vocabulary-profile/-/blob/master/MareHub_AGVI_iFDO-content.md)
## Version
Continuous versioning of the FDOs is given by the commit hashes. Releases with numerical versioning will be created upon major changes.
......
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