transform_vyperdatum

HSTB.kluster.modules.georeference.transform_vyperdatum(x, y, z, source_datum='nad83', final_datum='mllw', vdatum_directory=None, horizontal_crs=None)

When we specify a NOAA vertical datum (NOAA Mean Lower Low Water, NOAA Mean High Water) in Kluster, we use vyperdatum/VDatum to transform the points to the appropriate vertical datum.

Parameters

  • x (array) – longitude for each point in source_datum coordinate system

  • y (array) – latitude for each point in source_datum coordinate system

  • z (array) – depth offset for each point in source_datum coordinate system

  • source_datum (Union[str, int]) – The horizontal coordinate system of the xyz provided, should be a string identifier (‘nad83’) or an EPSG code specifying the horizontal coordinate system

  • final_datum (str) – The desired final_datum vertical datum as a string (one of ‘mllw’, ‘mhw’)

  • vdatum_directory (Optional[str]) – if ‘NOAA MLLW’ ‘NOAA MHW’ is the vertical reference, a path to the vdatum directory is required here

  • horizontal_crs (Optional[CRS]) – if included here, we use it to determine if we should include an output datum, which can be used to determine a 3d shift

Returns

  • xr.DataArray – original z array with vertical transformation applied, this new z is at final_datum

  • xr.DataArray – uncertainty associated with the vertical transformation between the source and destination datum