Mercurial > octave
view scripts/plot/draw/plotyy.m @ 32062:ada96a467a28
quiver: Improve plotting with non-float numeric inputs (bug #59695)
* scripts/plot/draw/private/__quiver__.m: Change firstnonnumeric check to look
for char instead of numeric to allow for logical inputs. Recast all inputs
up to firstnonnumeric as doubles. Check if firstnonnumeric element is 'off'
and if so set scale factor to 0 and increment firstnonnumeric.
* scripts/plot/draw/quiver.m: Update docstring to include scaling factor
option 'off'. Add BIST for int and logical input types.
* scripts/plot/draw/quiver3.m: Update docstring to include scaling factor
option 'off'. Add BISTs for too-few inputs.
* etc/NEWS.9.md: Appended details of changes to quiver note under General
Improvements and noted it also applies to quiver3.
author | Nicholas R. Jankowski <jankowski.nicholas@gmail.com> |
---|---|
date | Wed, 26 Apr 2023 17:18:50 -0400 |
parents | 597f3ee61a48 |
children | 2e484f9f1f18 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2007-2023 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {} plotyy (@var{x1}, @var{y1}, @var{x2}, @var{y2}) ## @deftypefnx {} {} plotyy (@dots{}, @var{fcn}) ## @deftypefnx {} {} plotyy (@dots{}, @var{fun1}, @var{fun2}) ## @deftypefnx {} {} plotyy (@var{hax}, @dots{}) ## @deftypefnx {} {[@var{ax}, @var{h1}, @var{h2}] =} plotyy (@dots{}) ## Plot two sets of data with independent y-axes and a common x-axis. ## ## The arguments @var{x1} and @var{y1} define the arguments for the first plot ## and @var{x1} and @var{y2} for the second. ## ## By default the arguments are evaluated with ## @code{feval (@@plot, @var{x}, @var{y})}. However the type of plot can be ## modified with the @var{fcn} argument, in which case the plots are ## generated by @code{feval (@var{fcn}, @var{x}, @var{y})}. @var{fcn} can be ## a function handle, an inline function, or a string of a function name. ## ## The function to use for each of the plots can be independently defined ## with @var{fun1} and @var{fun2}. ## ## The first argument @var{hax} can be an axes handle to the principal axes in ## which to plot the @var{x1} and @var{y1} data. It can also be a two-element ## vector with the axes handles to the primary and secondary axes (see output ## @var{ax}). ## ## The return value @var{ax} is a vector with the axes handles of the two ## y-axes. @var{h1} and @var{h2} are handles to the objects generated by the ## plot commands. ## ## @example ## @group ## x = 0:0.1:2*pi; ## y1 = sin (x); ## y2 = exp (x - 1); ## ax = plotyy (x, y1, x - 1, y2, @@plot, @@semilogy); ## xlabel ("X"); ## ylabel (ax(1), "Axis 1"); ## ylabel (ax(2), "Axis 2"); ## @end group ## @end example ## ## When using @code{plotyy} in conjunction with @code{subplot} make sure to ## call @code{subplot} first and pass the resulting axes handle to ## @code{plotyy}. Do not call @code{subplot} with any of the axes handles ## returned by @code{plotyy} or the other axes will be removed. ## ## @seealso{plot, subplot} ## @end deftypefn function [ax, h1, h2] = plotyy (varargin) ## Check if first argument is axes handle(s). hax = []; if (numel (varargin) > 0) if (isscalar (varargin{1})) [hax, varargin] = __plt_get_axis_arg__ ("plotyy", varargin{:}); elseif (numel (varargin{1}) == 2 && all (isaxes (varargin{1}))) ## First argument might be vector with the two handles to plotyy axes. hax = varargin{1}(1); varargin(1) = []; endif endif nargin = numel (varargin); if (nargin < 4 || nargin > 6) print_usage (); endif oldfig = []; if (! isempty (hax)) oldfig = get (0, "currentfigure"); endif unwind_protect hax = newplot (hax); ## FIXME: Second conditional test shouldn't be required. ## 'cla reset' needs to delete user properties like __plotyy_axes__. if (isprop (hax, "__plotyy_axes__") && isaxes (get (hax, "__plotyy_axes__")) == [true; true]) hax = get (hax, "__plotyy_axes__"); else hax = [hax; axes("nextplot", get (hax(1), "nextplot"), ... "parent", get (hax(1), "parent"))]; endif [axtmp, h1tmp, h2tmp] = __plotyy__ (hax, varargin{:}); set (gcf, "currentaxes", hax(1)); unwind_protect_cleanup if (! isempty (oldfig)) set (0, "currentfigure", oldfig); endif end_unwind_protect if (nargout > 0) ax = axtmp; h1 = h1tmp; h2 = h2tmp; endif endfunction function [ax, h1, h2] = __plotyy__ (ax, x1, y1, x2, y2, fun1 = @plot, fun2) if (nargin < 7) fun2 = fun1; endif xlim = [min([x1(:); x2(:)]), max([x1(:); x2(:)])]; axes (ax(1)); h1 = feval (fun1, x1, y1); set (ax(1), "xlim", xlim); if (isscalar (h1)) ## Coloring y-axis only makes sense if plot contains exactly one line set (ax(1), "ycolor", getcolor (h1)); endif set (gcf (), "nextplot", "add"); axes (ax(2)); if (strcmp (get (ax(1), "nextplot"), "replace")) ## Reset axes here because we don't want it to reset later after we set ## some properties in preparation for the plot in the secondary axes. reset (ax(2)); endif colors = get (ax(1), "colororder"); set (ax(2), "colororder", circshift (colors, -numel (h1), 1)); if (strcmp (get (ax(1), "__autopos_tag__"), "subplot")) set (ax(2), "__autopos_tag__", "subplot"); elseif (strcmp (graphics_toolkit (), "gnuplot")) set (ax, "positionconstraint", "innerposition"); else set (ax, "positionconstraint", "outerposition"); endif ## Don't replace axis which has colororder property already modified if (strcmp (get (ax(1), "nextplot"), "replace")) set (ax(2), "nextplot", "replacechildren"); endif h2 = feval (fun2, x2, y2); set (ax(2), "yaxislocation", "right", "color", "none", "box", "off", "xlim", xlim); if (isscalar (h2)) ## Coloring y-axis only makes sense if plot contains exactly one line set (ax(2), "ycolor", getcolor (h2)); endif set (ax(2), "units", get (ax(1), "units")); if (strcmp (get (ax(1), "positionconstraint"), "innerposition")) set (ax(2), "position", get (ax(1), "position")); else set (ax(2), {"outerposition", "looseinset"}, get (ax(1), {"outerposition", "looseinset"})); endif ## Restore nextplot value by copying value from axis #1 set (ax(2), "nextplot", get (ax(1), "nextplot")); ## Add invisible text objects that when destroyed, ## also remove the other axis t1 = text (0, 0, "", "parent", ax(1), "tag", "plotyy", "visible", "off", "handlevisibility", "off", "xliminclude", "off", "yliminclude", "off", "zliminclude", "off"); t2 = text (0, 0, "", "parent", ax(2), "tag", "plotyy", "visible", "off", "handlevisibility", "off", "xliminclude", "off", "yliminclude", "off", "zliminclude", "off"); set (t1, "deletefcn", {@deleteplotyy, ax(2), t2}); set (t2, "deletefcn", {@deleteplotyy, ax(1), t1}); ## Add cross-listeners so a change in one axes' attributes updates the other. props = {"units", "looseinset", "position", "xlim", "view", ... "plotboxaspectratio", "plotboxaspectratiomode", "nextplot"}; for ii = 1:numel (props) addlistener (ax(1), props{ii}, {@update_prop, ax(2), props{ii}}); addlistener (ax(2), props{ii}, {@update_prop, ax(1), props{ii}}); endfor ## Store the axes handles for the sister axes. if (! isprop (ax(1), "__plotyy_axes__")) addproperty ("__plotyy_axes__", ax(1), "data"); endif set (ax(1), "__plotyy_axes__", ax); if (! isprop (ax(2), "__plotyy_axes__")) addproperty ("__plotyy_axes__", ax(2), "data"); endif set (ax(2), "__plotyy_axes__", ax); ## Call position property listener explicitly update_prop (ax(1), [], ax(2), "position"); endfunction function deleteplotyy (h, ~, ax2, t2) if (isaxes (ax2) && ! any (strcmp({dbstack().name}, "plotyy"))) set (t2, "deletefcn", []); delete (ax2); endif endfunction function update_nextplot (h, ~, ax2) persistent recursion = false; if (! recursion) unwind_protect recursion = true; set (ax2, "nextplot", get (h, "nextplot")); unwind_protect_cleanup recursion = false; end_unwind_protect endif endfunction function update_prop (h, ~, ax2, prop) persistent recursion = false; ## Don't allow recursion if (! recursion && all (ishghandle ([h, ax2]))) unwind_protect recursion = true; val = get (h, prop); if (strcmpi (prop, "position") || strcmpi (prop, "outerposition")) ## Save/restore "positionconstraint" constraint = get (ax2, "positionconstraint"); set (ax2, prop, get (h, prop), "positionconstraint", constraint); else set (ax2, prop, get (h, prop)); endif unwind_protect_cleanup recursion = false; end_unwind_protect endif endfunction function color = getcolor (ax) obj = get (ax); if (isfield (obj, "color")) color = obj.color; elseif (isfield (obj, "facecolor") && ! ischar (obj.facecolor)) color = obj.facecolor; elseif (isfield (obj, "edgecolor") && ! ischar (obj.edgecolor)) color = obj.edgecolor; else color = [0, 0, 0]; endif endfunction %!demo %! clf; %! x = 0:0.1:2*pi; %! y1 = sin (x); %! y2 = exp (x - 1); %! ax = plotyy (x,y1, x-1,y2, @plot, @semilogy); %! xlabel ("X"); %! ylabel (ax(1), "Axis 1"); %! ylabel (ax(2), "Axis 2"); %! colororder = get (gca, "ColorOrder"); %! lcolor = colororder(1,:); %! rcolor = colororder(2,:); %! text (0.5, 0.5, "Left Axis", ... %! "color", lcolor, "horizontalalignment", "center", "parent", ax(1)); %! text (4.5, 80, "Right Axis", ... %! "color", rcolor, "horizontalalignment", "center", "parent", ax(2)); %! title ({"plotyy() example"; "left axis uses @plot, right axis uses @semilogy"}); %!demo %! clf; %! colormap ("default"); %! x = linspace (-1, 1, 201); %! subplot (2,2,1); %! plotyy (x,sin (pi*x), x,10*cos (pi*x)); %! title ("plotyy() in subplot"); %! subplot (2,2,2); %! surf (peaks (25)); %! subplot (2,2,3); %! contour (peaks (25)); %! subplot (2,2,4); %! plotyy (x,10*sin (2*pi*x), x,cos (2*pi*x)); %! title ("plotyy() in subplot"); %! axis square;