octave: scripts/image/brighten.m annotate

annotate scripts/image/brighten.m @ 21546:f7f97d7e9294

doc: Wrap m-file docstrings to 79 characters + newline (80 total). * isrecording.m, soundsc.m, delaunay3.m, cell2mat.m, cumtrapz.m, del2.m, inputParser.m, interp1.m, interp3.m, narginchk.m, profile.m, validateattributes.m, delaunayn.m, tsearchn.m, voronoin.m, brighten.m, cmunique.m, colorcube.m, imfinfo.m, imshow.m, edit.m, orderfields.m, run.m, warning_ids.m, ode23.m, ode45.m, odeget.m, integrate_adaptive.m, kahan.m, ode_struct_value_check.m, runge_kutta_23.m, fminunc.m, fsolve.m, fzero.m, pkg.m, build.m, specular.m, view.m, bar.m, barh.m, contour3.m, isosurface.m, line.m, pie.m, pie3.m, quiver3.m, scatter.m, scatter3.m, stem3.m, stemleaf.m, surfl.m, tetramesh.m, isfigure.m, mkpp.m, pchip.m, residue.m, splinefit.m, rmpref.m, unique.m, eigs.m, ilu.m, factor.m, factorial.m, gallery.m, hankel.m, histc.m, ols.m, finv.m, fpdf.m, kruskal_wallis_test.m, weekday.m: Wrap m-file docstrings to 79 characters + newline (80 total).

author	Rik <rik@octave.org>
date	Sun, 27 Mar 2016 15:50:01 -0700
parents	516bb87ea72e
children	2f9078956a63

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17744 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: 6792 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: 6792 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: 6792 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: 6792 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 --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20158 diff changeset	20 ## @deftypefn {} {@var{map_out} =} brighten (@var{beta})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20158 diff changeset	21 ## @deftypefnx {} {@var{map_out} =} brighten (@var{map}, @var{beta})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20158 diff changeset	22 ## @deftypefnx {} {@var{map_out} =} brighten (@var{h}, @var{beta})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20158 diff changeset	23 ## @deftypefnx {} {} brighten (@dots{})
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	24 ## Brighten or darken a colormap.
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	25 ##
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	26 ## The argument @var{beta} must be a scalar between -1 and 1, where a negative
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	27 ## value darkens and a positive value brightens the colormap.
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	28 ##
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	29 ## If the @var{map} argument is omitted, the function is applied to the current
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	30 ## colormap.
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	31 ##
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	32 ## The first argument can also be a valid graphics handle @var{h}, in which
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	33 ## case @code{brighten} is applied to the colormap associated with this handle.
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	34 ##
21546 f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 20852 diff changeset	35 ## If no output is specified then the result is written to the current
f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 20852 diff changeset	36 ## colormap.
14260 1f911333ed3d doc: Update docstrings for functions in image/ directory Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	37 ## @seealso{colormap, contrast}
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	38 ## @end deftypefn
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	39
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	40 function rmap = brighten (arg1, beta)
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	41
15714 b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	42 if (nargin < 1 \|\| nargin > 2)
b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	43 print_usage ();
b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	44 endif
b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	45
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	46 h = -1;
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	47 if (nargin == 1)
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	48 beta = arg1;
15714 b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	49 m = colormap ();
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	50 h = gcf ();
15714 b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	51 else
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	52 if (ishandle (arg1))
c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	53 h = arg1;
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	54 m = get (h, "colormap");
15714 b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	55 elseif (iscolormap (arg1))
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	56 m = arg1;
c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	57 else
15714 b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	58 error ("brighten: first argument must be a colormap or a graphics handle");
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	59 endif
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	60 endif
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	61
8507 cadc73247d65 style fixes John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	62 if (! isscalar (beta) \|\| beta <= -1 \|\| beta >= 1)
11472 1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done. Rik <octave@nomad.inbox5.com> parents: 11469 diff changeset	63 error ("brighten: BETA must be a scalar in the range (-1,1)");
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	64 endif
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	65
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	66 if (beta > 0)
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	67 gamma = 1 - beta;
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	68 else
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	69 gamma = 1 / (1 + beta);
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	70 endif
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	71
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	72 if (nargout == 0)
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	73 if (ishandle (h))
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	74 set (h, "colormap", m .^ gamma);
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	75 else
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	76 colormap (m .^ gamma);
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	77 endif
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	78 else
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	79 rmap = m .^ gamma;
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	80 endif
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	81
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	82 endfunction
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	83
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	84
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	85 %!demo
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	86 %! ## First figure uses default grayscale colormap
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	87 %! figure;
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	88 %! colormap (gray (64));
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	89 %! image (1:64, linspace (0, 1, 64), repmat ((1:64)', 1, 64));
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	90 %! axis ([1, 64, 0, 1], "ticy", "xy");
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	91 %! title ("default grayscale colormap");
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	92 %! pos = get (gcf, "position");
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	93 %! pos(1) += pos(3) + 25;
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	94 %! ## Second figure uses brightened grayscale colormap
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	95 %! figure ("position", pos);
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	96 %! colormap (gray (64));
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	97 %! image (1:64, linspace (0, 1, 64), repmat ((1:64)', 1, 64));
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	98 %! axis ([1, 64, 0, 1], "ticy", "xy");
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	99 %! brighten (0.5);
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	100 %! title ("grayscale colormap brightened by 0.5");
806ea52af230 Overhaul m-files in image directory to provide better support for images stored as integers. Rik <rik@octave.org> parents: 14260 diff changeset	101

Mercurial > octave

annotate scripts/image/brighten.m @ 21546:f7f97d7e9294