logo
  1. home
  2. code
  3. cptutils
  4. cptupdate(1)
J. W. Goethe
Colours are the deeds of light; its deeds and sufferings: thus considered we may expect from them some explanation respecting light itself.
J. W. Goethe preface to The Theory of Colour, 1810

Name

cptupdate — create a GMT colour palette table (cpt) file with a different version to the input.

Synopsis

cptupdate [-h ] [-H ] [-m model] [-o path] [-S ] [-v ] [-V ] [-z ] [-Z ] [-4 ] [-5 ] [-6 ] [path]

DESCRIPTION

The cptupdate program updates the colour palette in the input to a more recent (or older) version, optionally adding/removing features to the input.

The program reads any version of the format, so can also be used to add hinges or normalise/denormalise version 6 input, or even convert to versions 5 or 4.

The program will read from stdin if a file is not specified as the final argument, and write to stdout if the --output option is not specified.

OPTIONS

--backtrace-file path

Specify a file to which to write a formatted backtrace. The file will only be created if there is a backtrace created, typically when an error occurs.

--backtrace-format format

Specify the format of the backtrace written to the files specified by --backtrace-file, one of plain, xml or json.

--comments-read path

Read the comments from the specified path and add them to the output gradient.

The format is custom XML which should be fairly easy to generate, see the output of --comments-write for examples.

--comments-write path

Write the comments in the input to the specified path.

--comments-retain

Use the comments in the input file as the comments for the output file.

--comments-generate

Create a comment with summary data (the date of creation, name and version of the cptutils package) in the output file.

-h, --help

Brief help.

-H, --hinge-hard

Adds a HARD_HINGE to the output provided the output version is at least 6.

-m, --model model

On writing the output, convert all colours to the specified model, one of "rgb" or "hsv". This has no effect on non-colour segments.

-o, --output path

Write the output to path, rather than stdout.

-S, --hinge-soft

Adds a SOFT_HINGE to the output provided the output version is at least 6.

-v, --verbose

Verbose operation.

-V, --version

Version information.

-z, --z-normalise

Normalise the z-values in the cpt output into the range 0/1 (or to -1/1 if a hinge is present) and add a RANGE directive if not present in the input. This is the form used in GMT master files.

This option requires that output cpt version is at least 5.

-Z, --z-denormalise

Set the z-values in the cpt output into the range given by the RANGE directive, and remove that directive. If there is no RANGE then this option does nothing.

-4, --gmt4

Use GMT 4 conventions when writing the cpt output: the colour-model code is uppercase, and the colours are separated by spaces.

This option allows one to downgrade to version 4. If the input is normalised it will be denormalised, if the input has hinges, those will be removed.

-5, --gmt5

Use GMT 5 conventions when writing the cpt output: the colour-model code is lowercase, and the colours are separated by a solidus for RGB, CMYK, by a dash for HSV.

This option allows one to downgrade from version 6 (in which case hard/soft hinges will be converted to explicit hinges at zero) or upgrade from version 4.

-6, --gmt6

As the -5 option, but allows the HARD_HINGE and SOFT_HINGE directives in place of the explicit HINGE = directive.

This option is the default, so redundant (but one might wish to fix version 6 in anticipation later versions of the format).

EXAMPLE

Update a version 4 cpt to version 6, adding a hard hinge and normalising the result, the typical format for a master file:

cptupdate -v -z -H -o new.cpt old.cpt

AUTHOR

J.J. Green