Previous topic

scikits.timeseries.convert

Next topic

Dates manipulation

This Page

scikits.timeseries.extras.convert_to_annual

convert_to_annual(series)

Group a series by years, taking leap years into account.

The output has as many rows as distinct years in the original series, and as many columns as the length of a leap year in the units corresponding to the original frequency (366 for daily frequency, 366*24 for hourly...). The fist column of the output corresponds to Jan. 1st, 00:00:00, while the last column corresponds to Dec, 31st, 23:59:59. Entries corresponding to Feb. 29th are masked for non-leap years.

For example, if the initial series has a daily frequency, the 59th column of the output always corresponds to Feb. 28th, the 61st column to Mar. 1st, and the 60th column is masked for non-leap years. With a hourly initial frequency, the (59*24)th column of the output always correspond to Feb. 28th 23:00, the (61*24)th column to Mar. 1st, 00:00, and the 24 columns between (59*24) and (61*24) are masked.

If the original frequency is less than daily, the output is equivalent to series.convert('A', func=None).

Parameters:

series : TimeSeries

A valid TimeSeries object.

Returns:

aseries : TimeSeries

A 2D TimeSeries object with annual (‘A’) frequency.