Python | Pandas TimedeltaIndex.floor

Pandas is a popular data manipulation library for Python. It offers powerful functions and tools for analyzing, manipulating, and transforming data. TimedeltaIndex is an important data type in Pandas that allows you to work with time series data efficiently. In this article, we will discuss the TimedeltaIndex.floor() function.

Description

The TimedeltaIndex.floor() function is used to round down each element in the TimedeltaIndex to the nearest specified frequency. The frequency can be specified as a string or a Timedelta object. The resulting index will have the same size and dtype as the original index.

Syntax

TimedeltaIndex.floor(freq, how=None, normalize=False, **kwargs)

Parameters

• freq: A string or a Timedelta object representing the frequency to round down to.
• how: Determines the reference point for rounding. It can be one of the following values:
  • start (default): Round down to the closest multiple of the frequency that is less than or equal to the element.
  • end: Round down to the closest multiple of the frequency that is strictly less than the element.
• normalize: If set to True, normalize the resulting index into a regular period index.
• **kwargs: Additional keyword arguments to be passed to the underlying numpy.floor_divide() function.

Return Value

The TimedeltaIndex.floor() function returns a new TimedeltaIndex with the rounded values.

Example

import pandas as pd

# Create a TimedeltaIndex
tdi = pd.timedelta_range('1 day', periods=5)

# Round down to the nearest 12 hours
tdi_floor = tdi.floor('12H')

print(tdi_floor)

Output:

TimedeltaIndex(['0 days 00:00:00', '0 days 00:00:00', '0 days 12:00:00',
                '0 days 12:00:00', '0 days 12:00:00'],
               dtype='timedelta64[ns]', freq=None)

In the above example, we created a TimedeltaIndex with a frequency of 1 day and length 5. We then called the TimedeltaIndex.floor() function with a frequency of 12 hours. This rounded each element down to the nearest 12 hours, resulting in a new TimedeltaIndex of the same length.

Conclusion

The TimedeltaIndex.floor() function is a useful tool for working with time series data in Pandas. It allows you to round down each element in the index to the nearest specified frequency. This can be particularly useful for grouping and aggregating data by periods of time.