ocmw.calval.xtrackReader module

Tools for loading XTrack harmonic data and identifying points that lie within a model domain for surface elevation Cal/Val.

isInDomain

Test whether a point is inside the model domain extent

isInPolygon

Test whether a point is inside the model domain polygon

latlon2utm

Convert lat/lon to easting/northing

readConstitName

Get tidal constituent name

extractXTrackValues

Extract the XTrack data values

loadVars

Load the XTrack data from netCDF into a data dictionary.

getPointsInDomain

Identify the XTrack record points that lie within the model domain extent

getPointsInPolygon

Identify the XTrack record points that lie within the model domain polygon

Data loader for XTRACK netCDF4 dat files

Version: 0.0 Author: C.P. Old

History: 28 January 2020 - Initial code creation and testing

ocmw.calval.xtrackReader.isInDomain(east, north, domain)[source]

Test whether a point is inside the model domain extent

ocmw.calval.xtrackReader.isInPolygon(east, north, polygon)[source]

Test whether a point is inside the model domain polygon

ocmw.calval.xtrackReader.latlon2utm(lat, lon, zone=30, region='N')[source]

Convert lat/lon to easting/northing

ocmw.calval.xtrackReader.readConstitName(constit)[source]

Get tidal constituent name

ocmw.calval.xtrackReader.extractXTrackValues(xtvars, index)[source]

Extract the XTrack data values

ocmw.calval.xtrackReader.loadVars(ncfile)[source]

Load the XTrack data from netCDF into a data dictionary.

ocmw.calval.xtrackReader.getPointsInDomain(xtvars, domain)[source]

Identify the XTrack record points that lie within the model domain extent

ocmw.calval.xtrackReader.getPointsInPolygon(xtvars, polygon)[source]

Identify the XTrack record points that lie within the model domain polygon