octave-antonio: scripts/image/contrast.m annotate

annotate scripts/image/contrast.m @ 20158:7503499a252b stable

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	4197fc428c7d
children

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19593 diff changeset	1 ## Copyright (C) 2008-2015 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 --
15714 b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	20 ## @deftypefn {Function File} {@var{cmap} =} contrast (@var{x})
b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	21 ## @deftypefnx {Function File} {@var{cmap} =} contrast (@var{x}, @var{n})
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	22 ## Return a gray colormap that maximizes the contrast in an image.
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	23 ##
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	24 ## The returned colormap will have @var{n} rows. If @var{n} is not defined
14245 4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	25 ## then the size of the current colormap is used.
14260 1f911333ed3d doc: Update docstrings for functions in image/ directory Rik <octave@nomad.inbox5.com> parents: 14253 diff changeset	26 ## @seealso{colormap, brighten}
7633 ba15376ddfe1 Add the contrast function David Bateman <dbateman@free.fr> parents: diff changeset	27 ## @end deftypefn
ba15376ddfe1 Add the contrast function David Bateman <dbateman@free.fr> parents: diff changeset	28
15714 b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	29 function cmap = contrast (x, n)
7633 ba15376ddfe1 Add the contrast function David Bateman <dbateman@free.fr> parents: diff changeset	30
ba15376ddfe1 Add the contrast function David Bateman <dbateman@free.fr> parents: diff changeset	31 if (nargin == 1)
15714 b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	32 n = rows (colormap ());
7633 ba15376ddfe1 Add the contrast function David Bateman <dbateman@free.fr> parents: diff changeset	33 elseif (nargin == 2)
ba15376ddfe1 Add the contrast function David Bateman <dbateman@free.fr> parents: diff changeset	34 if (! isscalar (n))
11472 1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done. Rik <octave@nomad.inbox5.com> parents: 9245 diff changeset	35 error ("contrast: N must be a scalar");
7633 ba15376ddfe1 Add the contrast function David Bateman <dbateman@free.fr> parents: diff changeset	36 endif
ba15376ddfe1 Add the contrast function David Bateman <dbateman@free.fr> parents: diff changeset	37 else
ba15376ddfe1 Add the contrast function David Bateman <dbateman@free.fr> parents: diff changeset	38 print_usage ();
ba15376ddfe1 Add the contrast function David Bateman <dbateman@free.fr> parents: diff changeset	39 endif
ba15376ddfe1 Add the contrast function David Bateman <dbateman@free.fr> parents: diff changeset	40
ba15376ddfe1 Add the contrast function David Bateman <dbateman@free.fr> parents: diff changeset	41 x = x(:);
ba15376ddfe1 Add the contrast function David Bateman <dbateman@free.fr> parents: diff changeset	42 minx = min (x);
15714 b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	43 cmap = find (diff (sort ([round(n * ((x - minx) ./ (max(x) - minx))); [0:n]'])));
b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	44 minm = min (cmap);
b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	45 cmap = (cmap - minm) ./ (max (cmap) - minm);
b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	46 cmap = [cmap, cmap, cmap];
14245 4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	47
7633 ba15376ddfe1 Add the contrast function David Bateman <dbateman@free.fr> parents: diff changeset	48 endfunction
ba15376ddfe1 Add the contrast function David Bateman <dbateman@free.fr> parents: diff changeset	49
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	50
7633 ba15376ddfe1 Add the contrast function David Bateman <dbateman@free.fr> parents: diff changeset	51 %!demo
15683 806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	52 %! figure;
14245 4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	53 %! img = reshape (1:100, 10, 10);
14253 f9bd63f5ddd0 contrast.m: Improve demo. Rik <octave@nomad.inbox5.com> parents: 14245 diff changeset	54 %! imagesc (img);
f9bd63f5ddd0 contrast.m: Improve demo. Rik <octave@nomad.inbox5.com> parents: 14245 diff changeset	55 %! colormap (gray (64));
f9bd63f5ddd0 contrast.m: Improve demo. Rik <octave@nomad.inbox5.com> parents: 14245 diff changeset	56 %! title ("Image with default 64 gray levels");
f9bd63f5ddd0 contrast.m: Improve demo. Rik <octave@nomad.inbox5.com> parents: 14245 diff changeset	57 %! pos = get (gcf, "position");
15683 806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	58 %! pos(1) += pos(3) + 25;
19593 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	59 %! figure ("position", pos);
14253 f9bd63f5ddd0 contrast.m: Improve demo. Rik <octave@nomad.inbox5.com> parents: 14245 diff changeset	60 %! colormap (contrast (img, 10));
f9bd63f5ddd0 contrast.m: Improve demo. Rik <octave@nomad.inbox5.com> parents: 14245 diff changeset	61 %! imagesc (img);
14245 4506eade9f04 Use Matlab coding conventions for demos in plot/ directory. Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	62 %! title ("Image with contrast enhanced");
14237 11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	63
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	64 %!assert (contrast (1:100,10), [([0:9]/9)',([0:9]/9)',([0:9]/9)'], 1e-10)
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	65

Mercurial > octave-antonio

annotate scripts/image/contrast.m @ 20158:7503499a252b stable