@header@
 
 
matplotlib.dates		index
/usr/local/lib/python2.3/site-packages/matplotlib/dates.py

Matplotlib provides sophisticated date plotting capabilites, standing
on the shoulders of python datetime, the add-on modules pytz and
dateutils.  datetime objects are converted to floating point numbers
which represent the number of days since 0001-01-01 UTC.  The helper
functions date2num, num2date and drange are used to facilitate easy
conversion to and from datetime and numeric ranges.
 
A wide range of specific and general purpose date tick locators and
formatters are provided in this module.  See matplotlib.tickers for
general information on tick locators and formatters.  These are
described below.
 
All the matplotlib date converters, tickers and formatters are
timezone aware, and the default timezone is given by the timezone
parameter in your matplotlibrc file.  If you leave out a tz timezone
instance, the default from your rc file will be assumed.  If you want
to use a custom time zone, pass a matplotlib.pytz.timezone instance
with the tz keyword argument to num2date, plot_date, and any custom
date tickers or locators you create.  See http://pytz.sourceforge.net
for information on pytz and timezone handling.
 
dateutils https://moin.conectiva.com.br/DateUtil the code to handle
date ticking, making it easy to place ticks on any kinds of dates -
see examples below.
 
Date tickers -
 
  Most of the date tickers can locate single or multiple values.  Eg
 
    # tick on mondays every week
    loc = WeekdayLocator(byweekday=MO, tz=tz)  
 
    # tick on mondays and saturdays
    loc = WeekdayLocator(byweekday=(MO, SA))  
 
  In addition, most of the constructors take an interval argument.
 
    # tick on mondays every second week
    loc = WeekdayLocator(byweekday=MO, interval=2)  
 
  The rrule locator allows completely general date ticking
 
    # tick every 5th easter
    rule = rrulewrapper(YEARLY, byeaster=1, interval=5)
    loc = RRuleLocator(rule)
 
  Here are all the date tickers
 
    * MinuteLocator  - locate minutes 
 
    * HourLocator    - locate hours 
 
    * DayLocator     - locate specifed days of the month
 
    * WeekdayLocator - Locate days of the week, eg MO, TU
 
    * MonthLocator   - locate months, eg 7 for july
 
    * YearLocator    - locate years that are multiples of base
 
    * RRuleLocator - locate using a matplotlib.dates.rrulewrapper.
        The rrulewrapper is a simple wrapper around a dateutils.rrule
        https://moin.conectiva.com.br/DateUtil which allow almost
        arbitrary date tick specifications.  See
        examples/date_demo_rrule.py
 
 
Date formatters
 
  DateFormatter - use strftime format strings
 
  DateIndexFormatter - date plots with implicit x indexing.

 
Modules
       
datetime
matplotlib
re
sys
time

 
Classes
       
matplotlib.ticker.Formatter(matplotlib.ticker.TickHelper)
DateFormatter
IndexDateFormatter
matplotlib.ticker.Locator(matplotlib.ticker.TickHelper)
DateLocator
RRuleLocator
DayLocator
HourLocator
MinuteLocator
MonthLocator
SecondLocator
WeekdayLocator
YearLocator
rrulewrapper

 
class DateFormatter(matplotlib.ticker.Formatter)
    Tick location is seconds since the epoch.  Use a strftime format
string
 
python only supports datetime strftime formatting for years
greater than 1900.  Thanks to Andrew Dalke, Dalke Scientific
Software who contributed the strftime code below to include dates
earlier than this year
 
 
Method resolution order:
DateFormatter
matplotlib.ticker.Formatter
matplotlib.ticker.TickHelper
Methods defined here:
__call__(self, x, pos=0)
__init__(self, fmt, tz=None)
fmt is an strftime format string; tz is the tzinfo instance
set_tzinfo(self, tz)
strftime(self, dt, fmt)
Data and other attributes defined here:
illegal_s = <_sre.SRE_Pattern object>
Methods inherited from matplotlib.ticker.Formatter:
set_locs(self, locs)
Data and other attributes inherited from matplotlib.ticker.Formatter:
locs = None
Methods inherited from matplotlib.ticker.TickHelper:
set_data_interval(self, interval)
set_view_interval(self, interval)
verify_intervals(self)
Data and other attributes inherited from matplotlib.ticker.TickHelper:
dataInterval = None
viewInterval = None

 
class DateLocator(matplotlib.ticker.Locator)
    
Method resolution order:
DateLocator
matplotlib.ticker.Locator
matplotlib.ticker.TickHelper
Methods defined here:
__init__(self, tz=None)
tz is the tzinfo instance
datalim_to_dt(self)
set_tzinfo(self, tz)
viewlim_to_dt(self)
Data and other attributes defined here:
hms0d = {'byhour': 0, 'byminute': 0, 'bysecond': 0}
Methods inherited from matplotlib.ticker.Locator:
__call__(self)
Return the locations of the ticks
autoscale(self)
autoscale the view limits
nonsingular(self, vmin, vmax)
pan(self, numsteps)
Pan numticks (can be positive or negative)
refresh(self)
refresh internal information based on current lim
zoom(self, direction)
Zoom in/out on axis; if direction is >0 zoom in, else zoom out
Methods inherited from matplotlib.ticker.TickHelper:
set_data_interval(self, interval)
set_view_interval(self, interval)
verify_intervals(self)
Data and other attributes inherited from matplotlib.ticker.TickHelper:
dataInterval = None
viewInterval = None

 
class DayLocator(RRuleLocator)
    Make ticks on occurances of each day of the month, eg 1, 15, 30
 
 
Method resolution order:
DayLocator
RRuleLocator
DateLocator
matplotlib.ticker.Locator
matplotlib.ticker.TickHelper
Methods defined here:
__init__(self, bymonthday=None, interval=1, tz=None)
mark every day in bymonthday; bymonthday can be an int or sequence
 
Default is to tick every day of the month - bymonthday=range(1,32)
Methods inherited from RRuleLocator:
__call__(self)
autoscale(self)
Set the view limits to include the data range
Methods inherited from DateLocator:
datalim_to_dt(self)
set_tzinfo(self, tz)
viewlim_to_dt(self)
Data and other attributes inherited from DateLocator:
hms0d = {'byhour': 0, 'byminute': 0, 'bysecond': 0}
Methods inherited from matplotlib.ticker.Locator:
nonsingular(self, vmin, vmax)
pan(self, numsteps)
Pan numticks (can be positive or negative)
refresh(self)
refresh internal information based on current lim
zoom(self, direction)
Zoom in/out on axis; if direction is >0 zoom in, else zoom out
Methods inherited from matplotlib.ticker.TickHelper:
set_data_interval(self, interval)
set_view_interval(self, interval)
verify_intervals(self)
Data and other attributes inherited from matplotlib.ticker.TickHelper:
dataInterval = None
viewInterval = None

 
class HourLocator(RRuleLocator)
    Make ticks on occurances of each hour
 
 
Method resolution order:
HourLocator
RRuleLocator
DateLocator
matplotlib.ticker.Locator
matplotlib.ticker.TickHelper
Methods defined here:
__init__(self, byhour=None, interval=1, tz=None)
mark every hour in byhour; byhour can be an int or sequence.
Default is to tick every hour - byhour=range(24)
 
interval is the interval between each iteration.  Eg, if
interval=2, mark every second occurance
Methods inherited from RRuleLocator:
__call__(self)
autoscale(self)
Set the view limits to include the data range
Methods inherited from DateLocator:
datalim_to_dt(self)
set_tzinfo(self, tz)
viewlim_to_dt(self)
Data and other attributes inherited from DateLocator:
hms0d = {'byhour': 0, 'byminute': 0, 'bysecond': 0}
Methods inherited from matplotlib.ticker.Locator:
nonsingular(self, vmin, vmax)
pan(self, numsteps)
Pan numticks (can be positive or negative)
refresh(self)
refresh internal information based on current lim
zoom(self, direction)
Zoom in/out on axis; if direction is >0 zoom in, else zoom out
Methods inherited from matplotlib.ticker.TickHelper:
set_data_interval(self, interval)
set_view_interval(self, interval)
verify_intervals(self)
Data and other attributes inherited from matplotlib.ticker.TickHelper:
dataInterval = None
viewInterval = None

 
class IndexDateFormatter(matplotlib.ticker.Formatter)
    Use with IndexLocator to cycle format strings by index.
 
 
Method resolution order:
IndexDateFormatter
matplotlib.ticker.Formatter
matplotlib.ticker.TickHelper
Methods defined here:
__call__(self, x, pos=0)
Return the label for time x at position pos
__init__(self, t, fmt, tz=None)
t is a sequence of dates floating point days).  fmt is a
strftime format string
Methods inherited from matplotlib.ticker.Formatter:
set_locs(self, locs)
Data and other attributes inherited from matplotlib.ticker.Formatter:
locs = None
Methods inherited from matplotlib.ticker.TickHelper:
set_data_interval(self, interval)
set_view_interval(self, interval)
verify_intervals(self)
Data and other attributes inherited from matplotlib.ticker.TickHelper:
dataInterval = None
viewInterval = None

 
class MinuteLocator(RRuleLocator)
    Make ticks on occurances of each minute
 
 
Method resolution order:
MinuteLocator
RRuleLocator
DateLocator
matplotlib.ticker.Locator
matplotlib.ticker.TickHelper
Methods defined here:
__init__(self, byminute=None, interval=1, tz=None)
mark every minute in byminute; byminute can be an int or
sequence.  default is to tick every minute - byminute=range(60)
 
interval is the interval between each iteration.  Eg, if
interval=2, mark every second occurance
Methods inherited from RRuleLocator:
__call__(self)
autoscale(self)
Set the view limits to include the data range
Methods inherited from DateLocator:
datalim_to_dt(self)
set_tzinfo(self, tz)
viewlim_to_dt(self)
Data and other attributes inherited from DateLocator:
hms0d = {'byhour': 0, 'byminute': 0, 'bysecond': 0}
Methods inherited from matplotlib.ticker.Locator:
nonsingular(self, vmin, vmax)
pan(self, numsteps)
Pan numticks (can be positive or negative)
refresh(self)
refresh internal information based on current lim
zoom(self, direction)
Zoom in/out on axis; if direction is >0 zoom in, else zoom out
Methods inherited from matplotlib.ticker.TickHelper:
set_data_interval(self, interval)
set_view_interval(self, interval)
verify_intervals(self)
Data and other attributes inherited from matplotlib.ticker.TickHelper:
dataInterval = None
viewInterval = None

 
class MonthLocator(RRuleLocator)
    Make ticks on occurances of each month month, eg 1, 3, 12
 
 
Method resolution order:
MonthLocator
RRuleLocator
DateLocator
matplotlib.ticker.Locator
matplotlib.ticker.TickHelper
Methods defined here:
__init__(self, bymonth=None, bymonthday=1, interval=1, tz=None)
mark every month in bymonth; bymonth can be an int or
sequence.  default is range(1,13), ie every month
 
interval is the interval between each iteration.  Eg, if
interval=2, mark every second occurance
Methods inherited from RRuleLocator:
__call__(self)
autoscale(self)
Set the view limits to include the data range
Methods inherited from DateLocator:
datalim_to_dt(self)
set_tzinfo(self, tz)
viewlim_to_dt(self)
Data and other attributes inherited from DateLocator:
hms0d = {'byhour': 0, 'byminute': 0, 'bysecond': 0}
Methods inherited from matplotlib.ticker.Locator:
nonsingular(self, vmin, vmax)
pan(self, numsteps)
Pan numticks (can be positive or negative)
refresh(self)
refresh internal information based on current lim
zoom(self, direction)
Zoom in/out on axis; if direction is >0 zoom in, else zoom out
Methods inherited from matplotlib.ticker.TickHelper:
set_data_interval(self, interval)
set_view_interval(self, interval)
verify_intervals(self)
Data and other attributes inherited from matplotlib.ticker.TickHelper:
dataInterval = None
viewInterval = None

 
class RRuleLocator(DateLocator)
    
Method resolution order:
RRuleLocator
DateLocator
matplotlib.ticker.Locator
matplotlib.ticker.TickHelper
Methods defined here:
__call__(self)
__init__(self, o, tz=None)
autoscale(self)
Set the view limits to include the data range
Methods inherited from DateLocator:
datalim_to_dt(self)
set_tzinfo(self, tz)
viewlim_to_dt(self)
Data and other attributes inherited from DateLocator:
hms0d = {'byhour': 0, 'byminute': 0, 'bysecond': 0}
Methods inherited from matplotlib.ticker.Locator:
nonsingular(self, vmin, vmax)
pan(self, numsteps)
Pan numticks (can be positive or negative)
refresh(self)
refresh internal information based on current lim
zoom(self, direction)
Zoom in/out on axis; if direction is >0 zoom in, else zoom out
Methods inherited from matplotlib.ticker.TickHelper:
set_data_interval(self, interval)
set_view_interval(self, interval)
verify_intervals(self)
Data and other attributes inherited from matplotlib.ticker.TickHelper:
dataInterval = None
viewInterval = None

 
class SecondLocator(RRuleLocator)
    Make ticks on occurances of each second
 
 
Method resolution order:
SecondLocator
RRuleLocator
DateLocator
matplotlib.ticker.Locator
matplotlib.ticker.TickHelper
Methods defined here:
__init__(self, bysecond=None, interval=1, tz=None)
mark every second in bysecond; bysecond can be an int or
sequence.  Default is to tick every second bysecond = range(60)
 
interval is the interval between each iteration.  Eg, if
interval=2, mark every second occurance
Methods inherited from RRuleLocator:
__call__(self)
autoscale(self)
Set the view limits to include the data range
Methods inherited from DateLocator:
datalim_to_dt(self)
set_tzinfo(self, tz)
viewlim_to_dt(self)
Data and other attributes inherited from DateLocator:
hms0d = {'byhour': 0, 'byminute': 0, 'bysecond': 0}
Methods inherited from matplotlib.ticker.Locator:
nonsingular(self, vmin, vmax)
pan(self, numsteps)
Pan numticks (can be positive or negative)
refresh(self)
refresh internal information based on current lim
zoom(self, direction)
Zoom in/out on axis; if direction is >0 zoom in, else zoom out
Methods inherited from matplotlib.ticker.TickHelper:
set_data_interval(self, interval)
set_view_interval(self, interval)
verify_intervals(self)
Data and other attributes inherited from matplotlib.ticker.TickHelper:
dataInterval = None
viewInterval = None

 
class WeekdayLocator(RRuleLocator)
    Make ticks on occurances of each weekday
 
 
Method resolution order:
WeekdayLocator
RRuleLocator
DateLocator
matplotlib.ticker.Locator
matplotlib.ticker.TickHelper
Methods defined here:
__init__(self, byweekday=1, interval=1, tz=None)
mark every weekday in byweekday; byweekday can be a number or
sequence
 
elements of byweekday must be one of MO, TU, WE, TH, FR, SA,
SU, the constants from dateutils.rrule
 
interval specifies the number of weeks to skip.  Ie interval=2
plots every second week
Methods inherited from RRuleLocator:
__call__(self)
autoscale(self)
Set the view limits to include the data range
Methods inherited from DateLocator:
datalim_to_dt(self)
set_tzinfo(self, tz)
viewlim_to_dt(self)
Data and other attributes inherited from DateLocator:
hms0d = {'byhour': 0, 'byminute': 0, 'bysecond': 0}
Methods inherited from matplotlib.ticker.Locator:
nonsingular(self, vmin, vmax)
pan(self, numsteps)
Pan numticks (can be positive or negative)
refresh(self)
refresh internal information based on current lim
zoom(self, direction)
Zoom in/out on axis; if direction is >0 zoom in, else zoom out
Methods inherited from matplotlib.ticker.TickHelper:
set_data_interval(self, interval)
set_view_interval(self, interval)
verify_intervals(self)
Data and other attributes inherited from matplotlib.ticker.TickHelper:
dataInterval = None
viewInterval = None

 
class YearLocator(DateLocator)
    Make ticks on a given day of each year that is a multiple of base.
 
Examples:
# Tick every year on Jan 1st
locator = YearLocator()
 
# Tick every 5 years on July 4th
locator = YearLocator(5, month=7, day=4)
 
 
Method resolution order:
YearLocator
DateLocator
matplotlib.ticker.Locator
matplotlib.ticker.TickHelper
Methods defined here:
__call__(self)
__init__(self, base=1, month=1, day=1, tz=None)
mark years that are multiple of base on a given month and day
(default jan 1)
autoscale(self)
Set the view limits to include the data range
Methods inherited from DateLocator:
datalim_to_dt(self)
set_tzinfo(self, tz)
viewlim_to_dt(self)
Data and other attributes inherited from DateLocator:
hms0d = {'byhour': 0, 'byminute': 0, 'bysecond': 0}
Methods inherited from matplotlib.ticker.Locator:
nonsingular(self, vmin, vmax)
pan(self, numsteps)
Pan numticks (can be positive or negative)
refresh(self)
refresh internal information based on current lim
zoom(self, direction)
Zoom in/out on axis; if direction is >0 zoom in, else zoom out
Methods inherited from matplotlib.ticker.TickHelper:
set_data_interval(self, interval)
set_view_interval(self, interval)
verify_intervals(self)
Data and other attributes inherited from matplotlib.ticker.TickHelper:
dataInterval = None
viewInterval = None

 
class rrulewrapper
     Methods defined here:
__getattr__(self, name)
__init__(self, freq, **kwargs)
set(self, **kwargs)

 
Functions
       
arange(...)
arange(start, stop=None, step=1, typecode=None)
 
 Just like range() except it returns an array whose type can be
specified by the keyword argument typecode.
date2num(d)
d is either a datetime instance or a sequence of datetimes
 
return value is a floating point number (or sequence of floats)
which gives number of days (fraction part represents hours,
minutes, seconds) since 0001-01-01 00:00:00 UTC
drange(dstart, dend, delta)
Return a date range as float gregorian ordinals.  dstart and dend
are datetime instances.  delta is a datetime.timedelta instance
epoch2num(e)
convert an epoch or sequence of epochs to the new date format,
days since 0001
mx2num(mxdates)
Convert mx datetime instance (or sequence of mx instances) to the
new date format,
num2date(x, tz=None)
x is a float value which gives number of days (fraction part
represents hours, minutes, seconds) since 0001-01-01 00:00:00 UTC
 
Return value is a datetime instance in timezone tz (default to
rcparams TZ value)
 
if x is a sequence, a sequence of datetimes will be returned
num2epoch(d)
convert days since 0001 to epoch.  d can be a number or sequence

 
Data
        DAILY = 3
FR = FR
FRIDAY = FR
HOURLY = 4
HOURS_PER_DAY = 24.0
MINUTELY = 5
MINUTES_PER_DAY = 1440.0
MO = MO
MONDAY = MO
MONTHLY = 1
MUSECONDS_PER_DAY = 86400000000.0
SA = SA
SATURDAY = SA
SECONDLY = 6
SECONDS_PER_DAY = 86400.0
SEC_PER_DAY = 86400
SEC_PER_HOUR = 3600
SEC_PER_MIN = 60
SEC_PER_WEEK = 604800
SU = SU
SUNDAY = SU
TH = TH
THURSDAY = TH
TU = TU
TUESDAY = TU
UTC = <StaticTzInfo 'UTC'>
WE = WE
WEDNESDAY = WE
WEEKDAYS = (MO, TU, WE, TH, FR, SA, SU)
WEEKLY = 2
YEARLY = 0
__all__ = ('date2num', 'num2date', 'drange', 'epoch2num', 'num2epoch', 'mx2num', 'DateFormatter', 'IndexDateFormatter', 'DateLocator', 'RRuleLocator', 'YearLocator', 'MonthLocator', 'WeekdayLocator', 'DayLocator', 'HourLocator', 'MinuteLocator', 'SecondLocator', 'rrule', 'MO', 'TU', ...)
@footer@