annotate scripts/image/contrast.m @ 10131:30817aa3889a

allow print_usage to print backtrace if called from functions
author Jaroslav Hajek <highegg@gmail.com>
date Tue, 19 Jan 2010 07:19:00 +0100
parents 16f53d29049f
children 1740012184f9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9245
16f53d29049f update copyright notices
John W. Eaton <jwe@octave.org>
parents: 9051
diff changeset
1 ## Copyright (C) 2008, 2009 David Bateman
7633
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
2 ##
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
3 ## This file is part of Octave.
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
4 ##
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ## your option) any later version.
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
9 ##
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
13 ## General Public License for more details.
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ##
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
18
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 ## -*- texinfo -*-
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
20 ## @deftypefn {Function File} {} contrast (@var{x}, @var{n})
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 7633
diff changeset
21 ## Return a gray colormap that maximizes the contrast in an image. The
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 7633
diff changeset
22 ## returned colormap will have @var{n} rows. If @var{n} is not defined
7633
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
23 ## then the size of the current colormap is used instead.
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
24 ## @seealso{colormap}
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
25 ## @end deftypefn
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
26
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
27 function map = contrast (x, n)
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
28
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
29 if (nargin == 1)
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
30 n = rows (colormap);
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
31 elseif (nargin == 2)
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
32 if (! isscalar (n))
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
33 error ("contrast: n must be a scalar");
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
34 endif
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
35 else
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
36 print_usage ();
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
37 endif
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
38
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
39 x = x(:);
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
40 minx = min (x);
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
41 map = find (diff (sort ([round(n * ((x - minx) ./ (max(x) - minx))); [0:n]'])));
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
42 minm = min (map);
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
43 map = (map - minm) ./ (max (map) - minm);
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
44 map = [map, map, map];
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
45 endfunction
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
46
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
47 %!assert (contrast(1:100,10),[([0:9]/9)',([0:9]/9)',([0:9]/9)'],1e-10)
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
48 %!demo
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
49 %! image (reshape (1:100, 10, 10))
ba15376ddfe1 Add the contrast function
David Bateman <dbateman@free.fr>
parents:
diff changeset
50 %! colormap (contrast (1:100,10))