@@ -10,51 +10,69 @@ API Reference
10
10
Plotting
11
11
--------
12
12
13
+ Figure class overview
14
+ ~~~~~~~~~~~~~~~~~~~~~
15
+
13
16
All plotting is handled through the :class: `pygmt.Figure ` class and its methods.
14
17
15
18
.. autosummary ::
16
19
:toctree: generated
17
20
18
21
Figure
19
22
20
- Plotting data and laying out the map:
23
+ Plotting map elements
24
+ ~~~~~~~~~~~~~~~~~~~~~
21
25
22
26
.. autosummary ::
23
27
:toctree: generated
24
28
25
29
Figure.basemap
26
30
Figure.coast
27
31
Figure.colorbar
28
- Figure.contour
29
- Figure.grdcontour
30
- Figure.grdimage
31
- Figure.grdview
32
- Figure.histogram
33
- Figure.image
34
32
Figure.inset
35
33
Figure.legend
36
34
Figure.logo
35
+ Figure.solar
36
+ Figure.text
37
+
38
+ Plotting tabular data
39
+ ~~~~~~~~~~~~~~~~~~~~~
40
+
41
+ .. autosummary ::
42
+ :toctree: generated
43
+
44
+ Figure.contour
45
+ Figure.histogram
37
46
Figure.meca
38
47
Figure.plot
39
48
Figure.plot3d
40
49
Figure.rose
41
- Figure.set_panel
42
- Figure.shift_origin
43
- Figure.solar
44
- Figure.subplot
45
- Figure.text
46
50
Figure.velo
47
51
Figure.wiggle
48
52
49
- Color palette table generation:
53
+ Plotting raster data
54
+ ~~~~~~~~~~~~~~~~~~~~
50
55
51
56
.. autosummary ::
52
57
:toctree: generated
53
58
54
- grd2cpt
55
- makecpt
59
+ Figure.grdcontour
60
+ Figure.grdimage
61
+ Figure.grdview
62
+ Figure.image
63
+
64
+ Configuring layout
65
+ ~~~~~~~~~~~~~~~~~~
66
+
67
+ .. autosummary ::
68
+ :toctree: generated
69
+
70
+ Figure.set_panel
71
+ Figure.shift_origin
72
+ Figure.subplot
56
73
57
- Saving and displaying the figure:
74
+ Saving and displaying the figure
75
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58
76
59
77
.. autosummary ::
60
78
:toctree: generated
@@ -63,18 +81,35 @@ Saving and displaying the figure:
63
81
Figure.show
64
82
Figure.psconvert
65
83
66
- Configuring the display settings:
84
+ Configuring the display settings
85
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
86
+
87
+ The following module is provided directly through the :mod: `pygmt ` top level
88
+ package.
67
89
68
90
.. autosummary ::
69
91
:toctree: generated
70
92
71
93
set_display
72
94
95
+ Color palette table generation
96
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
97
+
98
+ The following modules are provided directly through the :mod: `pygmt ` top level
99
+ package.
100
+
101
+ .. autosummary ::
102
+ :toctree: generated
103
+
104
+ grd2cpt
105
+ makecpt
106
+
73
107
74
108
Data Processing
75
109
---------------
76
110
77
- Operations on tabular data:
111
+ Operations on tabular data
112
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~
78
113
79
114
.. autosummary ::
80
115
:toctree: generated
@@ -91,7 +126,8 @@ Operations on tabular data:
91
126
surface
92
127
xyz2grd
93
128
94
- Operations on grids:
129
+ Operations on grids
130
+ ~~~~~~~~~~~~~~~~~~~
95
131
96
132
.. autosummary ::
97
133
:toctree: generated
@@ -108,7 +144,8 @@ Operations on grids:
108
144
grdtrack
109
145
grdvolume
110
146
111
- Crossover analysis with x2sys:
147
+ Crossover analysis with x2sys
148
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
112
149
113
150
.. autosummary ::
114
151
:toctree: generated
0 commit comments