-
Notifications
You must be signed in to change notification settings - Fork 346
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improved synopsis and usage of -Ccpt for grid plot modules (#8165)
* Improve synopsis and usage of -Ccpt for grid*-plotters The grid plotters grd2kml, grdimage, grdview, and grdvector takes a bit more complicated CPT argument. This is not documented better via API function gmt_explain_cpt_input and RST include file use_cpt_grd.rst_ Also fixed up synopsis syntax via constant CPT_OPT_ARGS. * More polish Ensure Unit link is employed in those 5 files. * Update gmt_support.c
- Loading branch information
1 parent
07dfe26
commit 5315bb4
Showing
12 changed files
with
65 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,28 @@ | ||
**-C**\ [[*section*/]\ *master_cpt*\ [**+h**\ [*hinge*]][**+u**\|\ **U**\ *unit*]\|\ *local.cpt*\|\ *color*\ :math:`_1`,\ *color*\ :math:`_2`\ [,\ *color*\ :math:`_3`\ ,...]][**+s**\ *fname*]] | ||
Name of an input CPT file or a comma-separated list of colors from which to build a CPT. | ||
If no argument is given then under modern mode we select the current CPT. | ||
**-C**\ [*section*/]\ *master*\|\ *cpt*\|\ *color*\ :math:`_1`,\ *color*\ :math:`_2`\ [,\ *color*\ :math:`_3`\ ,...]\ [**+h**\ [*hinge*]][**+i**\ *dz*][**+u**\|\ **U**\ *unit*][**+s**\ *fname*] | ||
Name of a master CPT, an input CPT file or a comma-separated list of colors from which to build a CPT. | ||
If no argument is given then under modern mode we select the current CPT, if it is available. | ||
Generally, the input can be many things: | ||
|
||
#. A standard GMT *master_cpt* file, e.g., *earth* | ||
#. A standard GMT *master* CPT file, e.g., *earth* | ||
(see :ref:`Of Colors and Color Legends`) and can be either addressed | ||
by *master\_cpt* or *section*/*master_cpt* (without the **.cpt** extension). | ||
#. File name of already custom-made *local.cpt* file. | ||
by *master* or *section*/*master* (without any **.cpt** extension). | ||
#. File name of already custom-made *cpt* file (e.g, *my_colors.cpt*). | ||
#. Build a linear continuous CPT from *color*\ :math:`_1`,\ *color*\ :math:`_2`\ [,\ *color*\ :math:`_3`\ ,...] | ||
automatically, where *z* starts at 0 and is incremented by one for each color. In this case, | ||
*color*\ :math:`_i` can be a r/g/b (e.g., 255/100/75), or h-s-v triplet (e.g., 180-0.8-1), | ||
a c/m/y/k quadruple (e.g., 80/50/40/30), an HTML hexadecimal color (e.g. #aabbcc), | ||
*color*\ :math:`_i` can be a *r*/*g*/*b* (e.g., 255/100/75), *h*-*s*-*v* triplet (e.g., 180-0.8-1), | ||
a *c*/*m*/*y*/*k* quadruple (e.g., 80/50/40/30), an HTML hexadecimal color (e.g. *#aabbcc*), | ||
or a :ref:`color name <RGBchart>`. No spaces between commas are allowed. | ||
|
||
A few modifiers pertains to hinges and units: | ||
|
||
- **+h**: If given a master CPT with soft hinges then you can enable the hinge at | ||
data value *hinge* [0], whereas for hard-hinge CPTs you can adjust the location | ||
of the hinge [0] but not disable it. | ||
- **+i**: Append increment *dz* to quantize the range [Default uses the exact grid range]. | ||
- **+s**: Append *fname* to save the finalized cpt in a disk file. | ||
This is useful when the cpt was generated automatically, but if used, **must** be | ||
- **+i**: Append increment *dz* to quantize the grid range [Default uses the exact grid range]. | ||
- **+s**: Append *fname* to save the finalized CPT in a disk file. | ||
This is useful when the CPT is generated automatically, but if used, **must** be | ||
at the end of the **-C** option. | ||
- **+u**: For any other *master_cpt*, you may convert their *z*-values from | ||
another distance *unit* to meter. | ||
- **+U**: Likewise, you may convert their *z*-values from meter to another *unit*. | ||
- **+u**: For any other *master* CPT, you may convert their *z*-values from | ||
other distance `Units`_ to meter by appending the original unit code. | ||
- **+U**: Likewise, you may convert their *z*-values from meter to other `Units`_ | ||
by appending the desired unit code. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters