iFDO capture fields#
| Field | Type | Description |
|---|---|---|
| image-acquisition | string | photo: still images, video: moving images, slide: microscopy images / slide scans |
| image-quality | string | raw: straight from the sensor, processed: QA/QC’d, product: image data ready for interpretation |
| image-deployment | string | mapping: planned path execution along 2-3 spatial axes, stationary: fixed spatial position, survey: planned path execution along free path, exploration: unplanned path execution, experiment: observation of manipulated environment, sampling: ex-situ imaging of samples taken by other method |
| image-navigation | string | satellite: GPS/Galileo etc., beacon: USBL etc., transponder: LBL etc., reconstructed: position estimated from other measures like cable length and course over ground |
| image-scale-reference | string | 3D camera: the imaging system provides scale directly, calibrated camera: image data and additional external data like object distance provide scale together, laser marker: scale information is embedded in the visual data, optical flow: scale is computed from the relative movement of the images and the camera navigation data |
| image-illumination | string | sunlight: the scene is only illuminated by the sun, artificial light: the scene is only illuminated by artificial light, mixed light: both sunlight and artificial light illuminate the scene |
| image-pixel-magnitude | string | average size of one pixel of an image |
| image-marine-zone | string | seafloor: images taken in/on/right above the seafloor, water column: images taken in the free water without the seafloor or the sea surface in sight, sea surface: images taken right below the sea surface, atmosphere: images taken outside of the water, laboratory: images taken ex-situ |
| image-spectral-resolution | string | grayscale: single channel imagery, rgb: three channel imagery, multi-spectral: 4-10 channel imagery, hyper-spectral: 10+ channel imagery |
| image-capture-mode | string | whether the time points of image capture were systematic, human-triggered or both |
| image-fauna-attraction | string | Allowed: none, baited, light |
| image-area-square-meters | number | The footprint of the entire image in square meters |
| image-meters-above-ground | number | Distance of the camera to the seafloor in meters |
| image-acquisition-settings | object | All the information that is recorded by the camera in the EXIF, IPTC etc. As a dict. Includes ISO, aperture, etc. |
| image-camera-yaw-degrees | number | Camera view yaw angle. Rotation of camera coordinates (x,y,z = top, right, line of sight) with respect to NED coordinates (x,y,z = north,east,down) in accordance with the yaw,pitch,roll rotation order convention: 1. yaw around z, 2. pitch around rotated y, 3. roll around rotated x. Rotation directions according to “right-hand rule”. I.e. for yaw,pitch,roll = 0,0,0 camera is facing downward with top side towards north. |
| image-camera-pitch-degrees | number | Camera view pitch angle. Rotation of camera coordinates (x,y,z = top, right, line of sight) with respect to NED coordinates (x,y,z = north,east,down) in accordance with the yaw,pitch,roll rotation order convention: 1. yaw around z, 2. pitch around rotated y, 3. roll around rotated x. Rotation directions according to “right-hand rule”. I.e. for yaw,pitch,roll = 0,0,0 camera is facing downward with top side towards north. |
| image-camera-roll-degrees | number | Camera view roll angle. Rotation of camera coordinates (x,y,z = top, right, line of sight) with respect to NED coordinates (x,y,z = north,east,down) in accordance with the yaw,pitch,roll rotation order convention: 1. yaw around z, 2. pitch around rotated y, 3. roll around rotated x. Rotation directions according to “right-hand rule”. I.e. for yaw,pitch,roll = 0,0,0 camera is facing downward with top side towards north. |
| image-overlap-fraction | number | The average overlap of two consecutive images i and j as the area images in both of the images (A_i * A_j) divided by the total area images by the two images (A_i + A_j - A_i * A_j): f = A_i * A_j / (A_i + A_j - A_i * A_j) -> 0 if no overlap. 1 if complete overlap |
| image-datetime-format | string | A date time format string in Python notation to specify a date time format used throughout the iFDO file that differs from the default one ‘%Y-%m-%d %H:%M:%S.%f’. Make sure to reach second-accuracy with your date times! |
| image-camera-pose | object | Information required to specify camera pose. Details given in properties. |
| image-camera-housing-viewport | object | Information on the camera pressure housing viewport (the glass). Details given in properties. |
| image-flatport-parameters | object | Information required to specify the characteristics of a flat port camera housing. Details given in properties. |
| image-domeport-parameters | object | Information required to specify the characteristics of a dome port camera housing. Details given in properties. |
| image-camera-calibration-model | object | Information required to specify the camera calibration model. Details given in properties. |
| image-photometric-calibration | object | Information required to specify the photometric calibration. Details given in properties. |
| image-objective | string | A general description of the aims and objectives of the study, as they pertain to biology and method scope. This should define the primary and secondary data to be measured and to what precision. |
| image-target-environment | string | A description, delineation, and definition of the habitat or environment of study, including boundaries of such |
| image-target-timescale | string | A description, delineation, and definition of the period, interval or temporal environment of the study. |
| image-spatial-constraints | string | A description / definition of the spatial extent of the study area (inside which the photographs were captured), including boundaries and reasons for constraints (e.g. scientific, practical) |
| image-temporal-constraints | string | A description / definition of the temporal extent, including boundaries and reasons for constraints (e.g. scientific, practical) |
| image-time-synchronisation | string | Synchronisation procedure and determined time offsets between camera recording values and UTC |
| image-item-identification-scheme | string | How the images file names are constructed. Should be like this image-project_image-event_image-sensor_image-datetime.ext |
| image-curation-protocol | string | A description of the image and metadata curation steps and results |
| image-visual-constraints | string | An explanation how the images might be degraded (turbidity, blocked view, …) |
| image-set-min-latitude-degrees | number | The lower bounding box latitude enclosing all images in the set |
| image-set-max-latitude-degrees | number | The upper bounding box latitude enclosing all images in the set |
| image-set-min-longitude-degrees | number | The lower bounding box longitude enclosing all images in the set |
| image-set-max-longitude-degrees | number | The upper bounding box longitude enclosing all images in the set |
| image-set-related-material | array | Links to other resources that are related to this image set. |
| image-set-provenance | object | A schema to document the agents, activities and entities that led to an image set entity |
image-acquisition#
Type: string
Must be one of:
| Value | Description |
|---|---|
| photo | The image set contains still images |
| video | The image set contains moving images |
| slide | The image set contains microscopy images / slide scans |
Description:
photo: still images, video: moving images, slide: microscopy images / slide scans
image-quality#
Type: string
Must be one of:
| Value | Description |
|---|---|
| raw | The images in the image set come straight from the sensor |
| processed | The images in the image set have been QA/QCd |
| product | The images in the image set are ready for interpretation |
Description:
raw: straight from the sensor, processed: QA/QC’d, product: image data ready for interpretation
image-deployment#
Type: string
Must be one of:
| Value | Description |
|---|---|
| mapping | The camera followed a planned path execution along 2-3 spatial axes |
| stationary | The camera remained in a fixed spatial position |
| survey | The camera followed a planned path execution along a free path |
| exploration | The camera followed an unplanned path execution |
| experiment | The camera observed a manipulation of the environment |
| sampling | The camera imaging samples taken by other method ex-situ |
Description:
mapping: planned path execution along 2-3 spatial axes, stationary: fixed spatial position, survey: planned path execution along free path, exploration: unplanned path execution, experiment: observation of manipulated environment, sampling: ex-situ imaging of samples taken by other method
image-navigation#
Type: string
Must be one of:
| Value | Description |
|---|---|
| satellite | Position data was created from satellite information (GPS, Galileo, …) for the sea surface |
| beacon | Position data was created from underwater beacons (USBL, …) for an underwater position |
| transponder | Position data was created from underwater beacons (USBL, LBL, …) for an underwater position |
| reconstructed | Position data was estimated from other measures like cable length and course over ground |
Description:
satellite: GPS/Galileo etc., beacon: USBL etc., transponder: LBL etc., reconstructed: position estimated from other measures like cable length and course over ground
image-scale-reference#
Type: string
Must be one of:
| Value | Description |
|---|---|
| 3D camera | Meter-scale in the images was determined by 3D imaging / reconstruction |
| calibrated camera | Meter-scale in the images was determined by image data and additional external data like object distance |
| laser marker | Meter-scale in the images was determined by laser markers visible in the images |
| optical flow | Meter-scale in the images was determined from the relative movement of the images and the camera navigation data |
Description:
3D camera: the imaging system provides scale directly, calibrated camera: image data and additional external data like object distance provide scale together, laser marker: scale information is embedded in the visual data, optical flow: scale is computed from the relative movement of the images and the camera navigation data
image-illumination#
Type: string
Must be one of:
| Value | Description |
|---|---|
| sunlight | The scene is only illuminated by the sun |
| artificial light | The scene is only illuminated by artificial light |
| mixed light | The scene is illuminated by both sunlight and artificial light |
Description:
sunlight: the scene is only illuminated by the sun, artificial light: the scene is only illuminated by artificial light, mixed light: both sunlight and artificial light illuminate the scene
image-pixel-magnitude#
Type: string
Must be one of:
| Value | Description |
|---|---|
| km | The average size of a pixel in the image set is on the order of 1 km |
| hm | The average size of a pixel in the image set is on the order of 1 hm = 100 m |
| dam | The average size of a pixel in the image set is on the order of 1 dam = 10 m |
| m | The average size of a pixel in the image set is on the order of 1 m |
| dm | The average size of a pixel in the image set is on the order of 1 dm = 0.1 m |
| cm | The average size of a pixel in the image set is on the order of 1 cm |
| mm | The average size of a pixel in the image set is on the order of 1 mm |
| µm | The average size of a pixel in the image set is on the order of 1 µm |
Description:
average size of one pixel of an image
image-marine-zone#
Type: string
Must be one of:
| Value | Description |
|---|---|
| seafloor | The images were taken right below the sea surface |
| water column | The images were taken in the water column without the seafloor or the sea surface in sight |
| sea surface | The images were taken in/on/right above the seafloor |
| atmosphere | The images were taken outside of the water |
| laboratory | The images were taken ex-situ |
Description:
seafloor: images taken in/on/right above the seafloor, water column: images taken in the free water without the seafloor or the sea surface in sight, sea surface: images taken right below the sea surface, atmosphere: images taken outside of the water, laboratory: images taken ex-situ
image-spectral-resolution#
Type: string
Must be one of:
| Value | Description |
|---|---|
| grayscale | The images consist of one color channel |
| rgb | The images consist of three color channels |
| multi-spectral | The images consist of 4-10 color channels |
| hyper-spectral | The images consist of more than 10 channels |
Description:
grayscale: single channel imagery, rgb: three channel imagery, multi-spectral: 4-10 channel imagery, hyper-spectral: 10+ channel imagery
image-capture-mode#
Type: string
Must be one of:
| Value | Description |
|---|---|
| timer | Image-acquisition was triggered by a timer |
| manual | Image-acquisition was triggered by a human controller |
| mixed | Image-acquisition was triggered by both a timer and a human-controller |
Description:
whether the time points of image capture were systematic, human-triggered or both
image-fauna-attraction#
Type: string
Must be one of:
| Value | Description |
|---|---|
| none | |
| baited | |
| light |
Description:
Allowed: none, baited, light
image-area-square-meters#
Type: number
Limits: (0, ∞)
Description:
The footprint of the entire image in square meters
image-meters-above-ground#
Type: number
Limits: (-∞, ∞)
Description:
Distance of the camera to the seafloor in meters
image-acquisition-settings#
Type: object
Description:
All the information that is recorded by the camera in the EXIF, IPTC etc. As a dict. Includes ISO, aperture, etc.
image-camera-yaw-degrees#
Type: number
Limits: (-∞, ∞)
Description:
Camera view yaw angle. Rotation of camera coordinates (x,y,z = top, right, line of sight) with respect to NED coordinates (x,y,z = north,east,down) in accordance with the yaw,pitch,roll rotation order convention: 1. yaw around z, 2. pitch around rotated y, 3. roll around rotated x. Rotation directions according to “right-hand rule”. I.e. for yaw,pitch,roll = 0,0,0 camera is facing downward with top side towards north.
image-camera-pitch-degrees#
Type: number
Limits: (-∞, ∞)
Description:
Camera view pitch angle. Rotation of camera coordinates (x,y,z = top, right, line of sight) with respect to NED coordinates (x,y,z = north,east,down) in accordance with the yaw,pitch,roll rotation order convention: 1. yaw around z, 2. pitch around rotated y, 3. roll around rotated x. Rotation directions according to “right-hand rule”. I.e. for yaw,pitch,roll = 0,0,0 camera is facing downward with top side towards north.
image-camera-roll-degrees#
Type: number
Limits: (-∞, ∞)
Description:
Camera view roll angle. Rotation of camera coordinates (x,y,z = top, right, line of sight) with respect to NED coordinates (x,y,z = north,east,down) in accordance with the yaw,pitch,roll rotation order convention: 1. yaw around z, 2. pitch around rotated y, 3. roll around rotated x. Rotation directions according to “right-hand rule”. I.e. for yaw,pitch,roll = 0,0,0 camera is facing downward with top side towards north.
image-overlap-fraction#
Type: number
Limits: (0, 1]
Description:
The average overlap of two consecutive images i and j as the area images in both of the images (A_i * A_j) divided by the total area images by the two images (A_i + A_j - A_i * A_j): f = A_i * A_j / (A_i + A_j - A_i * A_j) -> 0 if no overlap. 1 if complete overlap
image-datetime-format#
Type: string
Description:
A date time format string in Python notation to specify a date time format used throughout the iFDO file that differs from the default one ‘%Y-%m-%d %H:%M:%S.%f’. Make sure to reach second-accuracy with your date times!
image-camera-pose#
Type: object
Description:
Information required to specify camera pose. Details given in properties.
Properties:
| Field | Type | Description | Required |
|---|---|---|---|
| pose-utm-zone | string | The UTM zone number | |
| pose-utm-epsg | string | The EPSG code of the UTM zone | |
| pose-utm-east-north-up-meters | array | The position of the camera center in UTM coordinates. | |
| pose-absolute-orientation-utm-matrix | array | 3x3 row-major float rotation matrix that transforms a direction in camera coordinates (x,y,z = right,down,line of sight) into a direction in UTM coordinates (x,y,z = easting,northing,up)} |
image-camera-pose > pose-utm-zone#
Type: string
Description:
The UTM zone number
image-camera-pose > pose-utm-epsg#
Type: string
Description:
The EPSG code of the UTM zone
image-camera-pose > pose-utm-east-north-up-meters#
Type: array
Min Items: 3
Max Items: 3
Item Type: number
Item Limits: (-∞, ∞)
Description:
The position of the camera center in UTM coordinates.
image-camera-pose > pose-absolute-orientation-utm-matrix#
Type: array
Min Items: 9
Max Items: 9
Item Type: number
Item Limits: (-∞, ∞)
Description:
3x3 row-major float rotation matrix that transforms a direction in camera coordinates (x,y,z = right,down,line of sight) into a direction in UTM coordinates (x,y,z = easting,northing,up)}
image-camera-housing-viewport#
Type: object
Description:
Information on the camera pressure housing viewport (the glass). Details given in properties.
Properties:
| Field | Type | Description | Required |
|---|---|---|---|
| viewport-type | string | e.g.: flat port, dome port, other | |
| viewport-optical-density | number | Unit-less optical density number (1.0=vacuum) | |
| viewport-thickness-millimeters | number | Thickness of viewport in millimeters | |
| viewport-extra-description | string | A textual description of the viewport used |
image-camera-housing-viewport > viewport-type#
Type: string
Description:
e.g.: flat port, dome port, other
image-camera-housing-viewport > viewport-optical-density#
Type: number
Limits: [0, 1]
Description:
Unit-less optical density number (1.0=vacuum)
image-camera-housing-viewport > viewport-thickness-millimeters#
Type: number
Limits: (0, ∞)
Description:
Thickness of viewport in millimeters
image-camera-housing-viewport > viewport-extra-description#
Type: string
Description:
A textual description of the viewport used
image-flatport-parameters#
Type: object
Description:
Information required to specify the characteristics of a flat port camera housing. Details given in properties.
Properties:
| Field | Type | Description | Required |
|---|---|---|---|
| flatport-lens-port-distance-millimeters | number | The distance between the front of the camera lens and the inner side of the housing viewport in millimeters. | |
| flatport-interface-normal-direction | array | 3D direction vector to specify how the view direction of the lens intersects with the viewport (unit-less, (0,0,1) is aligned) | |
| flatport-extra-description | string | A textual description of the flat port used |
image-flatport-parameters > flatport-lens-port-distance-millimeters#
Type: number
Limits: (0, ∞)
Description:
The distance between the front of the camera lens and the inner side of the housing viewport in millimeters.
image-flatport-parameters > flatport-interface-normal-direction#
Type: array
Min Items: 3
Max Items: 3
Item Type: number
Item Limits: (-∞, ∞)
Description:
3D direction vector to specify how the view direction of the lens intersects with the viewport (unit-less, (0,0,1) is aligned)
image-flatport-parameters > flatport-extra-description#
Type: string
Description:
A textual description of the flat port used
image-domeport-parameters#
Type: object
Description:
Information required to specify the characteristics of a dome port camera housing. Details given in properties.
Properties:
| Field | Type | Description | Required |
|---|---|---|---|
| domeport-outer-radius-millimeters | number | Outer radius of the dome port - the part that has contact with the water. | |
| domeport-decentering-offset-xyz-millimeters | array | 3D offset vector of the camera center from the dome port center in millimeters | |
| domeport-extra-description | string | A textual description of the dome port used |
image-domeport-parameters > domeport-outer-radius-millimeters#
Type: number
Limits: (-∞, ∞)
Description:
Outer radius of the dome port - the part that has contact with the water.
image-domeport-parameters > domeport-decentering-offset-xyz-millimeters#
Type: array
Min Items: 3
Max Items: 3
Item Type: number
Item Limits: (-∞, ∞)
Description:
3D offset vector of the camera center from the dome port center in millimeters
image-domeport-parameters > domeport-extra-description#
Type: string
Description:
A textual description of the dome port used
image-camera-calibration-model#
Type: object
Description:
Information required to specify the camera calibration model. Details given in properties.
Properties:
| Field | Type | Description | Required |
|---|---|---|---|
| calibration-model-type | string | e.g.: rectilinear air, rectilinear water, fisheye air, fisheye water, other | |
| calibration-focal-length-xy-pixel | array | 2D focal length in pixels | |
| calibration-principal-point-xy-pixel | array | 2D principal point of the calibration in pixels (top left pixel center is 0,0, x right, y down) | |
| calibration-distortion-coefficients | array | rectilinear: k1, k2, p1, p2, k3, k4, k5, k6, fisheye: k1, k2, k3, k4 | |
| calibration-approximate-field-of-view-water-xy-degree | array | Proxy for pixel to meter conversion, and as backup | |
| calibration-model-extra-description | string | Explain model, or if lens parameters are in mm rather than in pixel |
image-camera-calibration-model > calibration-model-type#
Type: string
Description:
e.g.: rectilinear air, rectilinear water, fisheye air, fisheye water, other
image-camera-calibration-model > calibration-focal-length-xy-pixel#
Type: array
Min Items: 2
Max Items: 2
Item Type: number
Item Limits: (-∞, ∞)
Description:
2D focal length in pixels
image-camera-calibration-model > calibration-principal-point-xy-pixel#
Type: array
Min Items: 2
Max Items: 2
Item Type: number
Item Limits: (-∞, ∞)
Description:
2D principal point of the calibration in pixels (top left pixel center is 0,0, x right, y down)
image-camera-calibration-model > calibration-distortion-coefficients#
Type: array
Item Type: number
Item Limits: (-∞, ∞)
Description:
rectilinear: k1, k2, p1, p2, k3, k4, k5, k6, fisheye: k1, k2, k3, k4
image-camera-calibration-model > calibration-approximate-field-of-view-water-xy-degree#
Type: array
Item Type: number
Item Limits: (-∞, ∞)
Description:
Proxy for pixel to meter conversion, and as backup
image-camera-calibration-model > calibration-model-extra-description#
Type: string
Description:
Explain model, or if lens parameters are in mm rather than in pixel
image-photometric-calibration#
Type: object
Description:
Information required to specify the photometric calibration. Details given in properties.
Properties:
| Field | Type | Description | Required |
|---|---|---|---|
| photometric-sequence-white-balancing | string | A text on how white-balancing was done. | |
| photometric-exposure-factor-RGB | array | RGB factors applied to this image, product of ISO, exposure time, relative white balance | |
| photometric-sequence-illumination-type | string | e.g. constant artificial, globally adapted artificial, individually varying light sources, sunlight, mixed) | |
| photometric-sequence-illumination-description | string | A text on how the image sequence was illuminated | |
| photometric-illumination-factor-RGB | array | RGB factors applied to artificial lights for this image | |
| photometric-water-properties-description | string | A text describing the photometric properties of the water within which the images were capture |
image-photometric-calibration > photometric-sequence-white-balancing#
Type: string
Description:
A text on how white-balancing was done.
image-photometric-calibration > photometric-exposure-factor-RGB#
Type: array
Min Items: 3
Max Items: 3
Item Type: number
Item Limits: (-∞, ∞)
Description:
RGB factors applied to this image, product of ISO, exposure time, relative white balance
image-photometric-calibration > photometric-sequence-illumination-type#
Type: string
Description:
e.g. constant artificial, globally adapted artificial, individually varying light sources, sunlight, mixed)
image-photometric-calibration > photometric-sequence-illumination-description#
Type: string
Description:
A text on how the image sequence was illuminated
image-photometric-calibration > photometric-illumination-factor-RGB#
Type: array
Min Items: 3
Max Items: 3
Item Type: number
Item Limits: (-∞, ∞)
Description:
RGB factors applied to artificial lights for this image
image-photometric-calibration > photometric-water-properties-description#
Type: string
Description:
A text describing the photometric properties of the water within which the images were capture
image-objective#
Type: string
Description:
A general description of the aims and objectives of the study, as they pertain to biology and method scope. This should define the primary and secondary data to be measured and to what precision.
image-target-environment#
Type: string
Description:
A description, delineation, and definition of the habitat or environment of study, including boundaries of such
image-target-timescale#
Type: string
Description:
A description, delineation, and definition of the period, interval or temporal environment of the study.
image-spatial-constraints#
Type: string
Description:
A description / definition of the spatial extent of the study area (inside which the photographs were captured), including boundaries and reasons for constraints (e.g. scientific, practical)
image-temporal-constraints#
Type: string
Description:
A description / definition of the temporal extent, including boundaries and reasons for constraints (e.g. scientific, practical)
image-time-synchronisation#
Type: string
Description:
Synchronisation procedure and determined time offsets between camera recording values and UTC
image-item-identification-scheme#
Type: string
Description:
How the images file names are constructed. Should be like this
image-project_image-event_image-sensor_image-datetime.ext
image-curation-protocol#
Type: string
Description:
A description of the image and metadata curation steps and results
image-visual-constraints#
Type: string
Description:
An explanation how the images might be degraded (turbidity, blocked view, …)
image-set-min-latitude-degrees#
Type: number
Limits: [-90, 90]
Description:
The lower bounding box latitude enclosing all images in the set
image-set-max-latitude-degrees#
Type: number
Limits: [-90, 90]
Description:
The upper bounding box latitude enclosing all images in the set
image-set-min-longitude-degrees#
Type: number
Limits: [-180, 180]
Description:
The lower bounding box longitude enclosing all images in the set
image-set-max-longitude-degrees#
Type: number
Limits: [-180, 180]
Description:
The upper bounding box longitude enclosing all images in the set
image-set-related-material#
Type: array
Item Type: object
Description:
Links to other resources that are related to this image set.
Item Properties:
| Field | Type | Description | Required |
|---|---|---|---|
| uri | string | The URI pointing to a related resource | ✔ |
| title | string | A name characterising the resource that is pointed to | ✔ |
| relation | string | A textual explanation how this material is related to this image set | ✔ |
image-set-related-material > uri#
Type: string
Description:
The URI pointing to a related resource
image-set-related-material > title#
Type: string
Description:
A name characterising the resource that is pointed to
image-set-related-material > relation#
Type: string
Description:
A textual explanation how this material is related to this image set
image-set-provenance#
Type: object
Description:
A schema to document the agents, activities and entities that led to an image set entity
Properties:
| Field | Type | Description | Required |
|---|---|---|---|
| provenance-agents | array | A list of all the agents in this provenance documentation | |
| provenance-entities | array | A list of all the entities in this provenance documentation | |
| provenance-activities | array | A list of all the activities in this provenance documentation |
image-set-provenance > provenance-agents#
Type: array
Item Type: object
Description:
A list of all the agents in this provenance documentation
Item Properties:
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | A human-readable identifier of the agent | |
| id | string | A unique identifier for the agent. Could be a uri. |
image-set-provenance > provenance-agents > name#
Type: string
Description:
A human-readable identifier of the agent
image-set-provenance > provenance-agents > id#
Type: string
Description:
A unique identifier for the agent. Could be a uri.
image-set-provenance > provenance-entities#
Type: array
Item Type: object
Description:
A list of all the entities in this provenance documentation
Item Properties:
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | A human-readable identifier of the entity | |
| id | string | A unique identifier for the entity. Could be a uri. | |
| created-at | string | The time at which this entity was created in its entirety | |
| attributed-to | array | A list of agents that relate to this entity | |
| generated-by | array | A list of activities that created this entity |
image-set-provenance > provenance-entities > name#
Type: string
Description:
A human-readable identifier of the entity
image-set-provenance > provenance-entities > id#
Type: string
Description:
A unique identifier for the entity. Could be a uri.
image-set-provenance > provenance-entities > created-at#
Type: string
Description:
The time at which this entity was created in its entirety
image-set-provenance > provenance-entities > attributed-to#
Type: array
Item Type: object
Description:
A list of agents that relate to this entity
Item Properties: image-set-provenance > provenance-agents
image-set-provenance > provenance-entities > generated-by#
Type: array
Item Type: object
Description:
A list of activities that created this entity
Item Properties:
| Field | Type | Description | Required |
|---|---|---|---|
| start-time | string | The time at which the activity began | |
| end-time | string | The time at which the activity ended | |
| associated-agents | array | The agents that are associated to this activity | |
| used-entities | array | The entities that are associated to this activity |
image-set-provenance > provenance-entities > generated-by > start-time#
Type: string
Description:
The time at which the activity began
image-set-provenance > provenance-entities > generated-by > end-time#
Type: string
Description:
The time at which the activity ended
image-set-provenance > provenance-entities > generated-by > associated-agents#
Type: array
Item Type: object
Description:
The agents that are associated to this activity
Item Properties: image-set-provenance > provenance-agents
image-set-provenance > provenance-entities > generated-by > used-entities#
Type: array
Item Type: object
Description:
The entities that are associated to this activity
Item Properties: image-set-provenance > provenance-entities
image-set-provenance > provenance-activities#
Type: array
Item Type: object
Description:
A list of all the activities in this provenance documentation
Item Properties: image-set-provenance > provenance-entities > generated-by