annotate scripts/image/hot.m @ 20595:c1a6c31ac29a

eliminate more simple uses of error_state * ov-classdef.cc: Eliminate simple uses of error_state.
author John W. Eaton <jwe@octave.org>
date Tue, 06 Oct 2015 00:20:02 -0400
parents 7503499a252b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19731
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19647
diff changeset
1 ## Copyright (C) 1999-2015 Kai Habel
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
2 ##
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
3 ## This file is part of Octave.
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
4 ##
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6791
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6791
diff changeset
8 ## your option) any later version.
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
9 ##
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
13 ## General Public License for more details.
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
14 ##
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6791
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6791
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
18
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
19 ## -*- texinfo -*-
11420
466ba499eff5 Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents: 10433
diff changeset
20 ## @deftypefn {Function File} {@var{map} =} hot ()
466ba499eff5 Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents: 10433
diff changeset
21 ## @deftypefnx {Function File} {@var{map} =} hot (@var{n})
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
22 ## Create color colormap. This colormap ranges from black through dark red,
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
23 ## red, orange, yellow, to white.
20193
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19867
diff changeset
24 ##
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
25 ## The argument @var{n} must be a scalar.
11420
466ba499eff5 Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents: 10433
diff changeset
26 ## If unspecified, the length of the current colormap, or 64, is used.
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
27 ## @seealso{colormap}
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
28 ## @end deftypefn
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
29
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
30 ## Author: Kai Habel <kai.habel@gmx.de>
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
31
14640
b9c02ee24de1 new colormap options
Carnë Draug <carandraug+dev@gmail.com>
parents: 14279
diff changeset
32 ## PKG_ADD: colormap ("register", "hot");
b9c02ee24de1 new colormap options
Carnë Draug <carandraug+dev@gmail.com>
parents: 14279
diff changeset
33 ## PKG_DEL: colormap ("unregister", "hot");
b9c02ee24de1 new colormap options
Carnë Draug <carandraug+dev@gmail.com>
parents: 14279
diff changeset
34
19647
e8e3a89fa370 Fix colormap functions when N is not of class double (bug #44070)
Carnë Draug <carandraug@octave.org>
parents: 17744
diff changeset
35 function map = hot (n = rows (colormap ()))
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
36
19647
e8e3a89fa370 Fix colormap functions when N is not of class double (bug #44070)
Carnë Draug <carandraug@octave.org>
parents: 17744
diff changeset
37 if (nargin > 1)
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
38 print_usage ();
19647
e8e3a89fa370 Fix colormap functions when N is not of class double (bug #44070)
Carnë Draug <carandraug@octave.org>
parents: 17744
diff changeset
39 elseif (! isscalar (n))
e8e3a89fa370 Fix colormap functions when N is not of class double (bug #44070)
Carnë Draug <carandraug@octave.org>
parents: 17744
diff changeset
40 error ("hot: N must be a scalar");
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
41 endif
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
42
11420
466ba499eff5 Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents: 10433
diff changeset
43 if (n == 1)
14641
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
44 map = [1, 1, 1];
16466
ac332eb727dd Simplify calculation of colormaps
Rik <rik@octave.org>
parents: 16366
diff changeset
45 elseif (n == 2)
ac332eb727dd Simplify calculation of colormaps
Rik <rik@octave.org>
parents: 16366
diff changeset
46 map = [1, 1, 1/2
ac332eb727dd Simplify calculation of colormaps
Rik <rik@octave.org>
parents: 16366
diff changeset
47 1, 1, 1 ];
ac332eb727dd Simplify calculation of colormaps
Rik <rik@octave.org>
parents: 16366
diff changeset
48 elseif (n > 2)
16366
6964e6b92fc1 hot.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
49 idx = floor (3/8 * n);
6964e6b92fc1 hot.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
50 nel = idx;
6964e6b92fc1 hot.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
51
6964e6b92fc1 hot.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
52 r = ones (n, 1);
16466
ac332eb727dd Simplify calculation of colormaps
Rik <rik@octave.org>
parents: 16366
diff changeset
53 r(1:idx, 1) = [1:nel]' / nel;
16366
6964e6b92fc1 hot.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
54
6964e6b92fc1 hot.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
55 g = zeros (n, 1);
6964e6b92fc1 hot.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
56 g(idx+1:2*idx, 1) = r(1:idx);
6964e6b92fc1 hot.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
57 g(2*idx+1:end, 1) = 1;
6964e6b92fc1 hot.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
58
16466
ac332eb727dd Simplify calculation of colormaps
Rik <rik@octave.org>
parents: 16366
diff changeset
59 idx = 2*idx + 1; # approximately 3/4 *n
16366
6964e6b92fc1 hot.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
60 nel = n - idx + 1;
6964e6b92fc1 hot.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
61
6964e6b92fc1 hot.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
62 b = zeros (n, 1);
6964e6b92fc1 hot.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
63 b(idx:end, 1) = [1:nel]' / nel;
6964e6b92fc1 hot.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
64
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
65 map = [r, g, b];
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
66 else
14641
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
67 map = zeros (0, 3);
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
68 endif
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
69
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
70 endfunction
9751
2b0cc0b6db61 Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents: 9245
diff changeset
71
19867
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19731
diff changeset
72
9751
2b0cc0b6db61 Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents: 9245
diff changeset
73 %!demo
2b0cc0b6db61 Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents: 9245
diff changeset
74 %! ## Show the 'hot' colormap as an image
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
75 %! image (1:64, linspace (0, 1, 64), repmat ((1:64)', 1, 64));
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
76 %! axis ([1, 64, 0, 1], "ticy", "xy");
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
77 %! colormap (hot (64));
9751
2b0cc0b6db61 Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents: 9245
diff changeset
78