@@ -36,12 +36,12 @@ def triangulate(table=None, x=None, y=None, z=None, **kwargs):
36
36
data.
37
37
38
38
Triangulate reads in x,y[,z] data and performs Delaunay triangulation,
39
- i.e., it find how the points should be connected to give the most
39
+ i.e., it finds how the points should be connected to give the most
40
40
equilateral triangulation possible. If a map projection (give *region*
41
41
and *projection*) is chosen then it is applied before the triangulation
42
42
is calculated.
43
43
44
- Must provide either * table* or *x*, *y* , and *z* .
44
+ Must provide either `` table`` or ``x``, ``y`` , and ``z`` .
45
45
46
46
Full option list at :gmt-docs:`triangulate.html`
47
47
@@ -55,17 +55,12 @@ def triangulate(table=None, x=None, y=None, z=None, **kwargs):
55
55
Pass in (x, y, z) or (longitude, latitude, elevation) values by
56
56
providing a file name to an ASCII data table, a 2D
57
57
{table-classes}.
58
- projection : str
59
- Select map projection.
60
- region
61
- ``'xmin/xmax/ymin/ymax[+r][+uunit]'``.
62
- Specify the region of interest.
63
- spacing : str
64
- ``'xinc[unit][+e|n][/yinc[unit][+e|n]]'``.
65
- x_inc [and optionally y_inc] is the grid spacing.
58
+ {J}
59
+ {R}
60
+ {I}
66
61
outgrid : bool or str
67
62
Use triangulation to grid the data onto an even grid (specified with
68
- * region* and * spacing* ). Set to True, or pass in the name of the output
63
+ `` region`` and `` spacing`` ). Set to `` True`` , or pass in the name of the output
69
64
grid file. The interpolation is performed in the original coordinates,
70
65
so if your triangles are close to the poles you are better off
71
66
projecting all data to a local coordinate system before using
@@ -79,16 +74,16 @@ def triangulate(table=None, x=None, y=None, z=None, **kwargs):
79
74
{h}
80
75
{i}
81
76
{r}
82
- Only valid with * outgrid* .
77
+ Only valid with `` outgrid`` .
83
78
84
79
Returns
85
80
-------
86
- ret: xarray.DataArray or None
87
- Return type depends on whether the outgrid parameter is set:
81
+ ret: pandas.DataFrame or xarray.DataArray or None
82
+ Return type depends on whether the `` outgrid`` parameter is set:
88
83
89
- - pandas.DataFrame if outgrid is None (default)
90
- - xarray.DataArray if outgrid is True
91
- - None if outgrid is a str (grid output will be stored in outgrid)
84
+ - pandas.DataFrame if `` outgrid`` is None (default)
85
+ - xarray.DataArray if `` outgrid`` is True
86
+ - None if `` outgrid`` is a str (grid output will be stored in `` outgrid`` )
92
87
"""
93
88
with GMTTempFile (suffix = ".nc" ) as tmpfile :
94
89
with Session () as lib :
0 commit comments