Skip to content

Commit 4763026

Browse files
committed
Updates doc with nugget hint
1 parent 8445ba5 commit 4763026

4 files changed

Lines changed: 32 additions & 9 deletions

File tree

pykrige/ok.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
----------
1616
.. [1] P.K. Kitanidis, Introduction to Geostatistcs: Applications in
1717
Hydrogeology, (Cambridge University Press, 1997) 272 p.
18+
.. [2] N. Cressie, Statistics for spatial data,
19+
(Wiley Series in Probability and Statistics, 1993) 137 p.
1820
1921
Copyright (c) 2015-2020, PyKrige Developers
2022
"""
@@ -142,8 +144,12 @@ class OrdinaryKriging:
142144
[0, 360] and latitudes in [-90, 90]. Default is 'euclidean'.
143145
exact_values : bool, optional
144146
If True, interpolation provides input values at input locations.
145-
If False interpolation accounts for variance within input values
146-
at input locations and does not behave as an exact-interpolator [2].
147+
If False, interpolation accounts for variance/nugget within input
148+
values at input locations and does not behave as an
149+
exact-interpolator [2]. Note that this only has an effect if
150+
there is variance/nugget present within the input data since it is
151+
interpreted as measurement error. If the nugget is zero, the kriged
152+
field will behave as an exact interpolator.
147153
148154
References
149155
----------

pykrige/ok3d.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
----------
1515
.. [1] P.K. Kitanidis, Introduction to Geostatistcs: Applications in
1616
Hydrogeology, (Cambridge University Press, 1997) 272 p.
17+
.. [2] N. Cressie, Statistics for spatial data,
18+
(Wiley Series in Probability and Statistics, 1993) 137 p.
1719
1820
Copyright (c) 2015-2020, PyKrige Developers
1921
"""
@@ -153,8 +155,12 @@ class OrdinaryKriging3D:
153155
Enables plotting to display variogram. Default is False (off).
154156
exact_values : bool, optional
155157
If True, interpolation provides input values at input locations.
156-
If False interpolation accounts for variance within input values
157-
at input locations and does not behave as an exact-interpolator [2].
158+
If False, interpolation accounts for variance/nugget within input
159+
values at input locations and does not behave as an
160+
exact-interpolator [2]. Note that this only has an effect if
161+
there is variance/nugget present within the input data since it is
162+
interpreted as measurement error. If the nugget is zero, the kriged
163+
field will behave as an exact interpolator.
158164
159165
References
160166
----------

pykrige/uk.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
----------
1616
.. [1] P.K. Kitanidis, Introduction to Geostatistcs: Applications in
1717
Hydrogeology, (Cambridge University Press, 1997) 272 p.
18-
18+
.. [2] N. Cressie, Statistics for spatial data,
19+
(Wiley Series in Probability and Statistics, 1993) 137 p.
1920
Copyright (c) 2015-2020, PyKrige Developers
2021
"""
2122
import numpy as np
@@ -174,8 +175,12 @@ class UniversalKriging:
174175
Enables plotting to display variogram. Default is False (off).
175176
exact_values : bool, optional
176177
If True, interpolation provides input values at input locations.
177-
If False interpolation accounts for variance within input values
178-
at input locations and does not behave as an exact-interpolator [2].
178+
If False, interpolation accounts for variance/nugget within input
179+
values at input locations and does not behave as an
180+
exact-interpolator [2]. Note that this only has an effect if
181+
there is variance/nugget present within the input data since it is
182+
interpreted as measurement error. If the nugget is zero, the kriged
183+
field will behave as an exact interpolator.
179184
180185
References
181186
----------

pykrige/uk3d.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
----------
1515
.. [1] P.K. Kitanidis, Introduction to Geostatistcs: Applications in
1616
Hydrogeology, (Cambridge University Press, 1997) 272 p.
17+
.. [2] N. Cressie, Statistics for spatial data,
18+
(Wiley Series in Probability and Statistics, 1993) 137 p.
1719
1820
Copyright (c) 2015-2020, PyKrige Developers
1921
"""
@@ -168,8 +170,12 @@ class UniversalKriging3D:
168170
Enables plotting to display variogram. Default is False (off).
169171
exact_values : bool, optional
170172
If True, interpolation provides input values at input locations.
171-
If False interpolation accounts for variance within input values
172-
at input locations and does not behave as an exact-interpolator [2].
173+
If False, interpolation accounts for variance/nugget within input
174+
values at input locations and does not behave as an
175+
exact-interpolator [2]. Note that this only has an effect if
176+
there is variance/nugget present within the input data since it is
177+
interpreted as measurement error. If the nugget is zero, the kriged
178+
field will behave as an exact interpolator.
173179
174180
References
175181
----------

0 commit comments

Comments
 (0)