From 552734c38dca38499be97d85f05ad8ea24f517d6 Mon Sep 17 00:00:00 2001 From: Joaquim Date: Wed, 3 Jul 2024 20:18:02 +0100 Subject: [PATCH] Com --- documentation/modules/basemap.md | 2 -- documentation/modules/grdimage.md | 5 +++-- documentation/modules/inset.md | 4 ++-- documentation/modules/makecpt.md | 16 +++++++++++++++- documentation/modules/scatter.md | 2 +- documentation/utilities/gridit.md | 2 +- 6 files changed, 22 insertions(+), 9 deletions(-) diff --git a/documentation/modules/basemap.md b/documentation/modules/basemap.md index 6868ec3bb..fbdc5b00c 100644 --- a/documentation/modules/basemap.md +++ b/documentation/modules/basemap.md @@ -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} diff --git a/documentation/modules/grdimage.md b/documentation/modules/grdimage.md index 9fba2df25..f1b81c3aa 100644 --- a/documentation/modules/grdimage.md +++ b/documentation/modules/grdimage.md @@ -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), diff --git a/documentation/modules/inset.md b/documentation/modules/inset.md index 562648eb7..60c9475f9 100644 --- a/documentation/modules/inset.md +++ b/documentation/modules/inset.md @@ -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} \ No newline at end of file diff --git a/documentation/modules/makecpt.md b/documentation/modules/makecpt.md index c1bc9832c..4aca29e2e 100644 --- a/documentation/modules/makecpt.md +++ b/documentation/modules/makecpt.md @@ -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. @@ -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 ------------------ @@ -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 diff --git a/documentation/modules/scatter.md b/documentation/modules/scatter.md index 6082dd634..1494eaedf 100644 --- a/documentation/modules/scatter.md +++ b/documentation/modules/scatter.md @@ -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\ diff --git a/documentation/utilities/gridit.md b/documentation/utilities/gridit.md index f1407abeb..0e7a9f685 100644 --- a/documentation/utilities/gridit.md +++ b/documentation/utilities/gridit.md @@ -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