Schema for Crowdsourced Bathymetry data and metadata, version 3.0.0

Type: object

root type
Type: enum (of string)

Must be one of:

  • "FeatureCollection"

root crs
Type: object

root crs horizontal
Type: object

root crs horizontal type
Type: enum (of string)

Must be one of:

  • "EPSG"

root crs horizontal value
Type: integer

Value must be greater or equal to 1024 and lesser or equal to 32767

root crs vertical
Type: enum (of string)

Must be one of:

  • "Transducer"

root properties
Type: object

root properties providerContactPoint
Type: object

root properties providerContactPoint orgName
Type: string

The Trusted Node’s name, in free-text format.

root properties providerContactPoint email
Type: string

A free-text field for the Trusted Node’s email address, so that data users can contact the Trusted Node with questions about the data.

Must match regular expression: ^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,6}$

root properties providerContactPoint logger
Type: string

The software program or hardware logger used to log the data.

root properties providerContactPoint loggerVersion
Type: string

The software or hardware logger version.

root properties convention
Type: enum (of string)

This field describes the format and version for the data and metadata, such as GeoJSON, CSV, or XYZT. Reference the version of the CSB data convention (e.g., CSB 2.0, CSB 3.0) where possible.

Must be one of:

  • "GeoJSON CSB 3.0"

root properties dataLicense
Type: string

The license under which the Trusted Node is
providing CSB data to the IHO DCDB.

root properties platform
Type: object

root properties platform uniqueID
Type: string

Generated by the Trusted Node, this number identifies the Trusted Node and uniquely identifies the contributing vessel. The characters preceding the hyphen (-) identify the Trusted Node, followed by a hyphen (-), and then the vessel’s unique identifier. The UUID assigned by the Trusted Node is consistent for each contributing vessel, throughout the life of service of the vessel. However, if the vessel chooses to remain anonymous to data users, the Trusted Node does not need to publish the vessel name in association with the UUID.

 Must match regular expression: ^([0-9a-zA-Z]{2,}(-[0-9a-zA-Z]{2,})+)$

root properties platform correctors
Type: object

root properties platform correctors positionReferencePoint
Type: enum (of string)

Must be one of:

  • "GNSS"

root properties platform correctors soundSpeedDocumented
Type: boolean

Some systems may have the ability to provide sound speed data and correct the sounding. If details regarding such corrections are known (“True”), it is strongly recommended that the ‘Sound Speed Correction’ field in Table 4 be populated. If “False”, no information about how sound speed was applied has been recorded.

root properties platform correctors positionOffsetsDocumented
Type: boolean

Describes whether the final vessel position (longitude and latitude) has been corrected for the lateral and longitudinal offsets between the GNSS receiver and the transducer (“True”), or if they were not (“False”). If “True”, the position element of the sensor description field in Table 3 should be populated.

root properties platform correctors dataProcessed
Type: boolean

Raw data, without tidal corrections or additional processing, are preferable as a contribution to the IHO DCDB. This field allows the data contributor to state whether the data has been processed or corrected (‘True’) or not (‘False’). If ‘True’, it is strongly recommended that detailed information be captured in optional metadata fields as outlined in section 3.3.4. If ‘False’, information in section 3.3.4 is not needed.

root properties platform correctors motionOffsetsApplied
Type: boolean

Describes whether vessel motion has been corrected for.

root properties platform correctors draftApplied
Type: boolean

Describes whether vessel draft has been corrected for.

root properties platform type
Type: string

The type of vessel collecting the data, such as a cargo ship, fishing vessel, private vessel,
research vessel, etc.

root properties platform name
Type: string

The name of the vessel, in open string format.

root properties platform length
Type: integer

The length overall (LOA) of the vessel, expressed as a positive value, in metres, to the nearest metre.

Value must be greater or equal to 1

root properties platform IDType
Type: enum (of string)

ID numbers used to uniquely identify vessels. Currently, only two types are available: Maritime Mobile Service Identity (MMSI) or International Maritime Organization (IMO) number. The MMSI number is used to uniquely identify a vessel through services such as AIS. The IMO number is linked to a vessel for its lifetime, regardless of change in flag or ownership. Contributors may select only one ID Type.

Must be one of:

  • "MMSI"
  • "IMO"

root properties platform IDNumber

The value for the ID Type. MMSI numbers are often nine digits, while IMO numbers are the letters “IMO,” followed by a seven-digit number.

root properties platform IDNumber oneOf IDNumber_MMSI
Type: integer

Value must be greater or equal to 100000000 and lesser or equal to 999999999

root properties platform IDNumber oneOf IDNumber_IMO
Type: integer

Value must be greater or equal to 1000000 and lesser or equal to 9999999

root properties platform sensors
Type: array

Composite element containing all information about a given sensor in use on the collection platform. Minimum specification of fields as shown; some sensors may have additional fields (e.g., frequency for an echo sounder). Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root properties platform sensors sensors items

root properties platform sensors sensors items oneOf SensorDescriptionSounder
Type: object

root properties platform sensors sensors items oneOf item 0 type
Type: enum (of string)

Must be one of:

  • "Sounder"

root properties platform sensors sensors items oneOf item 0 make
Type: string

Sensor manufacturer

root properties platform sensors sensors items oneOf item 0 model
Type: string

Sensor model

root properties platform sensors sensors items oneOf item 0 position
Type: array of number

Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)

Must contain a minimum of 3 items

Must contain a maximum of 3 items

No Additional Items

Each item of this array must be:

root properties platform sensors sensors items oneOf item 0 position position items
Type: number

root properties platform sensors sensors items oneOf item 0 draft
Type: number

Draft of vessel

root properties platform sensors sensors items oneOf item 0 frequency
Type: number

Frequency of echo sounder

root properties platform sensors sensors items oneOf item 0 transducer
Type: string

Transducer used with echo sounder
root properties platform sensors sensors items oneOf SensorDescriptionIMU
Type: object

root properties platform sensors sensors items oneOf item 1 type
Type: enum (of string)

Must be one of:

  • "MotionSensor"

root properties platform sensors sensors items oneOf item 1 position
Type: array of number

Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)

Same definition as position
root properties platform sensors sensors items oneOf SensorDescriptionGNSS
Type: object

root properties platform sensors sensors items oneOf item 2 type
Type: enum (of string)

Must be one of:

  • "GNSS"

root properties platform sensors sensors items oneOf item 2 position
Type: array of number

Position is given from the PRP (Position Reference Point) in metres. The offsets are positive NED (North (Bow), East (Starboard), Down)

Same definition as position

root properties algorithms
Type: array of object

Array of algorithms applied to the data.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root properties algorithms algorithms items
Type: object

The following properties are required:

  • name
  • Params

root lineage
Type: array

List of processing steps recorded for the data

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root lineage lineage items

root lineage lineage items oneOf ProcessingTimeStampInterpolation
Type: object

Method by which times are assigned to data being recorded.

root lineage lineage items oneOf item 0 type
Type: enum (of string)

Must be one of:

  • "TimeInterpolation"

root lineage lineage items oneOf item 0 timestamp
Type: string

RFC3339 UTC time stamp (note: version 3.0.0 allows timezone naive timestamps).

 Must match regular expression: ^([0-9]+)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)([.][0-9]+)?[Zz]?$

root lineage lineage items oneOf item 0 detail
Type: object

root lineage lineage items oneOf item 0 detail source
Type: string

The source of the time interpolation, e.g., SystemTime | ZDA | RMC | ...

root lineage lineage items oneOf item 0 detail method
Type: string

The method of time interpolation, e.g., Midway | ElapsedTime | DataSource | NTP | PTP | ...

root lineage lineage items oneOf item 0 detail comment
Type: string

Comments regarding the source and method of time interpolation.
root lineage lineage items oneOf ProcessingCRSTransformation
Type: object

Processing that transformed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.

root lineage lineage items oneOf item 1 type
Type: enum (of string)

Must be one of:

  • "CRSTransformation"

root lineage lineage items oneOf item 1 timestamp
Type: string

RFC3339 UTC time stamp (note: version 3.0.0 allows timezone naive timestamps).

Same definition as timestamp

root lineage lineage items oneOf item 1 detail
Type: object

root lineage lineage items oneOf item 1 detail origin
Type: string

CRS name as an EPSG string.

 Must match regular expression: ^EPSG:(3276[0-7]$|327[0-5]\d$|32[0-6]\d\d$|3[0-1]\d\d\d$|[1-2][0-9]{4}$|102[4-9]|10[3-9][0-9]$|1[1-9][0-9][0-9]$|[2-9][0-9][0-9][0-9]$)

root lineage lineage items oneOf item 1 detail destination
Type: string

CRS name as an EPSG string.

Same definition as origin

root lineage lineage items oneOf item 1 detail method
Type: string

Method used to change coordinates (e.g., GeoTrans).
root lineage lineage items oneOf ProcessingCRS
Type: object

Processing that transformed the reference system of the data. Must include the original and destination coordinate reference system, and the method used to change.

root lineage lineage items oneOf item 2 type
Type: enum (of string)

Must be one of:

  • "CRS"

root lineage lineage items oneOf item 2 timestamp
Type: string

RFC3339 UTC time stamp (note: version 3.0.0 allows timezone naive timestamps).

Same definition as timestamp

root lineage lineage items oneOf item 2 detail
Type: object

root lineage lineage items oneOf item 2 detail type
Type: enum (of string)

Must be one of:

  • "EPSG"

root lineage lineage items oneOf item 2 detail comment
Type: string

Comments regarding method used to change coordinates (e.g., GeoTrans).
root lineage lineage items oneOf ProcessingVerticalReduction
Type: object

Steps taken to reduce raw data to a vertical reference system (Chart Datum, MSL, ellipsoid, water level, etc.). Must include the vertical reference system, and method used.

root lineage lineage items oneOf item 3 type
Type: enum (of string)

Must be one of:

  • "VerticalReduction"

root lineage lineage items oneOf item 3 timestamp
Type: string

RFC3339 UTC time stamp (note: version 3.0.0 allows timezone naive timestamps).

Same definition as timestamp

root lineage lineage items oneOf item 3 detail
Type: object

root lineage lineage items oneOf item 3 detail reference
Type: string

Vertical reference system, e.g., Chart Datum, MSL, ellipsoid, water level, etc.

root lineage lineage items oneOf item 3 detail method
Type: string

Method used to reduce raw data to vertical reference system, e.g., ObservedWL | PredictedWL | ModelledWL | EllipsoidReduction | ...

root lineage lineage items oneOf item 3 detail model
Type: string

Model used for reduction of raw data to vertical reference system, e.g., CANNORTH2016v1HyVSEPNAD83v6CD | StationReference | VDatum | VORF | ...

root lineage lineage items oneOf item 3 detail comment
Type: string

Comments regarding the vertical reduction.
root lineage lineage items oneOf ProcessingGNSS
Type: object

Steps taken to post-process or improve horizontal and vertical positioning.

root lineage lineage items oneOf item 4 type
Type: enum (of string)

Must be one of:

  • "GNSSProcessing"

root lineage lineage items oneOf item 4 timestamp
Type: string

RFC3339 UTC time stamp (note: version 3.0.0 allows timezone naive timestamps).

Same definition as timestamp

root lineage lineage items oneOf item 4 detail
Type: object

root lineage lineage items oneOf item 4 detail algorithm
Type: string

Algorithm used for GNSS post-processing, e.g., RTKLib | CSRS-PPP | ...

root lineage lineage items oneOf item 4 detail version
Type: string

Version of GNSS post-processing algorithm method used.

root lineage lineage items oneOf item 4 detail comment
Type: string

Comments regarding the algorithm used for GNSS processing.
root lineage lineage items oneOf ProcessingSoundSpeedCorrection
Type: object

Correction to soundings for sound speed in the water.

root lineage lineage items oneOf item 5 type
Type: enum (of string)

Must be one of:

  • "SoundSpeedCorrection"

root lineage lineage items oneOf item 5 timestamp
Type: string

RFC3339 UTC time stamp (note: version 3.0.0 allows timezone naive timestamps).

Same definition as timestamp

root lineage lineage items oneOf item 5 detail
Type: object

root lineage lineage items oneOf item 5 detail Source
Type: string

Source of correction to soundings, e.g., Model | Profile | GeometricMean | Fixed | CarterTable | MatthewTable | WOA13 |...

root lineage lineage items oneOf item 5 detail algorithm
Type: string

Algorithm for sound speed correction, e.g., CIDCO-Ocean | Raytraced | ...

root lineage lineage items oneOf item 5 detail version
Type: string

Version of sound speed algorithm method used.

root lineage lineage items oneOf item 5 detail comment
Type: string

Comments regarding the algorithm used for sound speed correction.
root lineage lineage items oneOf ProcessingUncertainty
Type: object

Algorithm for estimating horizontal and vertical uncertainty of soundings.

root lineage lineage items oneOf item 6 type
Type: enum (of string)

Must be one of:

  • "Uncertainty"

root lineage lineage items oneOf item 6 timestamp
Type: string

RFC3339 UTC time stamp (note: version 3.0.0 allows timezone naive timestamps).

Same definition as timestamp

root lineage lineage items oneOf item 6 detail
Type: object

root lineage lineage items oneOf item 6 detail name
Type: string

Name of uncertainty estimation algorithm

root lineage lineage items oneOf item 6 detail parameters
Type: string

Parameters used in application of uncertainty estimation algorithm.

root lineage lineage items oneOf item 6 detail version
Type: string

Version of uncertainty estimation algorithm used.

root lineage lineage items oneOf item 6 detail comment
Type: string

Explanatory text related to uncertainty estimation algorithm or its inputs/outputs

root lineage lineage items oneOf item 6 detail reference
Type: string

Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.
root lineage lineage items oneOf ProcessingVerticalOffsetAnalysis
Type: object

Analysis of vertical offsets of soundings recorded by intersecting track lines.

root lineage lineage items oneOf item 7 type
Type: enum (of string)

Must be one of:

  • "VerticalOffsetAnalysis"

root lineage lineage items oneOf item 7 timestamp
Type: string

RFC3339 UTC time stamp (note: version 3.0.0 allows timezone naive timestamps).

Same definition as timestamp

root lineage lineage items oneOf item 7 detail
Type: object

root lineage lineage items oneOf item 7 detail name
Type: string

Name of vertical offset analysis algorithm.

root lineage lineage items oneOf item 7 detail version
Type: string

Version of vertical offset analysis algorithm used.

root lineage lineage items oneOf item 7 detail offsets
Type: array

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root lineage lineage items oneOf item 7 detail offsets VerticalOffsetAnalysisOffset
Type: object

root lineage lineage items oneOf item 7 detail reference
Type: string

Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.

root lineage lineage items oneOf item 7 detail comment
Type: string

Explanatory text related to vertical offset analysis algorithm or its inputs/outputs

root lineage lineage items oneOf item 7 detail analysis
Type: array

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root lineage lineage items oneOf item 7 detail analysis VerticalOffsetAnalysisAnalysisMeta
Type: object

root lineage lineage items oneOf item 7 detail analysis analysis items reference
Type: string

Source (e.g., paper, project, library) of the algorithm applied. Formats can be: DOI, URL or other.

root lineage lineage items oneOf item 7 detail analysis analysis items comment
Type: string

Explanatory text related to analysis or its inputs/outputs
root lineage lineage items oneOf ProcessingAlgorithm
Type: object

General algorithm used to triage data

root lineage lineage items oneOf item 8 type
Type: enum (of string)

Must be one of:

  • "algorithm"

root lineage lineage items oneOf item 8 timestamp
Type: string

RFC3339 UTC time stamp (note: version 3.0.0 allows timezone naive timestamps).

Same definition as timestamp

root lineage lineage items oneOf item 8 detail
Type: object

root lineage lineage items oneOf item 8 detail name
Type: string

Examples: deduplicate, uncertainty estimation, manual editing.

root lineage lineage items oneOf item 8 detail parameters
Type: string

Parameters used in data processing.

root lineage lineage items oneOf item 8 detail comment
Type: string

Explanatory text related to algorithm or its outputs.

root features
Type: array
No Additional Items

Each item of this array must be:

root features GeoJSON Feature

GeoJSON Feature

Type: object

root features GeoJSON Feature type
Type: enum (of string)

Must be one of:

  • "Feature"

root features GeoJSON Feature properties
Type: object

root features GeoJSON Feature properties depth
Type: number

The distance from the vertical reference point to the seafloor. Should be collected as a positive value, in metres, with decimetre precision.

root features GeoJSON Feature properties time
Type: string

The date and UTC time stamp for the depth measurement as well as can be determined, ideally to millisecond precision in RFC3339 format.

Same definition as timestamp

root features GeoJSON Feature geometry

root features GeoJSON Feature geometry oneOf item 0
Type: null
root features GeoJSON Feature geometry oneOf GeoJSON Point

GeoJSON Point

Type: object

root features GeoJSON Feature geometry oneOf GeoJSON Point type
Type: enum (of string)

Must be one of:

  • "Point"

root features GeoJSON Feature geometry oneOf GeoJSON Point coordinates
Type: array of number

Must contain a minimum of 2 items

No Additional Items

Each item of this array must be:

root features GeoJSON Feature geometry oneOf GeoJSON Point coordinates coordinates items
Type: number

root features GeoJSON Feature geometry oneOf GeoJSON Point bbox
Type: array of number

Must contain a minimum of 4 items

No Additional Items

Each item of this array must be:

root features GeoJSON Feature geometry oneOf GeoJSON Point bbox bbox items
Type: number