Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Covmodel arg bugfix: Always convert nugget to float #157

Merged
merged 5 commits into from
Apr 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ All notable changes to **GSTools** will be documented in this file.
- default init guess for `len_scale` is now mean of given bin-centers
- default init guess for `var` and `nugget` is now mean of given variogram values

#### CovModel update ([#109](https://github.com/GeoStat-Framework/GSTools/issues/109), [#122](https://github.com/GeoStat-Framework/GSTools/issues/122))
#### CovModel update ([#109](https://github.com/GeoStat-Framework/GSTools/issues/109), [#122](https://github.com/GeoStat-Framework/GSTools/issues/122), [#157](https://github.com/GeoStat-Framework/GSTools/pull/157))
- add new `rescale` argument and attribute to the `CovModel` class to be able to rescale the `len_scale` (usefull for unit conversion or rescaling `len_scale` to coincide with the `integral_scale` like it's the case with the Gaussian model)
See: [#90](https://github.com/GeoStat-Framework/GSTools/issues/90), [GeoStat-Framework/PyKrige#119](https://github.com/GeoStat-Framework/PyKrige/issues/119)
- added new `len_rescaled` attribute to the `CovModel` class, which is the rescaled `len_scale`: `len_rescaled = len_scale / rescale`
Expand All @@ -82,7 +82,9 @@ All notable changes to **GSTools** will be documented in this file.
- `JBessel`: a hole model valid in all dimensions. The shape parameter controls the dimension it was derived from. For `nu=0.5` this model coincides with the well known `wave` hole model.
- `TPLSimple`: a simple truncated power law controlled by a shape parameter `nu`. Coincides with the truncated linear model for `nu=1`
- `Cubic`: to be compatible with scikit-gstat in the future
- all arguments are now stored as float internally ([#157](https://github.com/GeoStat-Framework/GSTools/pull/157))
- string representation of the `CovModel` class is now using a float precision (`CovModel._prec=3`) to truncate longish output
- string representation of the `CovModel` class now only shows `anis` and `angles` if model is anisotropic resp. rotated
- dimension validity check: raise a warning, if given model is not valid in the desired dimension (See: [#86](https://github.com/GeoStat-Framework/GSTools/issues/86))

#### Normalizer, Trend and Mean ([#124](https://github.com/GeoStat-Framework/GSTools/issues/124))
Expand Down
24 changes: 14 additions & 10 deletions gstools/covmodel/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
.. autosummary::
CovModel
"""
# pylint: disable=C0103, R0201
# pylint: disable=C0103, R0201, E1101

import copy
import numpy as np
Expand Down Expand Up @@ -146,6 +146,7 @@ def __init__(
self._hankel_kw = None
self._sft = None
# prepare parameters (they are checked in dim setting)
self._rescale = None
self._len_scale = None
self._anis = None
self._angles = None
Expand All @@ -170,10 +171,8 @@ def __init__(
self.set_arg_bounds(check_args=False, **bounds)

# set parameters
self._rescale = (
self.default_rescale() if rescale is None else abs(float(rescale))
)
self._nugget = nugget
self.rescale = rescale
self._nugget = float(nugget)
# set anisotropy and len_scale, disable anisotropy for latlon models
self._len_scale, anis = set_len_anis(self.dim, len_scale, anis)
if self.latlon:
Expand All @@ -187,15 +186,15 @@ def __init__(
self._var = None
self.var = var
else:
self._var = var_raw
self._var = float(var_raw)
self._integral_scale = None
self.integral_scale = integral_scale
# set var again, if int_scale affects var_factor
if var_raw is None:
self._var = None
self.var = var
else:
self._var = var_raw
self._var = float(var_raw)
# final check for parameter bounds
self.check_arg_bounds()
# additional checks for the optional arguments (provided by user)
Expand Down Expand Up @@ -894,7 +893,7 @@ def var(self):

@var.setter
def var(self, var):
self._var = var / self.var_factor()
self._var = float(var) / self.var_factor()
self.check_arg_bounds()

@property
Expand All @@ -907,7 +906,7 @@ def var_raw(self):

@var_raw.setter
def var_raw(self, var_raw):
self._var = var_raw
self._var = float(var_raw)
self.check_arg_bounds()

@property
Expand All @@ -917,7 +916,7 @@ def nugget(self):

@nugget.setter
def nugget(self, nugget):
self._nugget = nugget
self._nugget = float(nugget)
self.check_arg_bounds()

@property
Expand All @@ -939,6 +938,11 @@ def rescale(self):
""":class:`float`: Rescale factor for the length scale of the model."""
return self._rescale

@rescale.setter
def rescale(self, rescale):
rescale = self.default_rescale() if rescale is None else rescale
self._rescale = abs(float(rescale))

@property
def len_rescaled(self):
""":class:`float`: The rescaled main length scale of the model."""
Expand Down
48 changes: 18 additions & 30 deletions gstools/covmodel/tools.py
Original file line number Diff line number Diff line change
Expand Up @@ -576,37 +576,25 @@ def model_repr(model): # pragma: no cover
model : :any:`CovModel`
The covariance model in use.
"""
m = model
p = model._prec
opt_str = ""
for opt in model.opt_arg:
opt_str += (
", " + opt + "={0:.{1}}".format(getattr(model, opt), model._prec)
)
if model.latlon:
std_str = (
"{0}(latlon={1}, var={2:.{p}}, len_scale={3:.{p}}, "
"nugget={4:.{p}}{5})".format(
model.name,
model.latlon,
model.var,
model.len_scale,
model.nugget,
opt_str,
p=model._prec,
)
if not np.isclose(m.rescale, m.default_rescale()):
opt_str += f", rescale={m.rescale:.{p}}"
for opt in m.opt_arg:
opt_str += f", {opt}={getattr(m, opt):.{p}}"
# only print anis and angles if model is anisotropic or rotated
ani_str = "" if m.is_isotropic else f", anis={list_format(m.anis, p)}"
ang_str = f", angles={list_format(m.angles, p)}" if m.do_rotation else ""
if m.latlon:
repr_str = (
f"{m.name}(latlon={m.latlon}, var={m.var:.{p}}, "
f"len_scale={m.len_scale:.{p}}, nugget={m.nugget:.{p}}{opt_str})"
)
else:
std_str = (
"{0}(dim={1}, var={2:.{p}}, len_scale={3:.{p}}, "
"nugget={4:.{p}}, anis={5}, angles={6}{7})".format(
model.name,
model.dim,
model.var,
model.len_scale,
model.nugget,
list_format(model.anis, 3),
list_format(model.angles, 3),
opt_str,
p=model._prec,
)
repr_str = (
f"{m.name}(dim={m.dim}, var={m.var:.{p}}, "
f"len_scale={m.len_scale:.{p}}, nugget={m.nugget:.{p}}"
f"{ani_str}{ang_str}{opt_str})"
)
return std_str
return repr_str