]> Creatis software - CreaPhase.git/blob - octave_packages/image-1.0.15/imhist.m
Add a useful package (from Source forge) for octave
[CreaPhase.git] / octave_packages / image-1.0.15 / imhist.m
1 ## Copyright (C) 1999,2000  Kai Habel
2 ##
3 ## This program is free software; you can redistribute it and/or modify
4 ## it under the terms of the GNU General Public License as published by
5 ## the Free Software Foundation; either version 2 of the License, or
6 ## (at your option) any later version.
7 ##
8 ## This program is distributed in the hope that it will be useful,
9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 ## GNU General Public License for more details.
12 ##
13 ## You should have received a copy of the GNU General Public License
14 ## along with this program; If not, see <http://www.gnu.org/licenses/>.
15
16 ## -*- texinfo -*-
17 ## @deftypefn {Function File} {} imhist (@var{I},@var{n})
18 ## @deftypefnx {Function File} {} imhist (@var{I})
19 ## @deftypefnx {Function File} {} imhist (@var{X},@var{cmap})
20 ## @deftypefnx {Function File} {[@var{n,x}] = } imhist (...)
21 ## Shows the histogram of an image using hist.
22 ## @seealso{hist}
23 ## @end deftypefn
24
25 ## Author:      Kai Habel <kai.habel@gmx.de>
26 ## July 2000 : Paul Kienzle code simplification for hist() call.
27
28 function [varargout] = imhist (I, b)
29
30   if (nargin < 1 || nargin > 2)
31     print_usage();
32   endif
33
34   b_is_colormap = 0;
35
36   if (nargin == 2)
37     if (ismatrix (b))
38       b_is_colormap = (columns (b) == 3);
39     endif
40   endif
41
42   if (b_is_colormap)
43     ## assuming I is an indexed image
44     ## b is colormap
45     max_idx = max (max (I));
46     bins = rows (b);
47     if (max_idx > bins)
48       warning ("largest index exceedes length of colormap");
49     endif
50   else
51     ## assuming I is an intensity image
52     ## b is number of bins
53     if (nargin == 1)
54       bins = 256;
55     else
56       bins = b;
57     endif
58
59     ## scale image to range [0,1]
60     I = mat2gray (I);
61   endif
62   
63   if (nargout == 2)
64     [nn,xx] = hist (I(:), bins);
65     vr_val_cnt = 1; varargout{vr_val_cnt++} = nn;
66     varargout{vr_val_cnt++} = xx;
67   else
68     hist (I(:), bins);
69   endif
70
71 endfunction