iFDO core fields

Header information in the image-set-header part

Field	Type	Description
image-set-name	string	A unique name for the image set, should include image-project, image-event, image-sensor and optionally the purpose of imaging
image-set-uuid	string	A random UUID assigned to the entire image set
image-set-handle	string	A Handle URL (suggested: using the image-set-uuid) to point to the landing page of the data set
image-set-ifdo-version	string	The semantic version information of the iFDO standard used.
image-datetime	string	Full UTC datetime of image acquisition (or start time of a video) as in ISO8601. The default format here is ‘YYYY-MM-DD hh:mm:ss.sss’ with a space between date and time as in ISO 8601:2004. Other formats may be used if defined in the field ‘image-datetime-format’.
image-handle	string	The URI pointing to a downloadable version of the image data
image-latitude	number	Y-coordinate of the camera center in decimal degrees: D.DDDDDDD (use at least seven significant digits that is ca. 1cm resolution on Earth)
image-longitude	number	X-coordinate of the camera center in decimal degrees: D.DDDDDDD (use at least seven significant digits that is ca. 1cm resolution on Earth)
image-altitude-meters	number	Z-coordinate of camera center in meters. Has negative values when camera is below sea level. Has positive values when the camera is above sea level.
image-coordinate-reference-system	string	The coordinate reference system, e.g. EPSG:4326
image-coordinate-uncertainty-meters	number	The average/static uncertainty of coordinates in this dataset, given in meters. Computed e.g. as the standard deviation of coordinate corrections during smoothing / splining.
image-context	object	The overarching project context within which the image set was created
image-project	object	The more specific project or expedition or cruise or experiment or … within which the image set was created.
image-event	object	One event of a project or expedition or cruise or experiment or … that led to the creation of this image set.
image-platform	object	A URI pointing to a description of the camera platform used to create this image set
image-sensor	object	A URI pointing to a description of the sensor used to create this image set.
image-uuid	string	A (random) UUID for the individual image file (still or moving). This UUID needs to be embedded within the image files. For still images in the exif tag ‘ImageUniqueID’, for videos in the XMP tag ‘identifier’ in the Dublin Core namespace. For Matroska video containers the first ‘Segment UID’ is used.
image-hash-sha256	string	An SHA256 hash to represent the whole file (including UUID in file metadata header!) to verify integrity on disk
image-pi	object	Information to identify the principal investigator
image-creators	array	A list containing dicts for all creators containing:
image-license	object	A URL pointing to the license to use the data (should be FAIR, e.g. CC-BY or CC-0)
image-copyright	string	Copyright statement or contact person or office
image-abstract	string	500 - 2000 characters describing what, when, where, why and how the data was collected. Includes general information on the event (aka station, experiment), e.g. overlap between images/frames, parameters on platform movement, aims, purpose of image capture etc.
image-set-local-path	string	Local relative or absolute path to a directory in which (also its sub-directories), the referenced image files are located. Absolute paths must start with and relative paths without path separator (ignoring drive letters on windows). The default is the relative path ../raw.

image-set-name

Type: string
Description:

A unique name for the image set, should include image-project, image-event, image-sensor and optionally the purpose of imaging

image-set-uuid

Type: string
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$|^[0-9a-fA-F]{12}4[0-9a-fA-F]{3}[89abAB][0-9a-fA-F]{15}$
Description:

A random UUID assigned to the entire image set

image-set-handle

Type: string
Description:

A Handle URL (suggested: using the image-set-uuid) to point to the landing page of the data set

image-set-ifdo-version

Type: string
Description:

The semantic version information of the iFDO standard used.

image-datetime

Type: string
Description:

Full UTC datetime of image acquisition (or start time of a video) as in ISO8601. The default format here is ‘YYYY-MM-DD hh:mm:ss.sss’ with a space between date and time as in ISO 8601:2004. Other formats may be used if defined in the field ‘image-datetime-format’.

image-handle

Type: string
Description:

The URI pointing to a downloadable version of the image data

image-latitude

Type: number
Limits: [-90, 90]
Description:

Y-coordinate of the camera center in decimal degrees: D.DDDDDDD (use at least seven significant digits that is ca. 1cm resolution on Earth)

image-longitude

Type: number
Limits: [-180, 180]
Description:

X-coordinate of the camera center in decimal degrees: D.DDDDDDD (use at least seven significant digits that is ca. 1cm resolution on Earth)

image-altitude-meters

Type: number
Limits: (-∞, ∞)
Description:

Z-coordinate of camera center in meters. Has negative values when camera is below sea level. Has positive values when the camera is above sea level.

image-coordinate-reference-system

Type: string
Description:

The coordinate reference system, e.g. EPSG:4326

image-coordinate-uncertainty-meters

Type: number
Limits: [0, ∞)
Description:

The average/static uncertainty of coordinates in this dataset, given in meters. Computed e.g. as the standard deviation of coordinate corrections during smoothing / splining.

image-context

Type: object
Description:

The overarching project context within which the image set was created

Properties:

Field	Type	Description	Required
name	string	The name of the context	✔
uri	string	A URI pointing to details of the context

image-context > name

Type: string
Description:

The name of the context

image-context > uri

Type: string
Description:

A URI pointing to details of the context

image-project

Type: object
Description:

The more specific project or expedition or cruise or experiment or … within which the image set was created.

Properties:

Field	Type	Description	Required
name	string	The name of the project	✔
uri	string	A URI pointing to details of the project

image-project > name

Type: string
Description:

The name of the project

image-project > uri

Type: string
Description:

A URI pointing to details of the project

image-event

Type: object
Description:

One event of a project or expedition or cruise or experiment or … that led to the creation of this image set.

Properties:

Field	Type	Description	Required
name	string	The name of the event	✔
uri	string	A URI pointing to details of the event

image-event > name

Type: string
Description:

The name of the event

image-event > uri

Type: string
Description:

A URI pointing to details of the event

image-platform

Type: object
Description:

A URI pointing to a description of the camera platform used to create this image set

Properties:

Field	Type	Description	Required
name	string	The name of the platform	✔
uri	string	A URI pointing to details of the platform

image-platform > name

Type: string
Description:

The name of the platform

image-platform > uri

Type: string
Description:

A URI pointing to details of the platform

image-sensor

Type: object
Description:

A URI pointing to a description of the sensor used to create this image set.

Properties:

Field	Type	Description	Required
name	string	The name of the sensor	✔
uri	string	A URI pointing to details of the sensor

image-sensor > name

Type: string
Description:

The name of the sensor

image-sensor > uri

Type: string
Description:

A URI pointing to details of the sensor

image-uuid

Type: string
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$|^[0-9a-fA-F]{12}4[0-9a-fA-F]{3}[89abAB][0-9a-fA-F]{15}$
Description:

A (random) UUID for the individual image file (still or moving). This UUID needs to be embedded within the image files. For still images in the exif tag ‘ImageUniqueID’, for videos in the XMP tag ‘identifier’ in the Dublin Core namespace. For Matroska video containers the first ‘Segment UID’ is used.

image-hash-sha256

Type: string
Description:

An SHA256 hash to represent the whole file (including UUID in file metadata header!) to verify integrity on disk

image-pi

Type: object
Description:

Information to identify the principal investigator

Properties:

Field	Type	Description	Required
name	string	The name of the PI	✔
uri	string	A URI pointing to details of the PI. Could be ORCID URI

image-pi > name

Type: string
Description:

The name of the PI

image-pi > uri

Type: string
Description:

A URI pointing to details of the PI. Could be ORCID URI

image-creators

Type: array
Item Type: object
Description:

A list containing dicts for all creators containing:

Item Properties:

Field	Type	Description	Required
name	string	The name of the creator	✔
uri	string	A URI pointing to details of the creator. Could be ORCID URI

image-creators > name

Type: string
Description:

The name of the creator

image-creators > uri

Type: string
Description:

A URI pointing to details of the creator. Could be ORCID URI

image-license

Type: object
Description:

A URL pointing to the license to use the data (should be FAIR, e.g. CC-BY or CC-0)

Properties:

Field	Type	Description	Required
name	string	The name of the license	✔
uri	string	A URI pointing to details of the license

image-license > name

Type: string
Description:

The name of the license

image-license > uri

Type: string
Description:

A URI pointing to details of the license

image-copyright

Type: string
Description:

Copyright statement or contact person or office

image-abstract

Type: string
Description:

500 - 2000 characters describing what, when, where, why and how the data was collected. Includes general information on the event (aka station, experiment), e.g. overlap between images/frames, parameters on platform movement, aims, purpose of image capture etc.

image-set-local-path

Type: string
Description:

Local relative or absolute path to a directory in which (also its sub-directories), the referenced image files are located. Absolute paths must start with and relative paths without path separator (ignoring drive letters on windows). The default is the relative path ../raw.

Image item information

Field	Type	Description
image-set-name	string	A unique name for the image set, should include image-project, image-event, image-sensor and optionally the purpose of imaging
image-set-uuid	string	A random UUID assigned to the entire image set
image-set-handle	string	A Handle URL (suggested: using the image-set-uuid) to point to the landing page of the data set
image-set-ifdo-version	string	The semantic version information of the iFDO standard used.
image-datetime	string	Full UTC datetime of image acquisition (or start time of a video) as in ISO8601. The default format here is ‘YYYY-MM-DD hh:mm:ss.sss’ with a space between date and time as in ISO 8601:2004. Other formats may be used if defined in the field ‘image-datetime-format’.
image-handle	string	The URI pointing to a downloadable version of the image data
image-latitude	number	Y-coordinate of the camera center in decimal degrees: D.DDDDDDD (use at least seven significant digits that is ca. 1cm resolution on Earth)
image-longitude	number	X-coordinate of the camera center in decimal degrees: D.DDDDDDD (use at least seven significant digits that is ca. 1cm resolution on Earth)
image-altitude-meters	number	Z-coordinate of camera center in meters. Has negative values when camera is below sea level. Has positive values when the camera is above sea level.
image-coordinate-reference-system	string	The coordinate reference system, e.g. EPSG:4326
image-coordinate-uncertainty-meters	number	The average/static uncertainty of coordinates in this dataset, given in meters. Computed e.g. as the standard deviation of coordinate corrections during smoothing / splining.
image-context	object	The overarching project context within which the image set was created
image-project	object	The more specific project or expedition or cruise or experiment or … within which the image set was created.
image-event	object	One event of a project or expedition or cruise or experiment or … that led to the creation of this image set.
image-platform	object	A URI pointing to a description of the camera platform used to create this image set
image-sensor	object	A URI pointing to a description of the sensor used to create this image set.
image-uuid	string	A (random) UUID for the individual image file (still or moving). This UUID needs to be embedded within the image files. For still images in the exif tag ‘ImageUniqueID’, for videos in the XMP tag ‘identifier’ in the Dublin Core namespace. For Matroska video containers the first ‘Segment UID’ is used.
image-hash-sha256	string	An SHA256 hash to represent the whole file (including UUID in file metadata header!) to verify integrity on disk
image-pi	object	Information to identify the principal investigator
image-creators	array	A list containing dicts for all creators containing:
image-license	object	A URL pointing to the license to use the data (should be FAIR, e.g. CC-BY or CC-0)
image-copyright	string	Copyright statement or contact person or office
image-abstract	string	500 - 2000 characters describing what, when, where, why and how the data was collected. Includes general information on the event (aka station, experiment), e.g. overlap between images/frames, parameters on platform movement, aims, purpose of image capture etc.
image-set-local-path	string	Local relative or absolute path to a directory in which (also its sub-directories), the referenced image files are located. Absolute paths must start with and relative paths without path separator (ignoring drive letters on windows). The default is the relative path ../raw.

image-set-name

Type: string
Description:

A unique name for the image set, should include image-project, image-event, image-sensor and optionally the purpose of imaging

image-set-uuid

Type: string
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$|^[0-9a-fA-F]{12}4[0-9a-fA-F]{3}[89abAB][0-9a-fA-F]{15}$
Description:

A random UUID assigned to the entire image set

image-set-handle

Type: string
Description:

A Handle URL (suggested: using the image-set-uuid) to point to the landing page of the data set

image-set-ifdo-version

Type: string
Description:

The semantic version information of the iFDO standard used.

image-datetime

Type: string
Description:

Full UTC datetime of image acquisition (or start time of a video) as in ISO8601. The default format here is ‘YYYY-MM-DD hh:mm:ss.sss’ with a space between date and time as in ISO 8601:2004. Other formats may be used if defined in the field ‘image-datetime-format’.

image-handle

Type: string
Description:

The URI pointing to a downloadable version of the image data

image-latitude

Type: number
Limits: [-90, 90]
Description:

Y-coordinate of the camera center in decimal degrees: D.DDDDDDD (use at least seven significant digits that is ca. 1cm resolution on Earth)

image-longitude

Type: number
Limits: [-180, 180]
Description:

X-coordinate of the camera center in decimal degrees: D.DDDDDDD (use at least seven significant digits that is ca. 1cm resolution on Earth)

image-altitude-meters

Type: number
Limits: (-∞, ∞)
Description:

Z-coordinate of camera center in meters. Has negative values when camera is below sea level. Has positive values when the camera is above sea level.

image-coordinate-reference-system

Type: string
Description:

The coordinate reference system, e.g. EPSG:4326

image-coordinate-uncertainty-meters

Type: number
Limits: [0, ∞)
Description:

The average/static uncertainty of coordinates in this dataset, given in meters. Computed e.g. as the standard deviation of coordinate corrections during smoothing / splining.

image-context

Type: object
Description:

The overarching project context within which the image set was created

Properties:

Field	Type	Description	Required
name	string	The name of the context	✔
uri	string	A URI pointing to details of the context

image-context > name

Type: string
Description:

The name of the context

image-context > uri

Type: string
Description:

A URI pointing to details of the context

image-project

Type: object
Description:

The more specific project or expedition or cruise or experiment or … within which the image set was created.

Properties:

Field	Type	Description	Required
name	string	The name of the project	✔
uri	string	A URI pointing to details of the project

image-project > name

Type: string
Description:

The name of the project

image-project > uri

Type: string
Description:

A URI pointing to details of the project

image-event

Type: object
Description:

One event of a project or expedition or cruise or experiment or … that led to the creation of this image set.

Properties:

Field	Type	Description	Required
name	string	The name of the event	✔
uri	string	A URI pointing to details of the event

image-event > name

Type: string
Description:

The name of the event

image-event > uri

Type: string
Description:

A URI pointing to details of the event

image-platform

Type: object
Description:

A URI pointing to a description of the camera platform used to create this image set

Properties:

Field	Type	Description	Required
name	string	The name of the platform	✔
uri	string	A URI pointing to details of the platform

image-platform > name

Type: string
Description:

The name of the platform

image-platform > uri

Type: string
Description:

A URI pointing to details of the platform

image-sensor

Type: object
Description:

A URI pointing to a description of the sensor used to create this image set.

Properties:

Field	Type	Description	Required
name	string	The name of the sensor	✔
uri	string	A URI pointing to details of the sensor

image-sensor > name

Type: string
Description:

The name of the sensor

image-sensor > uri

Type: string
Description:

A URI pointing to details of the sensor

image-uuid

Type: string
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$|^[0-9a-fA-F]{12}4[0-9a-fA-F]{3}[89abAB][0-9a-fA-F]{15}$
Description:

A (random) UUID for the individual image file (still or moving). This UUID needs to be embedded within the image files. For still images in the exif tag ‘ImageUniqueID’, for videos in the XMP tag ‘identifier’ in the Dublin Core namespace. For Matroska video containers the first ‘Segment UID’ is used.

image-hash-sha256

Type: string
Description:

An SHA256 hash to represent the whole file (including UUID in file metadata header!) to verify integrity on disk

image-pi

Type: object
Description:

Information to identify the principal investigator

Properties:

Field	Type	Description	Required
name	string	The name of the PI	✔
uri	string	A URI pointing to details of the PI. Could be ORCID URI

image-pi > name

Type: string
Description:

The name of the PI

image-pi > uri

Type: string
Description:

A URI pointing to details of the PI. Could be ORCID URI

image-creators

Type: array
Item Type: object
Description:

A list containing dicts for all creators containing:

Item Properties:

Field	Type	Description	Required
name	string	The name of the creator	✔
uri	string	A URI pointing to details of the creator. Could be ORCID URI

image-creators > name

Type: string
Description:

The name of the creator

image-creators > uri

Type: string
Description:

A URI pointing to details of the creator. Could be ORCID URI

image-license

Type: object
Description:

A URL pointing to the license to use the data (should be FAIR, e.g. CC-BY or CC-0)

Properties:

Field	Type	Description	Required
name	string	The name of the license	✔
uri	string	A URI pointing to details of the license

image-license > name

Type: string
Description:

The name of the license

image-license > uri

Type: string
Description:

A URI pointing to details of the license

image-copyright

Type: string
Description:

Copyright statement or contact person or office

image-abstract

Type: string
Description:

500 - 2000 characters describing what, when, where, why and how the data was collected. Includes general information on the event (aka station, experiment), e.g. overlap between images/frames, parameters on platform movement, aims, purpose of image capture etc.

image-set-local-path

Type: string
Description:

Local relative or absolute path to a directory in which (also its sub-directories), the referenced image files are located. Absolute paths must start with and relative paths without path separator (ignoring drive letters on windows). The default is the relative path ../raw.