octave: scripts/time/datetick.m annotate

annotate scripts/time/datetick.m @ 14138:72c96de7a403 stable

maint: update copyright notices for 2012

author	John W. Eaton <jwe@octave.org>
date	Mon, 02 Jan 2012 14:25:41 -0500
parents	35c0b722d2e4
children	11949c9795a0

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 13082 diff changeset	1 ## Copyright (C) 2008-2012 David Bateman
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	2 ##
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	3 ## This file is part of Octave.
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	4 ##
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	8 ## your option) any later version.
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	9 ##
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	13 ## General Public License for more details.
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	14 ##
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	16 ## along with Octave; see the file COPYING. If not, see
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	17 ## <http://www.gnu.org/licenses/>.
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	18
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	19 ## -- texinfo --
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 10369 diff changeset	20 ## @deftypefn {Function File} {} datetick ()
10151 c2f1cdb59821 datetick: make form argument optional John W. Eaton <jwe@octave.org> parents: 9245 diff changeset	21 ## @deftypefnx {Function File} {} datetick (@var{form})
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	22 ## @deftypefnx {Function File} {} datetick (@var{axis}, @var{form})
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	23 ## @deftypefnx {Function File} {} datetick (@dots{}, "keeplimits")
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	24 ## @deftypefnx {Function File} {} datetick (@dots{}, "keepticks")
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	25 ## @deftypefnx {Function File} {} datetick (@dots{ax}, @dots{})
12575 d0b799dafede Grammarcheck files for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	26 ## Add date formatted tick labels to an axis. The axis the apply the
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	27 ## ticks to is determined by @var{axis} that can take the values "x",
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8325 diff changeset	28 ## "y" or "z". The default value is "x". The formatting of the labels is
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	29 ## determined by the variable @var{form}, that can either be a string in
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	30 ## the format needed by @code{dateform}, or a positive integer that can
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	31 ## be accepted by @code{datestr}.
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	32 ## @seealso{datenum, datestr}
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	33 ## @end deftypefn
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	34
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	35 function datetick (varargin)
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	36
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	37 [h, varargin, nargin] = __plt_get_axis_arg__ ("datetick", varargin{:});
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	38
10151 c2f1cdb59821 datetick: make form argument optional John W. Eaton <jwe@octave.org> parents: 9245 diff changeset	39 oldh = gca ();
c2f1cdb59821 datetick: make form argument optional John W. Eaton <jwe@octave.org> parents: 9245 diff changeset	40 unwind_protect
c2f1cdb59821 datetick: make form argument optional John W. Eaton <jwe@octave.org> parents: 9245 diff changeset	41 axes (h);
c2f1cdb59821 datetick: make form argument optional John W. Eaton <jwe@octave.org> parents: 9245 diff changeset	42 __datetick__ (varargin{:});
c2f1cdb59821 datetick: make form argument optional John W. Eaton <jwe@octave.org> parents: 9245 diff changeset	43 unwind_protect_cleanup
c2f1cdb59821 datetick: make form argument optional John W. Eaton <jwe@octave.org> parents: 9245 diff changeset	44 axes (oldh);
c2f1cdb59821 datetick: make form argument optional John W. Eaton <jwe@octave.org> parents: 9245 diff changeset	45 end_unwind_protect
c2f1cdb59821 datetick: make form argument optional John W. Eaton <jwe@octave.org> parents: 9245 diff changeset	46
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	47 endfunction
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	48
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	49 %!demo
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	50 %! yr = 1900:10:2000;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	51 %! pop = [76.094, 92.407, 106.461, 123.077 131.954, 151.868, 179.979, ...
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	52 %! 203.984, 227.225, 249.623, 282.224];
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	53 %! plot (datenum (yr, 1, 1), pop);
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	54 %! title ("US population (millions)");
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	55 %! xlabel ("Year");
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	56 %! datetick ("x", "YYYY");
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	57
10369 3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	58 %!demo
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	59 %! yr =1988:2:2002;
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	60 %! yr =datenum(yr,1,1);
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	61 %! pr = [12.1 13.3 12.6 13.1 13.3 14.1 14.4 15.2];
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	62 %! plot(yr,pr);
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	63 %! xlabel('year')
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	64 %! ylabel('average price')
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	65 %! ax=gca;
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	66 %! set(ax,'xtick',datenum(1990:5:2005,1,1))
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	67 %! datetick(2,'keepticks')
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	68 %! set(ax,'ytick',12:16)
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	69
13082 35c0b722d2e4 codesprint: mark datetick as tested. John W. Eaton <jwe@octave.org> parents: 12575 diff changeset	70 ## Remove from test statistics. No real tests possible.
35c0b722d2e4 codesprint: mark datetick as tested. John W. Eaton <jwe@octave.org> parents: 12575 diff changeset	71 %!assert (1)
35c0b722d2e4 codesprint: mark datetick as tested. John W. Eaton <jwe@octave.org> parents: 12575 diff changeset	72
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	73 function __datetick__ (varargin)
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	74
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	75 keeplimits = false;
10369 3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	76 keepticks = false;
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	77 idx = [];
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	78 for i = 1 : nargin
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	79 arg = varargin {i};
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	80 if (ischar (arg))
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	81 if (strcmpi (arg, "keeplimits"))
10369 3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	82 keeplimits = true;
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	83 idx = [idx, i];
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	84 elseif (strcmpi (arg, "keepticks"))
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	85 keepticks = true;
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	86 idx = [idx, i];
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	87 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	88 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	89 endfor
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	90
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	91 varargin(idx) = [];
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	92 nargin = length (varargin);
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	93 form = [];
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	94 ax = "x";
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	95
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	96 if (nargin != 0)
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	97 arg = varargin{1};
11149 fe3c3dfc07eb style fix: break lines before && and \|\|, not after John W. Eaton <jwe@octave.org> parents: 10793 diff changeset	98 if (ischar (arg) && (strcmp (arg, "x") \|\| strcmp (arg, "y")
fe3c3dfc07eb style fix: break lines before && and \|\|, not after John W. Eaton <jwe@octave.org> parents: 10793 diff changeset	99 \|\| strcmp (arg, "z")))
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	100 ax = arg;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	101 if (nargin > 1)
10369 3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	102 form = varargin{2};
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	103 varargin(1:2) = [];
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	104 else
10369 3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	105 varargin(1) = [];
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	106 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	107 else
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	108 form = arg;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	109 varargin(1) = [];
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	110 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	111 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	112
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	113 ## Don't publish the existence of this variable for use with dateaxis
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	114 if (length (varargin) > 0)
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	115 startdate = varargin{1};
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	116 else
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	117 startdate = [];
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	118 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	119
10151 c2f1cdb59821 datetick: make form argument optional John W. Eaton <jwe@octave.org> parents: 9245 diff changeset	120 if (! isempty (form))
c2f1cdb59821 datetick: make form argument optional John W. Eaton <jwe@octave.org> parents: 9245 diff changeset	121 if (isnumeric (form))
c2f1cdb59821 datetick: make form argument optional John W. Eaton <jwe@octave.org> parents: 9245 diff changeset	122 if (! isscalar (form) \|\| floor (form) != form \|\| form < 0)
11472 1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done. Rik <octave@nomad.inbox5.com> parents: 11294 diff changeset	123 error ("datetick: expecting FORM argument to be a positive integer");
10151 c2f1cdb59821 datetick: make form argument optional John W. Eaton <jwe@octave.org> parents: 9245 diff changeset	124 endif
c2f1cdb59821 datetick: make form argument optional John W. Eaton <jwe@octave.org> parents: 9245 diff changeset	125 elseif (! ischar (form))
c2f1cdb59821 datetick: make form argument optional John W. Eaton <jwe@octave.org> parents: 9245 diff changeset	126 error ("datetick: expecting valid date format string");
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	127 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	128 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	129
10369 3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	130 if (keepticks)
11294 e2a4f3478b7c datetick.m: add missing semicolon John W. Eaton <jwe@octave.org> parents: 11149 diff changeset	131 ticks = get (gca (), strcat (ax, "tick"));
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	132 else
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	133 ## Need to do our own axis tick position calculation as
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	134 ## year, etc, don't fallback on nice datenum values.
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	135 objs = findall (gca());
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	136 xmax = NaN;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	137 xmin = NaN;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	138 for i = 1 : length (objs)
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	139 fld = get (objs (i));
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	140 if (isfield (fld, strcat (ax, "data")))
10369 3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	141 xdata = getfield (fld, strcat (ax, "data"))(:);
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	142 xmin = min (xmin, min (xdata));
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	143 xmax = max (xmax, max (xdata));
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	144 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	145 endfor
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	146
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	147 if (isnan (xmin) \|\| isnan (xmax))
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	148 xmin = 0;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	149 xmax = 1;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	150 elseif (xmin == xmax)
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	151 xmax = xmin + 1;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	152 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	153
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	154 N = 3;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	155 if (xmax - xmin < N)
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	156 ## Day scale or less
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	157 if (xmax - xmin < N / 24 / 60 / 60)
10369 3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	158 scl = 1 / 24 / 60 / 60;
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	159 elseif (xmax - xmin < N / 24 / 6)
10369 3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	160 scl = 1 / 24 / 60;
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	161 else
10369 3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	162 scl = 1 / 24;
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	163 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	164 sep = __calc_tick_sep__ (xmin / scl , xmax / scl);
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	165 xmin = sep * floor (xmin / scl / sep);
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	166 xmax = sep * ceil (xmax / scl / sep);
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	167 nticks = (xmax - xmin) / sep + 1;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	168 xmin *= scl;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	169 xmax *= scl;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	170 else
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	171 [ymin, mmin, dmin] = datevec (xmin);
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	172 [ymax, mmax, dmax] = datevec (xmax);
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	173 minyear = ymin + (mmin - 1) / 12 + (dmin - 1) / 12 / 30;
c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	174 maxyear = ymax + (mmax - 1) / 12 + (dmax - 1) / 12 / 30;
c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	175 minmonth = mmin + (dmin - 1) / 30;
c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	176 maxmonth = (ymax - ymin) * 12 + mmax + (dmax - 1) / 30;
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	177
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	178 if (maxmonth - minmonth < N)
10369 3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	179 sep = __calc_tick_sep__ (xmin, xmax);
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	180 xmin = sep * floor (xmin / sep);
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	181 xmax = sep * ceil (xmax / sep);
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	182 nticks = (xmax - xmin) / sep + 1;
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	183 elseif (maxyear - minyear < N)
10369 3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	184 sep = __calc_tick_sep__ (minmonth , maxmonth);
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	185 xmin = datenum (ymin, sep * floor (minmonth / sep), 1);
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	186 xmax = datenum (ymin, sep * ceil (maxmonth / sep), 1);
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	187 nticks = ceil (maxmonth / sep) - floor (minmonth / sep) + 1;
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	188 else
10369 3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	189 sep = __calc_tick_sep__ (minyear , maxyear);
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	190 xmin = datenum (sep * floor (minyear / sep), 1, 1);
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	191 xmax = datenum (sep * ceil (maxyear / sep), 1, 1);
3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	192 nticks = ceil (maxyear / sep) - floor (minyear / sep) + 1;
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	193 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	194 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	195 ticks = xmin + [0 : nticks - 1] / (nticks - 1) * (xmax - xmin);
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	196 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	197
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	198 if (isempty (form))
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	199 r = max(ticks) - min(ticks);
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	200 if r < 10/60/24
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	201 ## minutes and seconds
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	202 form = 13;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	203 elseif r < 2
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	204 ## hours
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	205 form = 15;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	206 elseif r < 15
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	207 ## days
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	208 form = 8;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	209 elseif r < 365
10151 c2f1cdb59821 datetick: make form argument optional John W. Eaton <jwe@octave.org> parents: 9245 diff changeset	210 ## FIXME -- FORM should be 19 for European users who use dd/mm
c2f1cdb59821 datetick: make form argument optional John W. Eaton <jwe@octave.org> parents: 9245 diff changeset	211 ## instead of mm/dd. How can that be determined automatically?
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	212 ## months
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	213 form = 6;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	214 elseif r < 90*12
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	215 ## quarters
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	216 form = 27;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	217 else
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	218 ## years
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	219 form = 10;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	220 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	221 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	222
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	223 if (length (ticks) == 6)
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	224 ## Careful that its not treated as a datevec
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	225 if (! isempty (startdate))
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	226 sticks = strvcat (datestr (ticks(1:end-1) - ticks(1) + startdate, form),
10369 3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	227 datestr (ticks(end) - ticks(1) + startdate, form));
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	228 else
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	229 sticks = strvcat (datestr (ticks(1:end-1), form),
10369 3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	230 datestr (ticks(end), form));
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	231 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	232 else
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	233 if (! isempty (startdate))
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	234 sticks = datestr (ticks - ticks(1) + startdate, form);
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	235 else
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	236 sticks = datestr (ticks, form);
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	237 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	238 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	239
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	240 sticks = mat2cell (sticks, ones (rows (sticks), 1), columns (sticks));
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	241
10369 3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	242 if (keepticks)
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	243 if (keeplimits)
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	244 set (gca(), strcat (ax, "ticklabel"), sticks);
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	245 else
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	246 set (gca(), strcat (ax, "ticklabel"), sticks, strcat (ax, "lim"),
10369 3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	247 [min(ticks), max(ticks)]);
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	248 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	249 else
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	250 if (keeplimits)
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	251 set (gca(), strcat (ax, "tick"), ticks, strcat (ax, "ticklabel"), sticks);
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	252 else
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	253 set (gca(), strcat (ax, "tick"), ticks, strcat (ax, "ticklabel"), sticks,
10369 3516a245d607 datetick.m: Fix 'keepticks' bug, and untabify. Ben Abbott <bpabbott@mac.com> parents: 10151 diff changeset	254 strcat (ax, "lim"), [min(ticks), max(ticks)]);
8112 31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	255 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	256 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	257 endfunction
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	258
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	259 function [a, b] = __magform__ (x)
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	260 if (x == 0)
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	261 a = 0;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	262 b = 0;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	263 else
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	264 l = log10 (abs (x));
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	265 r = fmod (l, 1);
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	266 a = 10 .^ r;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	267 b = fix (l - r);
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	268 if (a < 1)
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	269 a *= 10;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	270 b -= 1;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	271 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	272 if (x < 0)
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	273 a = -a;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	274 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	275 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	276 endfunction
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	277
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	278 ## A translation from Tom Holoryd's python code at
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	279 ## http://kurage.nimh.nih.gov/tomh/tics.py
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	280 function sep = __calc_tick_sep__ (lo, hi)
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	281 persistent sqrt_2 = sqrt (2.0);
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	282 persistent sqrt_10 = sqrt (10.0);
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	283 persistent sqrt_50 = sqrt (50.0);
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	284
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	285 ticint = 5;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	286
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	287 ## Reference: Lewart, C. R., "Algorithms SCALE1, SCALE2, and
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	288 ## SCALE3 for Determination of Scales on Computer Generated
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	289 ## Plots", Communications of the ACM, 10 (1973), 639-640.
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	290 ## Also cited as ACM Algorithm 463.
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	291
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	292 [a, b] = __magform__ ((hi - lo) / ticint);
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	293
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	294 if (a < sqrt_2)
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	295 x = 1;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	296 elseif (a < sqrt_10)
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	297 x = 2;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	298 elseif (a < sqrt_50)
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	299 x = 5;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	300 else
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	301 x = 10;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	302 endif
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	303 sep = x * 10 .^ b;
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	304 endfunction
31e86163b752 Add the datetick function David Bateman <dbateman@free.fr> parents: diff changeset	305

Mercurial > octave

annotate scripts/time/datetick.m @ 14138:72c96de7a403 stable