update packages

[CreaPhase.git] / octave_packages / m / plot / caxis.m

diff --git a/octave_packages/m/plot/caxis.m b/octave_packages/m/plot/caxis.m
new file mode 100644 (file)
index 0000000..26a7b4b
--- /dev/null
+++ b/octave_packages/m/plot/caxis.m
@@ -0,0 +1,88 @@
+## Copyright (C)  2007-2012 David Bateman
+##
+## This file is part of Octave.
+##
+## Octave is free software; you can redistribute it and/or modify it
+## under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 3 of the License, or (at
+## your option) any later version.
+##
+## Octave is distributed in the hope that it will be useful, but
+## WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+## General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with Octave; see the file COPYING.  If not, see
+## <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn  {Function File} {} caxis (@var{limits})
+## @deftypefnx {Function File} {} caxis (@var{h}, @dots{})
+## Set color axis limits for plots.
+##
+## The argument @var{limits} should be a 2-element vector specifying the
+## lower and upper limits to assign to the first and last value in the
+## colormap.  Values outside this range are clamped to the first and last
+## colormap entries.
+##
+## If @var{limits} is 'auto', then automatic colormap scaling is applied,
+## whereas if @var{limits} is 'manual' the colormap scaling is set to manual.
+##
+## Called without any arguments to current color axis limits are returned.
+##
+## If an axes handle is passed as the first argument, then operate on
+## this axes rather than the current axes.
+## @end deftypefn
+
+function varargout = caxis (varargin)
+
+  [h, varargin, nargin] = __plt_get_axis_arg__ ("caxis", varargin{:});
+
+  oldh = gca ();
+  unwind_protect
+    axes (h);
+    varargout = cell (max (nargin == 0, nargout), 1);
+    if (isempty (varargout))
+      __caxis__ (h, varargin{:});
+    else
+      [varargout{:}] = __caxis__ (h, varargin{:});
+    endif
+  unwind_protect_cleanup
+    axes (oldh);
+  end_unwind_protect
+
+endfunction
+
+function [cmin, cmax] = __caxis__ (ca, ax, varargin)
+
+  if (nargin == 1)
+    cmin = get (ca, "clim");
+    if (nargout > 1)
+      cmax = cmin(2);
+      cmin = cmin(1);
+    endif
+  elseif (ischar (ax))
+    if (strcmpi (ax, "auto"))
+      set (ca, "climmode", "auto");
+    elseif (strcmpi (ax, "manual"))
+      set (ca, "climmode", "manual");
+    endif
+  elseif (isvector (ax))
+    len = length (ax);
+
+    if (len != 2)
+      error ("caxis: expecting vector with 2 elements");
+    endif
+
+    set (ca, "clim", [ax(1), ax(2)]);
+  else
+    error ("caxis: expecting no args, a string or a 2 element vector");
+  endif
+
+  if (nargin > 2)
+    __caxis__ (ca, varargin{:})';
+  endif
+
+endfunction
+