Skip to content

Commit 7494ca1

Browse files
MuellerSebMuellerSeb
authored
Merge pull request #245 from GeoStat-Framework/gstools_latlon_fix
GSTools: support latlon models for geographic coordinates
2 parents abbbd10 + bfead32 commit 7494ca1

File tree

6 files changed

+79
-12
lines changed

6 files changed

+79
-12
lines changed

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ sklearn = ["scikit-learn>=0.19"]
7070
test = [
7171
"pytest-cov>=3",
7272
"scikit-learn>=0.19",
73-
# "gstools>=1.3,<2",
73+
"gstools>=1.4,<2",
7474
]
7575

7676
[project.urls]

‎src/pykrige/compat_gstools.py‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# coding: utf-8
2+
# pylint: disable= invalid-name, unused-import
3+
"""For GSTools compatibility."""
4+
5+
# gstools
6+
try:
7+
import gstools as gs
8+
9+
GSTOOLS_INSTALLED = True
10+
GSTOOLS_VERSION = list(map(int, gs.__version__.split(".")[:2]))
11+
except ImportError:
12+
gs = None
13+
GSTOOLS_INSTALLED = False
14+
GSTOOLS_VERSION = None
15+
16+
17+
class GSToolsException(Exception):
18+
"""Exception for GSTools."""
19+
20+
21+
def validate_gstools(model):
22+
"""Validate presence of GSTools."""
23+
if not GSTOOLS_INSTALLED:
24+
raise GSToolsException(
25+
"GSTools needs to be installed in order to use their CovModel class."
26+
)
27+
if not isinstance(model, gs.CovModel):
28+
raise GSToolsException(
29+
"GSTools: given variogram model is not a CovModel instance."
30+
)
31+
if GSTOOLS_VERSION < [1, 3]:
32+
raise GSToolsException("GSTools: need at least GSTools v1.3.")
33+
if model.latlon and GSTOOLS_VERSION < [1, 4]:
34+
raise GSToolsException(
35+
"GSTools: latlon models in PyKrige are only supported from GSTools v1.4."
36+
)

‎src/pykrige/ok.py‎

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
from scipy.spatial.distance import cdist
2929

3030
from . import core, variogram_models
31+
from .compat_gstools import validate_gstools
3132
from .core import (
3233
P_INV,
3334
_adjust_for_anisotropy,
@@ -217,12 +218,20 @@ def __init__(
217218
raise ValueError("exact_values has to be boolean True or False")
218219
self.exact_values = exact_values
219220

221+
self.coordinates_type = coordinates_type
222+
220223
# check if a GSTools covariance model is given
221224
if hasattr(self.variogram_model, "pykrige_kwargs"):
222225
# save the model in the class
223226
self.model = self.variogram_model
224-
if self.model.dim == 3:
227+
validate_gstools(self.model)
228+
if self.model.field_dim == 3:
225229
raise ValueError("GSTools: model dim is not 1 or 2")
230+
# check if coordinate types match
231+
if self.model.latlon and (self.coordinates_type == "euclidean"):
232+
raise ValueError(
233+
"GSTools: latlon models require geographic coordinates"
234+
)
226235
self.variogram_model = "custom"
227236
variogram_function = self.model.pykrige_vario
228237
variogram_parameters = []
@@ -265,7 +274,7 @@ def __init__(
265274

266275
# adjust for anisotropy... only implemented for euclidean (rectangular)
267276
# coordinates, as anisotropy is ambiguous for geographic coordinates...
268-
if coordinates_type == "euclidean":
277+
if self.coordinates_type == "euclidean":
269278
self.XCENTER = (np.amax(self.X_ORIG) + np.amin(self.X_ORIG)) / 2.0
270279
self.YCENTER = (np.amax(self.Y_ORIG) + np.amin(self.Y_ORIG)) / 2.0
271280
self.anisotropy_scaling = anisotropy_scaling
@@ -278,7 +287,7 @@ def __init__(
278287
[self.anisotropy_scaling],
279288
[self.anisotropy_angle],
280289
).T
281-
elif coordinates_type == "geographic":
290+
elif self.coordinates_type == "geographic":
282291
# Leave everything as is in geographic case.
283292
# May be open to discussion?
284293
if anisotropy_scaling != 1.0:
@@ -298,7 +307,6 @@ def __init__(
298307
"Only 'euclidean' and 'geographic' are valid "
299308
"values for coordinates-keyword."
300309
)
301-
self.coordinates_type = coordinates_type
302310

303311
if self.verbose:
304312
print("Initializing variogram model...")
@@ -422,8 +430,14 @@ def update_variogram_model(
422430
if hasattr(self.variogram_model, "pykrige_kwargs"):
423431
# save the model in the class
424432
self.model = self.variogram_model
425-
if self.model.dim == 3:
433+
validate_gstools(self.model)
434+
if self.model.field_dim == 3:
426435
raise ValueError("GSTools: model dim is not 1 or 2")
436+
# check if coordinate types match
437+
if self.model.latlon and (self.coordinates_type == "euclidean"):
438+
raise ValueError(
439+
"GSTools: latlon models require geographic coordinates"
440+
)
427441
self.variogram_model = "custom"
428442
variogram_function = self.model.pykrige_vario
429443
variogram_parameters = []

‎src/pykrige/ok3d.py‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
from scipy.spatial.distance import cdist
2828

2929
from . import core, variogram_models
30+
from .compat_gstools import validate_gstools
3031
from .core import (
3132
P_INV,
3233
_adjust_for_anisotropy,
@@ -234,7 +235,8 @@ def __init__(
234235
if hasattr(self.variogram_model, "pykrige_kwargs"):
235236
# save the model in the class
236237
self.model = self.variogram_model
237-
if self.model.dim < 3:
238+
validate_gstools(self.model)
239+
if self.model.field_dim < 3:
238240
raise ValueError("GSTools: model dim is not 3")
239241
self.variogram_model = "custom"
240242
variogram_function = self.model.pykrige_vario
@@ -430,7 +432,8 @@ def update_variogram_model(
430432
if hasattr(self.variogram_model, "pykrige_kwargs"):
431433
# save the model in the class
432434
self.model = self.variogram_model
433-
if self.model.dim < 3:
435+
validate_gstools(self.model)
436+
if self.model.field_dim < 3:
434437
raise ValueError("GSTools: model dim is not 3")
435438
self.variogram_model = "custom"
436439
variogram_function = self.model.pykrige_vario

‎src/pykrige/uk.py‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
from scipy.spatial.distance import cdist
2727

2828
from . import core, variogram_models
29+
from .compat_gstools import validate_gstools
2930
from .core import (
3031
P_INV,
3132
_adjust_for_anisotropy,
@@ -267,8 +268,13 @@ def __init__(
267268
if hasattr(self.variogram_model, "pykrige_kwargs"):
268269
# save the model in the class
269270
self.model = self.variogram_model
270-
if self.model.dim == 3:
271+
validate_gstools(self.model)
272+
if self.model.field_dim == 3:
271273
raise ValueError("GSTools: model dim is not 1 or 2")
274+
if self.model.latlon:
275+
raise ValueError(
276+
"GSTools: latlon models not supported for universal kriging"
277+
)
272278
self.variogram_model = "custom"
273279
variogram_function = self.model.pykrige_vario
274280
variogram_parameters = []
@@ -673,8 +679,13 @@ def update_variogram_model(
673679
if hasattr(self.variogram_model, "pykrige_kwargs"):
674680
# save the model in the class
675681
self.model = self.variogram_model
676-
if self.model.dim == 3:
682+
validate_gstools(self.model)
683+
if self.model.field_dim == 3:
677684
raise ValueError("GSTools: model dim is not 1 or 2")
685+
if self.model.latlon:
686+
raise ValueError(
687+
"GSTools: latlon models not supported for universal kriging"
688+
)
678689
self.variogram_model = "custom"
679690
variogram_function = self.model.pykrige_vario
680691
variogram_parameters = []

‎src/pykrige/uk3d.py‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
from scipy.spatial.distance import cdist
2727

2828
from . import core, variogram_models
29+
from .compat_gstools import validate_gstools
2930
from .core import (
3031
P_INV,
3132
_adjust_for_anisotropy,
@@ -262,7 +263,8 @@ def __init__(
262263
if hasattr(self.variogram_model, "pykrige_kwargs"):
263264
# save the model in the class
264265
self.model = self.variogram_model
265-
if self.model.dim < 3:
266+
validate_gstools(self.model)
267+
if self.model.field_dim < 3:
266268
raise ValueError("GSTools: model dim is not 3")
267269
self.variogram_model = "custom"
268270
variogram_function = self.model.pykrige_vario
@@ -515,7 +517,8 @@ def update_variogram_model(
515517
if hasattr(self.variogram_model, "pykrige_kwargs"):
516518
# save the model in the class
517519
self.model = self.variogram_model
518-
if self.model.dim < 3:
520+
validate_gstools(self.model)
521+
if self.model.field_dim < 3:
519522
raise ValueError("GSTools: model dim is not 3")
520523
self.variogram_model = "custom"
521524
variogram_function = self.model.pykrige_vario

0 commit comments

Comments
 (0)