AFNI program: adjunct_cbar_out
Output of -help
OVERVIEW ~1~
** This is an adjunct program, so it doesn't have a full help and
probably is just mean to be used by another program, not by users **
The purpose of this function is to generate an image of a known cbar
in the AFNI realm easily. This program can't check to see if the
chosen colorbar actually exists. It will just output some default one
if the name is unrecognized (rather than erroring out).
++ constructed by PA Taylor (NIMH, NIH, USA).
# =========================================================================
COMMAND OPTIONS ~1~
-help, -h :see helpfile (here, in fact)
-hview :popup help
-ver :see version number
-cbar CCC :specify a new colorbar, where CCC can be any of the
cbars in the standard AFNI list, Matplotlib colornames,
or hex values (def: ).
-colorscale_idx_file CI CF
:another way to specify a colorbar, in this case
one created by the user. Two arguments must be
input. First, CI is a colorscale index, which
must be in the (inclusive) range [01, 99], using
two numbers. (The user has to enter this, because
they might have one/more of these specified
already in their ~/.afnirc file, and hence avoid
duplicating an index.) Second, CF is the
colorscale filename; the file contains the name of
the colorbar in the first line, and then either 2
columns (values and colors) or 1 column (just
colors; will be evenly spaced). An example CF is:
Yellow-Lime-Red-Blue
1.0 #ffff00
0.7 limegreen
0.5 #ff0000
0.3 #aa00aa
0.0 #0000ff
Note the types of AFNI-allowed colornames used here
(hex and specific colorname).
(see ENV: AFNI_COLORSCALE_xx)
-pbar_saveim PBS :if an olay is used, then you can save the color pbar
(=colorbar) that is used in plotting. PBS is the
name of the file (including path), with allowed
extensions jpg, png, or ppm (def: jpg).
When this option is used, a text file of the same
name as PBS but with extension 'txt' will also be
saved, which is now (>May 8, 2019) a
dictionary-like file of relevant information:
min/max range, threshold value (0, if no thr is
specified), as well as the ability to store
comments on what those values mean (see
-pbar_comm_* options, below). See also '-pbar_dim
..' for relation pbar optioning. (See DR:
PBAR_SAVEIM)
-echo :run script verbosely (with 'set echo' executed)
# ========================================================================
EXAMPLES ~1~
1) Simply save a colorbar file as a JPG:
adjunct_cbar_out \
-cbar Virids \
-pbar_saveim CBAR_Viridis.jpg
2) Simply save a colorbar file as a PNG:
adjunct_cbar_out \
-cbar GoogleTurbo \
-pbar_saveim CBAR_GoogleTurbo.png
This page auto-generated on
Sat Mar 29 10:53:27 PM EDT 2025