check_points
Check if points are within a tide model domain
Can check OTIS format tidal solutions provided by Ohio State University and ESR
Can check Global Tide Model (GOT) solutions provided by Richard Ray at GSFC
Can check Finite Element Solution (FES) models provided by AVISO
Calling Sequence
import pyTMD
valid = pyTMD.check_points(x, y, DIRECTORY=DIRECTORY, MODEL=MODEL, EPSG=3031)
- pyTMD.check_points(x: ndarray, y: ndarray, DIRECTORY: str | pathlib.Path | None = None, MODEL: str | None = None, ATLAS_FORMAT: str = 'netcdf', GZIP: bool = False, DEFINITION_FILE: str | pathlib.Path | None = None, EPSG: str | int = 3031, METHOD: str = 'spline')[source]
Check if points are within a tide model domain
- Parameters
- x: np.ndarray
x-coordinates in projection EPSG
- y: np.ndarray
y-coordinates in projection EPSG
- DIRECTORY: str or NoneType, default None
working data directory for tide models
- MODEL: str or NoneType, default None
Tide model to use
- ATLAS_FORMAT: str, default ‘netcdf’
ATLAS tide model format
'OTIS'
'netcdf'
- GZIP: bool, default False
Tide model files are gzip compressed
- DEFINITION_FILE: str or NoneType, default None
Tide model definition file for use
- EPSG: str or int, default: 3031 (Polar Stereographic South, WGS84)
Input coordinate system
- METHOD: str, default ‘spline’
interpolation method
`bilinear`
: quick bilinear interpolation`spline`
: scipy bivariate spline interpolation`linear`
,`nearest`
: scipy regular grid interpolations
- Returns
- valid: bool
array describing if input coordinate is within model domain