Skip to content

Commit 4ae19cb

Browse files
committed
Add similar figure to that found in GMTs nearneighbor documentation
1 parent 0fbc83a commit 4ae19cb

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

pygmt/src/nearneighbor.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,15 @@ def nearneighbor(x=None, y=None, z=None, data=None, **kwargs):
5050
criteria and :math:`r_i` is the distance from the node to the *i*'th data
5151
point. If no data weights are supplied then :math:`w_i = 1`.
5252
53+
.. figure:: https://docs.generic-mapping-tools.org/latest/_images/GMT_nearneighbor.png
54+
:width: 300 px
55+
:align: center
56+
57+
Search geometry includes the search radius (R) which limits the points
58+
considered and the number of sectors (here 4), which restricts how points inside
59+
the search radius contribute to the value at the node. Only the closest point
60+
in each sector (red circles) contribute to the weighted estimate.
61+
5362
Takes a matrix, xyz triples, or a file name as input.
5463
5564
Must provide either ``data`` or ``x``, ``y``, and ``z``.

0 commit comments

Comments
 (0)