pandas.TimedeltaIndex — pandas 0.24.0rc1 documentation (original) (raw)
class pandas. TimedeltaIndex[source]¶
Immutable ndarray of timedelta64 data, represented internally as int64, and which can be boxed to timedelta objects
| Parameters: | data : array-like (1-dimensional), optional Optional timedelta-like data to construct index with unit : unit of the arg (D,h,m,s,ms,us,ns) denote the unit, optional which is an integer/float number freq : string or pandas offset object, optional One of pandas date offset strings or corresponding objects. The string ‘infer’ can be passed in order to set the frequency of the index as the inferred frequency upon creation copy : bool Make a copy of input ndarray start : starting value, timedelta-like, optional If data is None, start is used as the start point in generating regular timedelta data. Deprecated since version 0.24.0. periods : int, optional, > 0 Number of periods to generate, if generating index. Takes precedence over end argument Deprecated since version 0.24.0. end : end time, timedelta-like, optional If periods is none, generated index will extend to first conforming time on or just past end argument Deprecated since version 0.24.: 0 closed : string or None, default None Make the interval closed with respect to the given frequency to the ‘left’, ‘right’, or both sides (None) Deprecated since version 0.24.: 0 name : object Name to be stored in the index |
|---|
Notes
To learn more about the frequency strings, please see this link.
Creating a TimedeltaIndex based on start, periods, and end has been deprecated in favor of timedelta_range().
Attributes
| days | Number of days for each element. |
|---|---|
| seconds | Number of seconds (>= 0 and less than 1 day) for each element. |
| microseconds | Number of microseconds (>= 0 and less than 1 second) for each element. |
| nanoseconds | Number of nanoseconds (>= 0 and less than 1 microsecond) for each element. |
| components | Return a dataframe of the components (days, hours, minutes, seconds, milliseconds, microseconds, nanoseconds) of the Timedeltas. |
| inferred_freq | Tryies to return a string representing a frequency guess, generated by infer_freq. |
Methods
| to_pytimedelta(*args, **kwargs) | Return Timedelta Array/Index as object ndarray of datetime.timedelta objects. |
|---|---|
| to_series([index, name]) | Create a Series with both index and values equal to the index keys useful with map for returning an indexer based on an index. |
| round(freq[, ambiguous, nonexistent]) | Perform round operation on the data to the specified freq. |
| floor(freq[, ambiguous, nonexistent]) | Perform floor operation on the data to the specified freq. |
| ceil(freq[, ambiguous, nonexistent]) | Perform ceil operation on the data to the specified freq. |
| to_frame([index, name]) | Create a DataFrame with a column containing the Index. |