@@ -26,14 +26,14 @@ def surface(x=None, y=None, z=None, data=None, **kwargs):
26
26
Surface reads randomly-spaced (x,y,z) triples and produces gridded values
27
27
z(x,y) by solving:
28
28
29
- (1 - T) * L (L (z)) + T * L (z) = 0
29
+ .. math:: (1 - t)\nabla^2(z)+t\nabla (z) = 0
30
30
31
- where T is a tension factor between 0 and 1, and L indicates the Laplacian
32
- operator.
31
+ where :math:`t` is a tension factor between 0 and 1, and :math:`\nabla`
32
+ indicates the Laplacian operator.
33
33
34
34
Takes a matrix, xyz triples, or a file name as input.
35
35
36
- Must provide either * data* or *x*, *y* , and *z* .
36
+ Must provide either `` data`` or ``x``, ``y`` , and ``z`` .
37
37
38
38
Full option list at :gmt-docs:`surface.html`
39
39
@@ -64,10 +64,11 @@ def surface(x=None, y=None, z=None, data=None, **kwargs):
64
64
Returns
65
65
-------
66
66
ret: xarray.DataArray or None
67
- Return type depends on whether the outfile (G) parameter is set:
67
+ Return type depends on whether the `` outfile`` parameter is set:
68
68
69
- - xarray.DataArray if outfile (G) is not set
70
- - None if outfile (G) is set (grid output will be stored in outfile)
69
+ - :class:`xarray.DataArray`: if ``outfile`` is not set
70
+ - None if ``outfile`` is set (grid output will be stored in file set by
71
+ ``outfile``)
71
72
"""
72
73
kind = data_kind (data , x , y , z )
73
74
if kind == "vectors" and z is None :
0 commit comments