octave: scripts/image/brighten.m annotate

annotate scripts/image/brighten.m @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.

author	John W. Eaton <jwe@octave.org>
date	Mon, 06 Jan 2020 22:29:51 -0500
parents	b442ec6dda5c
children	bd51beb6205e

rev	line source
27919 1891570abac8 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27918 diff changeset	1 ## Copyright (C) 1999-2020 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	3 ## See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	4 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	5 ##
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	6 ##
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	7 ## This file is part of Octave.
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	8 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24423 diff changeset	9 ## Octave is free software: you can redistribute it and/or modify it
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	10 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24423 diff changeset	11 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	12 ## (at your option) any later version.
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	13 ##
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	14 ## 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	15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## GNU General Public License for more details.
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 ## 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	20 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24423 diff changeset	21 ## <https://www.gnu.org/licenses/>.
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	22
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	23 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20158 diff changeset	24 ## @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	25 ## @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	26 ## @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	27 ## @deftypefnx {} {} brighten (@dots{})
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	28 ## 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	29 ##
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	30 ## 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	31 ## value darkens and a positive value brightens the colormap.
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	32 ##
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	33 ## 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	34 ## colormap.
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	35 ##
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	36 ## 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	37 ## 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	38 ##
21546 f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total). Rik <rik@octave.org> parents: 20852 diff changeset	39 ## 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	40 ## colormap.
14260 1f911333ed3d doc: Update docstrings for functions in image/ directory Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	41 ## @seealso{colormap, contrast}
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	42 ## @end deftypefn
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	43
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	44 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	45
15714 b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	46 if (nargin < 1 \|\| nargin > 2)
b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	47 print_usage ();
b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	48 endif
b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	49
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	50 h = -1;
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	51 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	52 beta = arg1;
15714 b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	53 m = colormap ();
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	54 h = gcf ();
15714 b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	55 else
24423 1d52db450db4 Change ishandle to return true for Java objects for Matlab compatibility. Rik <rik@octave.org> parents: 23220 diff changeset	56 if (ishghandle (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	57 h = arg1;
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	58 m = get (h, "colormap");
15714 b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	59 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	60 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	61 else
15714 b1cd65881592 Clean up scripts in image directory. Rik <rik@octave.org> parents: 15683 diff changeset	62 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	63 endif
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
8507 cadc73247d65 style fixes John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	66 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	67 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	68 endif
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	69
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	70 if (beta > 0)
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	71 gamma = 1 - beta;
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	72 else
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	73 gamma = 1 / (1 + beta);
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	74 endif
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	75
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	76 if (nargout == 0)
24423 1d52db450db4 Change ishandle to return true for Java objects for Matlab compatibility. Rik <rik@octave.org> parents: 23220 diff changeset	77 if (ishghandle (h))
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	78 set (h, "colormap", m .^ gamma);
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	79 else
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	80 colormap (m .^ gamma);
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	81 endif
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	82 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	83 rmap = m .^ gamma;
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	84 endif
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	85
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: diff changeset	86 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	87
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
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 %!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	90 %! ## First figure uses default grayscale colormap
21658 2f9078956a63 don't open new figures unnecessarily in demos John W. Eaton <jwe@octave.org> parents: 21546 diff changeset	91 %! clf;
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	92 %! 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	93 %! image (1:64, linspace (0, 1, 64), repmat ((1:64)', 1, 64));
22151 283d8dfcad37 Make demos Matlab compatible for comparison with dump_demos script. Rik <rik@octave.org> parents: 21658 diff changeset	94 %! axis ([1, 64, 0, 1], "xy");
283d8dfcad37 Make demos Matlab compatible for comparison with dump_demos script. Rik <rik@octave.org> parents: 21658 diff changeset	95 %! set (gca, "xtick", []);
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	96 %! 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	97 %! 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	98 %! 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	99 %! ## 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	100 %! 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	101 %! 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	102 %! image (1:64, linspace (0, 1, 64), repmat ((1:64)', 1, 64));
22151 283d8dfcad37 Make demos Matlab compatible for comparison with dump_demos script. Rik <rik@octave.org> parents: 21658 diff changeset	103 %! axis ([1, 64, 0, 1], "xy");
283d8dfcad37 Make demos Matlab compatible for comparison with dump_demos script. Rik <rik@octave.org> parents: 21658 diff changeset	104 %! set (gca, "xtick", []);
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	105 %! 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	106 %! title ("grayscale colormap brightened by 0.5");

Mercurial > octave

annotate scripts/image/brighten.m @ 27919:1891570abac8