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

annotate scripts/image/gray.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	9fc020886ae9
children

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19613 diff changeset	1 ## Copyright (C) 1994-2015 John W. Eaton
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 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.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 diff changeset	14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2312 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/>.
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	18
3381 69b167451491 [project @ 1999-12-15 20:48:10 by jwe] jwe parents: 3373 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} =} gray ()
466ba499eff5 Update docstrings for colormap files. Rik <octave@nomad.inbox5.com> parents: 9751 diff changeset	21 ## @deftypefnx {Function File} {@var{map} =} gray (@var{n})
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	22 ## Create gray colormap. This colormap varies from black to white with shades
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	23 ## of gray.
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 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.
14260 1f911333ed3d doc: Update docstrings for functions in image/ directory Rik <octave@nomad.inbox5.com> parents: 14237 diff changeset	27 ## @seealso{colormap}
3373 36405da8e173 [project @ 1999-11-23 20:54:17 by jwe] jwe parents: 3202 diff changeset	28 ## @end deftypefn
1024 56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 559 diff changeset	29
3202 44d82b369c78 [project @ 1998-10-29 20:27:57 by jwe] jwe parents: 2847 diff changeset	30 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
2312 204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	31 ## Created: July 1994
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe] jwe parents: 2311 diff changeset	32 ## Adapted-By: jwe
1024 56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 559 diff changeset	33
14640 b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14279 diff changeset	34 ## PKG_ADD: colormap ("register", "gray");
b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14279 diff changeset	35 ## PKG_DEL: colormap ("unregister", "gray");
b9c02ee24de1 new colormap options Carnë Draug <carandraug+dev@gmail.com> parents: 14279 diff changeset	36
19613 e8e3a89fa370 Fix colormap functions when N is not of class double (bug #44070) Carnë Draug <carandraug@octave.org> parents: 17744 diff changeset	37 function map = gray (n = rows (colormap ()))
1024 56520a75b5b3 [project @ 1995-01-11 20:30:04 by jwe] jwe parents: 559 diff changeset	38
19613 e8e3a89fa370 Fix colormap functions when N is not of class double (bug #44070) Carnë Draug <carandraug@octave.org> parents: 17744 diff changeset	39 if (nargin > 1)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5307 diff changeset	40 print_usage ();
19613 e8e3a89fa370 Fix colormap functions when N is not of class double (bug #44070) Carnë Draug <carandraug@octave.org> parents: 17744 diff changeset	41 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	42 error ("gray: N must be a scalar");
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	43 endif
19613 e8e3a89fa370 Fix colormap functions when N is not of class double (bug #44070) Carnë Draug <carandraug@octave.org> parents: 17744 diff changeset	44 n = double (n);
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	45
14641 5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	46 if (n == 1)
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	47 map = [0, 0, 0];
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	48 elseif (n > 1)
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	49 gr = [0:(n-1)]' / (n - 1);
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	50 map = [gr, gr, gr];
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	51 else
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	52 map = zeros (0, 3);
5f1d4def40e1 improve compatibility of colormap functions Carnë Draug <carandraug+dev@gmail.com> parents: 14640 diff changeset	53 endif
559 4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	54
4e826edfbc56 [project @ 1994-07-25 22:18:28 by jwe] jwe parents: diff changeset	55 endfunction
9751 2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 7017 diff changeset	56
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	57
9751 2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 7017 diff changeset	58 %!demo
2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 7017 diff changeset	59 %! ## Show the 'gray' 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	60 %! 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	61 %! 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	62 %! colormap (gray (64));
9751 2b0cc0b6db61 Add demos for colormap functions Soren Hauberg <hauberg@gmail.com> parents: 7017 diff changeset	63

Mercurial > octave-antonio

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