Mercurial > octave
annotate scripts/image/colorcube.m @ 21546:f7f97d7e9294
doc: Wrap m-file docstrings to 79 characters + newline (80 total).
* isrecording.m, soundsc.m, delaunay3.m, cell2mat.m, cumtrapz.m, del2.m,
inputParser.m, interp1.m, interp3.m, narginchk.m, profile.m,
validateattributes.m, delaunayn.m, tsearchn.m, voronoin.m, brighten.m,
cmunique.m, colorcube.m, imfinfo.m, imshow.m, edit.m, orderfields.m, run.m,
warning_ids.m, ode23.m, ode45.m, odeget.m, integrate_adaptive.m, kahan.m,
ode_struct_value_check.m, runge_kutta_23.m, fminunc.m, fsolve.m, fzero.m,
pkg.m, build.m, specular.m, view.m, bar.m, barh.m, contour3.m, isosurface.m,
line.m, pie.m, pie3.m, quiver3.m, scatter.m, scatter3.m, stem3.m, stemleaf.m,
surfl.m, tetramesh.m, isfigure.m, mkpp.m, pchip.m, residue.m, splinefit.m,
rmpref.m, unique.m, eigs.m, ilu.m, factor.m, factorial.m, gallery.m, hankel.m,
histc.m, ols.m, finv.m, fpdf.m, kruskal_wallis_test.m, weekday.m:
Wrap m-file docstrings to 79 characters + newline (80 total).
author | Rik <rik@octave.org> |
---|---|
date | Sun, 27 Mar 2016 15:50:01 -0700 |
parents | 516bb87ea72e |
children | 283d8dfcad37 |
rev | line source |
---|---|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19593
diff
changeset
|
1 ## Copyright (C) 2012-2015 Rik Wehbring |
14274
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
2 ## |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
3 ## This file is part of Octave. |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
4 ## |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
5 ## Octave is free software; you can redistribute it and/or modify it |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
6 ## under the terms of the GNU General Public License as published by |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
7 ## the Free Software Foundation; either version 3 of the License, or (at |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
8 ## your option) any later version. |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
9 ## |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
10 ## Octave is distributed in the hope that it will be useful, but |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
13 ## General Public License for more details. |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
14 ## |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
15 ## You should have received a copy of the GNU General Public License |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
16 ## along with Octave; see the file COPYING. If not, see |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
17 ## <http://www.gnu.org/licenses/>. |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
18 |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
19 ## -*- texinfo -*- |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20158
diff
changeset
|
20 ## @deftypefn {} {@var{map} =} colorcube () |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20158
diff
changeset
|
21 ## @deftypefnx {} {@var{map} =} colorcube (@var{n}) |
14274
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
22 ## Create color colormap. This colormap is composed of as many equally |
20158
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
23 ## spaced colors (not grays) in the RGB color space as possible. |
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
24 ## |
21546
f7f97d7e9294
doc: Wrap m-file docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
25 ## If there are not a perfect number @var{n} of regularly spaced colors then |
f7f97d7e9294
doc: Wrap m-file docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
26 ## the remaining entries in the colormap are gradients of pure red, green, |
f7f97d7e9294
doc: Wrap m-file docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
27 ## blue, and gray. |
20158
7503499a252b
doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
28 ## |
14274
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
29 ## The argument @var{n} must be a scalar. |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
30 ## If unspecified, the length of the current colormap, or 64, is used. |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
31 ## @seealso{colormap} |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
32 ## @end deftypefn |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
33 |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
34 function map = colorcube (n) |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
35 |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
36 if (nargin == 0) |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
37 n = rows (colormap); |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
38 elseif (nargin == 1) |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
39 if (! isscalar (n)) |
15720
1a800034d443
Colormap error() calls now report the input variable which is a problem.
Rik <rik@octave.org>
parents:
14274
diff
changeset
|
40 error ("colorcube: N must be a scalar"); |
14274
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
41 endif |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
42 else |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
43 print_usage (); |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
44 endif |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
45 |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
46 if (n < 9) |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
47 map = gray (n); |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
48 return; |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
49 endif |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
50 |
17336
b81b9d079515
Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents:
15720
diff
changeset
|
51 ## Create colorcube of evenly spaced points with side length of n^1/3 |
14274
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
52 cubelen = fix (cbrt (n)); |
19593
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
53 reserve = n - cubelen^3; |
14274
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
54 |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
55 if (reserve == 0) |
17336
b81b9d079515
Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents:
15720
diff
changeset
|
56 ## Steal space from blue to put the gray gradient |
14274
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
57 [r, g, b] = meshgrid (linspace (0,1,cubelen), |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
58 linspace (0,1,cubelen), |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
59 linspace (0,1,cubelen-1)); |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
60 else |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
61 [r, g, b] = meshgrid (linspace (0,1,cubelen), |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
62 linspace (0,1,cubelen), |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
63 linspace (0,1,cubelen)); |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
64 endif |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
65 |
17336
b81b9d079515
Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents:
15720
diff
changeset
|
66 ## Create map and weed out grays |
14274
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
67 map = [r(:), g(:), b(:)]; |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
68 idx = any (bsxfun (@ne, map(:, 1), map(:, 2:3)), 2); |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
69 map = map(idx, :); |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
70 |
17336
b81b9d079515
Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents:
15720
diff
changeset
|
71 ## Weed out pure colors |
14274
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
72 idx = sum (map == 0, 2); |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
73 map = map(idx != 2, :); |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
74 |
17336
b81b9d079515
Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents:
15720
diff
changeset
|
75 ## Put in remaining gradients of pure red, green, blue, and gray |
14274
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
76 reserve = n - rows (map) - 1; |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
77 csteps = fix (reserve/4); |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
78 cstepsz = 1 / csteps; |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
79 cgrad = (cstepsz:cstepsz:1)'; |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
80 gsteps = reserve - 3*csteps; |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
81 gstepsz = 1 / gsteps; |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
82 ggrad = (gstepsz:gstepsz:1)'; |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
83 map = [map |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
84 cgrad, zeros(csteps, 1), zeros(csteps, 1) |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
85 zeros(csteps, 1), cgrad, zeros(csteps, 1) |
19593
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
86 zeros(csteps, 1), zeros(csteps, 1), cgrad |
14274
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
87 0, 0, 0 |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
88 ggrad, ggrad, ggrad]; |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
89 |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
90 endfunction |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
91 |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
92 |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
93 %!demo |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
94 %! ## Show the 'colorcube' colormap as an image |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
95 %! image (1:64, linspace (0, 1, 64), repmat ((1:64)', 1, 64)); |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
96 %! axis ([1, 64, 0, 1], "ticy", "xy"); |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
97 %! colormap (colorcube (64)); |
727b74f512af
colorcube.m: Add new colormap which maximizes equally spaced colors.
Rik <octave@nomad.inbox5.com>
parents:
diff
changeset
|
98 |