Mercurial > hg > octave-nkf

annotate scripts/image/jet.m @ 20368:7503499a252b stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update docstrings to have one sentence summary as first line. Update scripts in audio, elfun, general, geometry, and image directories. * scripts/audio/@audioplayer/__get_properties__.m, scripts/audio/@audioplayer/audioplayer.m, scripts/audio/@audioplayer/get.m, scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/play.m, scripts/audio/@audioplayer/playblocking.m, scripts/audio/@audioplayer/set.m, scripts/audio/@audioplayer/subsasgn.m, scripts/audio/@audioplayer/subsref.m, scripts/audio/@audiorecorder/audiorecorder.m, scripts/audio/@audiorecorder/get.m, scripts/audio/@audiorecorder/getaudiodata.m, scripts/audio/@audiorecorder/getplayer.m, scripts/audio/@audiorecorder/isrecording.m, scripts/audio/@audiorecorder/play.m, scripts/audio/@audiorecorder/record.m, scripts/audio/@audiorecorder/recordblocking.m, scripts/audio/@audiorecorder/set.m, scripts/audio/@audiorecorder/stop.m, scripts/audio/@audiorecorder/subsasgn.m, scripts/audio/@audiorecorder/subsref.m, scripts/audio/lin2mu.m, scripts/audio/mu2lin.m, scripts/audio/record.m, scripts/audio/sound.m, scripts/audio/soundsc.m, scripts/audio/wavread.m, scripts/audio/wavwrite.m, scripts/elfun/cosd.m, scripts/elfun/sind.m, scripts/elfun/tand.m, scripts/general/accumarray.m, scripts/general/accumdim.m, scripts/general/bitcmp.m, scripts/general/bitget.m, scripts/general/bitset.m, scripts/general/blkdiag.m, scripts/general/cart2pol.m, scripts/general/cart2sph.m, scripts/general/cell2mat.m, scripts/general/celldisp.m, scripts/general/chop.m, scripts/general/circshift.m, scripts/general/common_size.m, scripts/general/cplxpair.m, scripts/general/cumtrapz.m, scripts/general/dblquad.m, scripts/general/deal.m, scripts/general/del2.m, scripts/general/display.m, scripts/general/divergence.m, scripts/general/fieldnames.m, scripts/general/flip.m, scripts/general/flipdim.m, scripts/general/fliplr.m, scripts/general/flipud.m, scripts/general/gradient.m, scripts/general/interp3.m, scripts/general/interpft.m, scripts/general/interpn.m, scripts/general/loadobj.m, scripts/general/logspace.m, scripts/general/methods.m, scripts/general/nargchk.m, scripts/general/narginchk.m, scripts/general/nargoutchk.m, scripts/general/nextpow2.m, scripts/general/nthargout.m, scripts/general/num2str.m, scripts/general/pol2cart.m, scripts/general/polyarea.m, scripts/general/postpad.m, scripts/general/prepad.m, scripts/general/profile.m, scripts/general/quadgk.m, scripts/general/quadl.m, scripts/general/quadv.m, scripts/general/randi.m, scripts/general/rat.m, scripts/general/repmat.m, scripts/general/rot90.m, scripts/general/rotdim.m, scripts/general/saveobj.m, scripts/general/shift.m, scripts/general/shiftdim.m, scripts/general/sortrows.m, scripts/general/sph2cart.m, scripts/general/structfun.m, scripts/general/subsindex.m, scripts/general/trapz.m, scripts/general/triplequad.m, scripts/geometry/delaunayn.m, scripts/geometry/dsearch.m, scripts/geometry/dsearchn.m, scripts/geometry/griddata.m, scripts/geometry/griddata3.m, scripts/geometry/griddatan.m, scripts/geometry/inpolygon.m, scripts/geometry/rectint.m, scripts/geometry/tsearchn.m, scripts/geometry/voronoi.m, scripts/geometry/voronoin.m, scripts/help/__unimplemented__.m, scripts/help/doc.m, scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m, scripts/help/help.m, scripts/help/lookfor.m, scripts/help/print_usage.m, scripts/help/type.m, scripts/help/which.m, scripts/image/autumn.m, scripts/image/bone.m, scripts/image/brighten.m, scripts/image/cmpermute.m, scripts/image/colorcube.m, scripts/image/contrast.m, scripts/image/cool.m, scripts/image/copper.m, scripts/image/cubehelix.m, scripts/image/flag.m, scripts/image/gmap40.m, scripts/image/gray.m, scripts/image/gray2ind.m, scripts/image/hot.m, scripts/image/hsv.m, scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m, scripts/image/iscolormap.m, scripts/image/jet.m, scripts/image/lines.m, scripts/image/ntsc2rgb.m, scripts/image/ocean.m, scripts/image/pink.m, scripts/image/prism.m, scripts/image/rainbow.m, scripts/image/rgb2ntsc.m, scripts/image/spinmap.m, scripts/image/spring.m, scripts/image/summer.m, scripts/image/white.m, scripts/image/winter.m: Update docstrings to have one sentence summary as first line. Re-structure to have line lengths <= 80 chars.
author Rik <rik@octave.org>
date Sun, 03 May 2015 09:36:20 -0700
parents 9fc020886ae9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19898
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19810
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: 9751
diff changeset
20 ## @deftypefn {Function File} {@var{map} =} jet ()
466ba499eff5 Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents: 9751
diff changeset
21 ## @deftypefnx {Function File} {@var{map} =} jet (@var{n})
466ba499eff5 Update docstrings for colormap files.
Rik <octave@nomad.inbox5.com>
parents: 9751
diff changeset
22 ## Create color colormap. This colormap ranges from dark blue through blue,
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
23 ## cyan, green, yellow, red, to dark red.
20368
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20038
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: 9751
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", "jet");
b9c02ee24de1 new colormap options
Carnë Draug <carandraug+dev@gmail.com>
parents: 14279
diff changeset
33 ## PKG_DEL: colormap ("unregister", "jet");
b9c02ee24de1 new colormap options
Carnë Draug <carandraug+dev@gmail.com>
parents: 14279
diff changeset
34
19810
e8e3a89fa370 Fix colormap functions when N is not of class double (bug #44070)
Carnë Draug <carandraug@octave.org>
parents: 19790
diff changeset
35 function map = jet (n = rows (colormap ()))
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
36
19810
e8e3a89fa370 Fix colormap functions when N is not of class double (bug #44070)
Carnë Draug <carandraug@octave.org>
parents: 19790
diff changeset
37 if (nargin > 1)
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
38 print_usage ();
19810
e8e3a89fa370 Fix colormap functions when N is not of class double (bug #44070)
Carnë Draug <carandraug@octave.org>
parents: 19790
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: 19790
diff changeset
40 error ("jet: 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: 9751
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 = [0, 1, 1];
16480
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
45 elseif (n == 2)
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
46 map = [0, 0, 1
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
47 0, 1, 1];
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
48 elseif (n > 2)
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
49 nel = ceil (n/4); # number of elements
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
50 idx1 = ceil (3/8 * n) + 1; # ~3/8*n for large n
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
51 if (mod (n, 8) == 2)
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
52 idx1++;
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
53 endif
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
54 idx2 = idx1 + nel - 1; # ~5/8*n for large n
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
55 idx3 = min (idx2 + nel, n); # ~7/8*n for large n
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
56
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
57 r = zeros (n, 1);
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
58 r(idx1:idx2, 1) = [1:nel] / nel;
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
59 r(idx2:idx3, 1) = 1;
19790
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
60 nel2 = n - idx3;
16480
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
61 r(idx3:(idx3+nel2), 1) = [nel:-1:(nel - nel2)] / nel;
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
62
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
63 idx1 = idx1 - nel; # ~1/8*n for large n
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
64 idx2 = idx1 + nel - 1; # ~3/8*n for large n
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
65 idx3 = min (idx2 + nel, n); # ~5/8*n for large n
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
66
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
67 g = zeros (n, 1);
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
68 g(idx1:idx2, 1) = [1:nel] / nel;
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
69 g(idx2:idx3, 1) = 1;
19790
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
70 nel2 = min (nel, n - idx3);
16480
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
71 g(idx3:(idx3+nel2), 1) = [nel:-1:(nel - nel2)] / nel;
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
72
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
73 idx1 = max (idx2 - nel, 1); # ~1/8*n for large n
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
74 idx2 = idx2; # ~3/8*n for large n
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
75 idx3 = idx3; # ~5/8*n for large n
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
76
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
77 b = zeros (n, 1);
19790
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
78 nel2 = min (nel, idx1-1);
16480
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
79 b(1:idx1, 1) = [(nel - nel2):nel] / nel;
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
80 b(idx1:idx2, 1) = 1;
19790
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
81 nel2 = min (nel, n - idx3);
16480
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
82 b(idx2:(idx2+nel2), 1) = [nel:-1:(nel - nel2)] / nel;
3731a1992083 jet.m: Make colormap compatible with Matlab (bug #36473).
Rik <rik@octave.org>
parents: 15720
diff changeset
83
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
84 map = [r, g, b];
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
85 else
14641
5f1d4def40e1 improve compatibility of colormap functions
Carnë Draug <carandraug+dev@gmail.com>
parents: 14640
diff changeset
86 map = zeros (0, 3);
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
87 endif
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
88
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents:
diff changeset
89 endfunction
9751
2b0cc0b6db61 Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents: 9245
diff changeset
90
20038
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19898
diff changeset
91
9751
2b0cc0b6db61 Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents: 9245
diff changeset
92 %!demo
2b0cc0b6db61 Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents: 9245
diff changeset
93 %! ## Show the 'jet' 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
94 %! 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
95 %! 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
96 %! colormap (jet (64));
9751
2b0cc0b6db61 Add demos for colormap functions
Soren Hauberg <hauberg@gmail.com>
parents: 9245
diff changeset
97