Skip to content

Commit

Permalink
Com
Browse files Browse the repository at this point in the history
  • Loading branch information
joa-quim committed Jul 3, 2024
1 parent 50b9450 commit 552734c
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 9 deletions.
2 changes: 0 additions & 2 deletions documentation/modules/basemap.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ At least one of the options \myreflink{frame}, **map_scale**, or **rose** must b

\textinput{common_opts/opt_R}

\textinput{common_opts/opt_R_3D}

- **A** or **polygon** : *polygon=true* or *polygon=fname*\
No plotting is performed. Instead, we determine the geographical coordinates of the polygon outline
for the (possibly oblique) rectangular map domain. The plot domain must be given via \myreflink{limits}
Expand Down
5 changes: 3 additions & 2 deletions documentation/modules/grdimage.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,11 @@ Optional Arguments
color bar on the right side of the image using the current color map stored in the global scope. To
access all options available in the *colorbar* module passe them in the named tuple (...).

- **clim** : -- *clim=(z_min,z_max)*\
- **clim** : -- *clim=(z_min,z_max)* **|** *clim=:zscale*\
When doing an automatic colorization (*i.e.*, when a colormap is not provided explicitly), limit the automatic
color map to be computed between *z_min,z_max*. Grid values below *z_min* and above *z_max* will be painted
with the same color as those.
with the same color as those. Alternatively, use *clim=:zscale* to use the Interval based on IRAF’s zscale
that is an algorithm used in astronomy for finding colorbar limits of for the grid, which showcase data near the median.

- **equalize** : -- *equalize=true* **|** *equalize=ncolors*\
With automatic colorization, map data values to colors through the data’s cumulative distribution function (CDF),
Expand Down
4 changes: 2 additions & 2 deletions documentation/modules/inset.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ Add an inset to basemap image with a rectangle in the inset taken from main imag
```julia
using GMT

basemap(region=(-48,-43,-26,-20), J=:merc,
inset=(coast, R="-80/-28/-43/10", J=:merc, shore=true, rect=(2,:red)), show=true)
basemap(region=(-48,-43,-26,-20), proj=:merc,
inset=(coast, R="-80/-28/-43/10", proj=:merc, shore=true, rect=(2,:red)), show=true)
```
\end{examplefig}
16 changes: 15 additions & 1 deletion documentation/modules/makecpt.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ or
makecpt(name::Symbol; kwargs...)
```

or

```julia
makecpt(G::GMTgrid; kwargs...)
```

*keywords: GMT, Julia, colormaps*

Make static color palette tables (CPTs) from master CPTs.
Expand All @@ -33,11 +39,14 @@ The color model (RGB, HSV or CMYK) of the palette created by **makecpt** will be
the master CPT. When there is no `COLOR_MODEL` entry in the master CPT, the `COLOR_MODEL` specified in the `gmt.conf`
file or on the command line will be used.

The second form is a quick way of generating CPT objects for use in the ``imshow`` function. Here `name` (as a symbol)
The second form is a quick way of generating CPT objects for use in the ``imshow/viz`` functions. Here `name` (as a symbol)
is the name of any of the GM default palettes. It can also be the name of CPT file living in current directory. With it,
you don't specify the `color=cptname` as it is already implied by the fact that first argin is a symbol. As mentioned,
its primary usage is to quickly show a CPT with the ``imshow`` command. *e.g* ``imshow(:gray)``

The third form created the colormap from _z_min, z_max_ limits of the grid `G`. The options for this form are the same as
for the other two, plus the `equalize` option that actually call `grd2cpt` and call a histgram equalized cmap.

Optional Arguments
------------------

Expand All @@ -60,6 +69,11 @@ Optional Arguments
table data z-range into *nlevels* equidistant slices. If *nlevels* is not given it defaults to the number of
levels in the chosen CPT.

- **equalize** -- *equalize=true* **|** *equalize=nlevels*\
Create an histgram equalized CPT. If *nlevels* is not given it defaults to the number guessed by `grd2cpt`.
Note that when using this option and, by consequence, the form that takes a grid as input, the other
options are those of the `grd2cpt` function.

- **F** or **color_model** : -- *color_model=true|:r|:h|:c["+c"[label]]* **|** *color_model="+kkeys"*\
Force output CPT to be written with r/g/b codes, gray-scale values or color name (the default)
or r/g/b codes only (**r**), or h-s-v codes (**h**), or c/m/y/k codes (**c**). Optionally or
Expand Down
2 changes: 1 addition & 1 deletion documentation/modules/scatter.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Optional Arguments

- **zcolor** or **markerz** or **mz** : -- *zcolor=xx* **|** *zcolor=true*\
Take the vector `xx` (same size as number os points in data) and interpolate the current color scale to paint the
symbols based on that colr scale. The form `zcolor=true` is equivant to *zcolor=1:npoints*
symbols based on that color scale. The form `zcolor=true` is equivant to *zcolor=1:npoints*

- **S** or *symbol* or *marker* or *Marker* or *shape* : -- Default is `circle` with a diameter of 7 points
- *symbol=symbol* string\
Expand Down
2 changes: 1 addition & 1 deletion documentation/utilities/gridit.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Interpolation methods may be those of GMT and GDAL (gdal_grid).
"lowest" will compute those amounts inside each *rectangular* cell.

- Or (GDAL): "invdist", "invdistnn", "average", "nearest", "linear", "minimum", "maximum", "range",
"count", "average_distance", "average_distance_pts". See https://gdal.org/programs/gdal_grid.html#gdal-grid
"count", "average\_distance", "average\_distance_pts". See [gdal_grid](https://gdal.org/programs/gdal_grid.html#gdal-grid)

- Note that there is some overlap between the diverse methods. For example, the GMT's \myreflink{nearneighbor}
and GDAL's `invdist` apply the same algorithm (the Inverse Distance Weight) but they difer on how
Expand Down

0 comments on commit 552734c

Please sign in to comment.