galileoQC.qualitycontrol.checkLatCorr

Check the calculation of the latitude (normal) correction.

Author: Mark Helm Dransfield

Created: ca 2023

License: CC BY-SA

Module Contents

Functions

checkLatCorr

Subtracts the latitude correction in the data file from one calculated using Hinze et al (2005) and the latitude data in the data file. The min, max, mean and standard deviation of the difference is calculated for each line and presented in an extended whisker plot.

_normalGravity

Returns the ellipsoid theoretical gravity in µm/s/s of Hinze et al (2005), eqn 2, based on the GRS80 ellipsoid.

Data

groupName

API

galileoQC.qualitycontrol.checkLatCorr.groupName

None

galileoQC.qualitycontrol.checkLatCorr.checkLatCorr(whizzFile, latCorr, latitude='', lines=[], changeSign=False)

Subtracts the latitude correction in the data file from one calculated using Hinze et al (2005) and the latitude data in the data file. The min, max, mean and standard deviation of the difference is calculated for each line and presented in an extended whisker plot.

Parameters

whizzFile : String or pathlib Path

Name of a HDF5 Whizz file, including path and extension.

latCorr : String

The name of the geoWhizz field or channel containing the latitude correction
(sometimes called "normal gravity").

latitude : String, optional

The name of the geoWhizz field or channel containing the latitude. The
default is to read the latitude field name from the Coordinate Frame.

lines : Array{String}, optional

Array of line numbers as strings. Default = [], meaning all lines are checked.

changeSign : Bool, optional

Occasionally the `latCorr` channel is the latitude effect, which has the opposite
sign to the latitude correction. If changeSign = True, then `-latCorr` is used.
Default False.

Returns

None.

galileoQC.qualitycontrol.checkLatCorr._normalGravity(latitude)

Returns the ellipsoid theoretical gravity in µm/s/s of Hinze et al (2005), eqn 2, based on the GRS80 ellipsoid.

Parameters

latitude : float

latitude in degrees (N pos, S neg).

Returns

latitude_correction : float

ellipsoid theoretical gravity in um/s/s.