add_metadata

s100py.s111.v1_0.utils.add_metadata(metadata, data_file)

Updates an S111File object based on input metadata.

Parameters:

• data_file – S111File object

• metadata (dict) –

  a dictionary of metadata describing the grids passed in, metadata should have the following key/value pairs:

  • ”productSpecification”: The product specification used to create this dataset.

  • ”horizontalDatumReference”: Reference to the register from which the horizontal datum value is taken.

    ”EPSG” is the default value.

  • ”horizontalDatumValue”: Horizontal Datum of the entire dataset.

  • ”metadata”: File name for the associated discovery metadata (xml)

  • ”epoch”: Code denoting the epoch of the geodetic datum used by the CRS

  • ”geographicIdentifier”: Location of the data, ex: “Chesapeake Bay”.

    An empty string (“”) is the default.

  • ”speedUncertainty”: In (knots) arises from the current meter data on which the model is verified,

    the hydrodynamic model, and the spatial interpolation method. The default, denoting a missing value, is -1.0.

  • ”directionUncertainty”: In (degrees) arises from the current meter data on which the model is verified,

    the hydrodynamic model, and the spatial interpolation method. The default, denoting a missing value, is -1.0.

  • ”verticalUncertainty”: Accuracy of vertical datum

    The default, denoting a missing value, is -1.0.

  • ”horizontalPositionUncertainty”: Accuracy of geolocation techniques, model grid accuracy

    The default, denoting a missing value, is -1.0.

  • ”timeUncertainty”: Sensor accuracy, ata time tagging accuracy

    The default, denoting a missing value, is -1.0.

  • ”surfaceCurrentDepth”: Layer thickness (depthTypeIndex=1) or height (depthTypeIndex=2, 3, 4) (m)

  • ”depthTypeIndex”:

    • ’Layer average’: 1

    • ’Sea surface’: 2

    • ’Vertical datum’: 3

    • ’Sea Bottom’: 4

  • ”commonPointRule”:

    • ’average’: 1

    • ’low’: 2

    • ’high’: 3

    • ’all’: 4

  • ”interpolationType”:

    Interpolation method recommended for evaluation of the S100_GridCoverage.

    • ’nearestneighbor’: 1

    • ’linear’: 2

    • ’quadratic’: 3

    • ’cubic’: 4

    • ’bilinear’: 5

    • ’biquadratic’: 6

    • ’bicubic’: 7

    • ’lostarea’: 8

    • ’barycentric’: 9

    • ’discrete’: 10

  • ”typeOfCurrentData:

    • ’Historical observation (O)’: 1

    • ’Real-time observation (R)’: 2

    • ’Astronomical prediction (A)’: 3

    • ’Analysis or hybrid method (Y)’: 4

    • ’Hydrodynamic model hindcast (M)’: 5

    • ’Hydrodynamic model forecast (F)’: 6

  • ”methodCurrentsProduct”: Brief description of current meter type, forecast method or model, etc.

  • ”dateTimeOfFirstRecord”: Valid time of earliest value, ‘YYYYMMDDTHHMMSSZ’

Returns:

An S111File object updated by this function.

Return type:

data_file