compute_geoidal_undulation.py

Computes geoid undulations from a gravity model for an input file (ascii, netCDF4, HDF5, GTiff, cog)

Calling Sequence

usage: compute_geoidal_undulation.py [-h] [--gravity GRAVITY] [--lmax LMAX]
                                     [--tide {tide_free,mean_tide,zero_tide}]
                                     [--radius RADIUS]
                                     [--format {csv,netCDF4,HDF5,GTiff,cog}]
                                     [--variables VARIABLES [VARIABLES ...]]
                                     [--header HEADER] [--type {drift,grid}]
                                     [--projection PROJECTION] [--verbose]
                                     [--mode MODE]
                                     [infile] [outfile]

Positional Arguments

infile: Input file to run
outfile: Computed output file

Named Arguments

--gravity, -G

Gravity model file to use

--lmax, -l

Maximum spherical harmonic degree

--tide, -T

tide system of output geoid

'tide_free': no permanent direct and indirect tidal potentials
'mean_tide': permanent tidal potentials (direct and indirect)
'zero_tide': permanent direct tidal potential removed

--radius, -R

Gaussian smoothing radius (km)

--format, -F

Possible choices: csv, netCDF4, HDF5, GTiff, cog

Input and output data format

--variables, -v

Variable names of data in input file

--header, -H

Number of header lines for csv files

--type, -t

Possible choices: drift, grid

Input data type

'drift': drift buoys or satellite/airborne altimetry (time per data point)
'grid': spatial grids or images (single time for all data points)

--projection, -P

Spatial projection as EPSG code or PROJ4 string

4326: latitude and longitude coordinates on WGS84 reference ellipsoid

--verbose, -V

Verbose output of run

--mode, -M

Permission mode of output file