Source: utils/date_time/timebox.pro
TIMEBOX
Create axis box with time labelling.
This is sort of equivalent to a plot, /nodata, /noerase call.
Usage:
timebox, tstart, tend, torigin, [/day, /nomins, /zero, exact=exact, $
/nolabels, minutes=minutes, /noerase,
/date, <PLOT keys>]
Arguments:
tstart double input The starting JD
tend double input The ending JD
torigin double output The origin JD [this value needs to be
subtracted from the time axis before
plotting; it's needed because the PLOT
routine internally uses
single-precision and JD's only give
quarter-day resolution at single
precision] Now only needed for ancient
versions (<5.4) of IDL.
Keywords:
nomins undef input Supress minutes when tick mark spacing is
1 hour < spacing < 1 day.
zero undef input Supress printing of day at hours other than
zero.
exact undef input If set then the time range is exact.
xtitle string input X-axis title.
nolabels ? input If set then don't plot any labels on the plot.
minutes int output Set to 1 if time range < 2 mins else 0.
noerase ? input If explicitly zero, then do an erase
if unset or non-zero, then don't erase
date ? input If set, then use month & date rather
than day of year.
Restrictions:
For time ranges > 4 months the time range is always exact.
Note:
Any keyword accepted by the PLOT procedure can also be passed
to timebox: [However some such as xlog may produce some rather
nasty consequences], some of the plot keywords are given
explictly as they interact with TIMEBOX's operation directly.
History:
Prototype: 8/12/92; SJT
Add nolabels and minutes keys: 11/12/92; SJT
Add noerase key: 29/9/93; SJT
Safety when data don't start in requested year: 11/5/94; SJT
Fix end offsets in exact range case: 9/11/94; SJT
Sort out defined ranges for Delta T > 6 months: 6/1/95; SJT
Added date key: 16/2/95; SJT
Fix for year >= 2000: 1/12/95; SJT
Fix for span > 10 years: 25/10/99; SJT
Reworked into JD: 14-16/12/99; SJT
Make torigin argument optional, now plot is internally
double-precision: 26/1/05; SJT