fabien van mook

all packages "fvm-*"

package "fvm-colourgrade"

function file "colourgrade_streaked.m"

Function cg = colourgrade_streaked()
         cg = colourgrade_streaked(cg)
         cg = colourgrade_streaked(cg,m)
         cg = colourgrade_streaked(cg,m,n)
         cg = colourgrade_streaked(cg,[],n)

returns a struct cg with information on a
colourmap with "streaked" colours.

There are two distinct colourmaps, with at most
16 streaked colours (input argument m == 1), 
and at most 31 colours (input argument m == 2).

If input argument n is given, a lesser number
of streaked colours is chosen.

All input arguments are optional; an
empty matrix [] indicates "no input
for that argument".

The function returns default grade values (if
cg.gradevalues has not been given at input),
and appends 3 extra colours for infra, ultra 
and na/nan values to the streaked colourmap.

The function is directly responsible for the 
following fields in the ouput struct cg:
  cg.gradevalues (column vector of reals)
  cg.colourmap (colourmap, an N*3 matrix 
                for N colours in total)
  cg.icm_infra (row index to cg.colourmap)
  cg.icm_min   (row index to cg.colourmap)
  cg.icm_max   (row index to cg.colourmap)
  cg.icm_ultra (row index to cg.colourmap)
  cg.icm_nanan (row index to cg.colourmap)

The output struc cg contains also any 
other fields with defaults defined by
m-file colourgrade_init.m.

The function internally calls the following
non-standard m-files:
  reluxcolourmap.m
  colourgrade_init.m
  colourgrade_init_ngrade.m


(c) 2026 fabien van mook

2026.08.20 release of this file within package "fvm-colourgrade" under GNU GPLv3+