transform_ellipse

HSTB.kluster.modules.georeference.transform_ellipse(x, y, z, source_datum, final_datum)

For ellipsoidally relative datums (mllw for instance) the ellipsoid transformation is included in the overall vertical transformation. If vertical reference is ‘ellipse’ we need a separate process to handle this transformation. If the input/output vertical datum is the same (i.e. both are NAD83/GRS80) we can return the existing z. Otherwise, use PROJ to transform from input vertical datum to output vertical datum.

Parameters

  • x (Union[array, DataArray]) – easting for each point in source_datum coordinate system

  • y (Union[array, DataArray]) – northing for each point in source_datum coordinate system

  • z (Union[array, DataArray]) – depth offset for each point in source_datum coordinate system

  • source_datum (CRS) – 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 (CRS) – horizontal coordinate system of the desired output data

Returns

corrected altitude for ellipsoid transformation

Return type

Union[np.array, xr.DataArray]