Skip to content

Commit c300434

Browse files
committed
Comes
1 parent 53d2dcc commit c300434

File tree

4 files changed

+37
-15
lines changed

4 files changed

+37
-15
lines changed

documentation/common_opts/common_opts.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -106,19 +106,22 @@ The optional *annot_unit* indicates the unit of the *stride* and can be any of t
106106
Note for geographic axes **m** and **s** instead mean arc minutes and arc seconds.
107107
All entities that are language-specific are under control by [GMT\_LANGUAGE](http://docs.generic-mapping-tools.org/latest/gmt.conf.html#gmt-language).
108108

109-
For custom annotations and intervals, let *intervals* be given as *custom="intfile"*, where
109+
For custom annotations and intervals, let *intervals* be given as **custom**=*"intfile"*, where
110110
*intfile* contains any number of records with *coord type* [*label*]. Here, *type* is one or more
111111
letters from **a** or **i**, **f**, and **g**. For **a** or **i** you must supply a *label* that will
112-
be plotted at the *coord* location.
112+
be plotted at the *coord* location. The **custom** option can also be used giving it a NamedTuple
113+
argument. For example **xaxis=(custom=(pos=[1,2,3], label=(:Aa, :Bb, :Cc)), angle=45)** (and we could have
114+
used _type_, as described above, intead of _label_). NOTE, the _angle_ keyword can only be used on `x` axis.
113115

114116
A simpler way of controling the ticks and annotations with custom settings is to use the **xticks** option
115-
(same for **yticks** and **zticks**). Here, one give a tuple with annotations interval and labels. E.g.
116-
**xticks=(1:5, ["a", "b", "c", "d"])** where first element is an AbstractArray and second an array or tuple of
117+
(same for **yticks** and **zticks**). Here, one give a tuple with labels, annotations interval, and angle of annotations.
118+
Of these, only the _labels_ is mandatory, and the angle (a single value) can only be used for **xticks**. E.g.
119+
**xticks=(1:5, ["a", "b", "c", "d"], 90)** where first element is an AbstractArray and second an array or tuple of
117120
strings or symbols. The more elaborate effect described above for the *custom* options is achieved here by
118121
escaping the **a** or **i**, **f**, and **g** codes with a forward slash in a text string. Example:
119122
**xticks=(1:5, ["a", "f", "/ag e", "f", "/ag @~p@~"])**. Here "/ag e" means annotate the third value with *e*
120123
and add a grid line. These *x|y|zticks* options work only for the primary axes. To change the secondary use
121-
the *customtics* form. *E.g.* **xaxis2=(customticks(...),)**. Note that the *ticks* keyword is already taken
124+
the *customticks* form. *E.g.* **xaxis2=(customticks(...),)**. Note that the *ticks* keyword is already taken
122125
to control the ticks interval hence the need to use a different one (*customticks*).
123126

124127
For non-geographical projections: Give negative scale or figure sizes to change the direction of increasing

documentation/modules/makecpt.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,16 @@ imshow(makecpt(cmap=(:red,:green,:blue), range=[0,100,300,1000], no_bg=true), ho
214214
```
215215
\end{examplefig}
216216

217-
To make a continuous CPT from white to blue as z goes from 3 to 10, try
217+
To make a discrete CPT from white to blue as z goes from 3 to 10, try
218+
219+
\begin{examplefig}{}
220+
```julia
221+
using GMT
222+
imshow(makecpt(cmap="white,blue", range=(3,10)), continuous=true, horizontal=true)
223+
```
224+
\end{examplefig}
225+
226+
And to get a continuous CPT, use the option `continuous=true`.
218227

219228
\begin{examplefig}{}
220229
```julia
@@ -223,6 +232,7 @@ imshow(makecpt(cmap="white,blue", range=(3,10)), horizontal=true)
223232
```
224233
\end{examplefig}
225234

235+
226236
To make a wrapped (cyclic) CPT from the turbo table over the interval 0 to 500, i.e., the color will be wrapped every 500
227237
z-units so that we always get a color regardless of the *z* value, try
228238

documentation/modules/spectrum1d.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -18,21 +18,21 @@ The output has 3 columns: f or w, p, and e. f or w is the frequency or wavelengt
1818
the one standard deviation error bar size. If the **output** option is used, up to eight files are
1919
created; otherwise only one (xpower) is written.
2020

21-
*name_stem*.xpower
21+
- *name_stem*.xpower\
2222
Power spectral density of *X*\ (*t*). Units of X \* X \* *dt*.
23-
*name_stem*.ypower
23+
- *name_stem*.ypower\
2424
Power spectral density of *Y*\ (*t*). Units of Y \* Y \* *dt*.
25-
*name_stem*.cpower
25+
- *name_stem*.cpower\
2626
Power spectral density of the coherent output. Units same as ypower.
27-
*name_stem*.npower
27+
- *name_stem*.npower\
2828
Power spectral density of the noise output. Units same as ypower.
29-
*name_stem*.gain
29+
- *name_stem*.gain\
3030
Gain spectrum, or modulus of the transfer function. Units of (Y / X).
31-
*name_stem*.phase
31+
- *name_stem*.phase\
3232
Phase spectrum, or phase of the transfer function. Units are radians.
33-
*name_stem*.admit
33+
- *name_stem*.admit\
3434
Admittance spectrum, or real part of the transfer function. Units of (Y / X).
35-
*name_stem*.coh
35+
- *name_stem*.coh\
3636
(Squared) coherency spectrum, or linear correlation coefficient as a
3737
function of frequency. Dimensionless number in [0, 1]. The
3838
Signal-to-Noise-Ratio (SNR) is coh / (1 - coh). SNR = 1 when coh = 0.5.
@@ -68,7 +68,6 @@ Optional Arguments
6868
coherent output and the noise output are uncorrelated. Optionally specify up to 8 directives from the set
6969
refered above in any order to create only those output files instead of the default [all]. Use in alternatively
7070
a string made of the `acgnopxy` characters, or the expanded version that uses the keywords.
71-
7271
- **a** or `admitt=true`: Admittance spectrum, or real part of the transfer function.
7372
- **c** or `cpower=true`: Power spectral density of the coherent output.
7473
- **g** or `gain=true`: Gain spectrum, or modulus of the transfer function.

documentation/utilities/pcolor.md

+10
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,16 @@ pcolor(G.x, G.y, G.z, labels=2, font=(angle=45, font=(5,:red)), show=1)
9090
```
9191
\end{examplefig}
9292

93+
Display a Pearson's correlation matrix
94+
95+
\begin{examplefig}{}
96+
```julia
97+
using GMT
98+
99+
pcolor(GMT.cor(rand(4,4)), labels=:y, colorbar=1, show=true)
100+
```
101+
\end{examplefig}
102+
93103
An irregular grid
94104

95105
\begin{examplefig}{}

0 commit comments

Comments
 (0)