pandas.DatetimeIndex.floor — pandas 3.0.0.dev0+2100.gf496acffcc documentation (original) (raw)

DatetimeIndex.floor(freq, ambiguous='raise', nonexistent='raise')[source]#

Perform floor operation on the data to the specified freq.

Parameters:

freqstr or Offset

The frequency level to floor the index to. Must be a fixed frequency like ‘s’ (second) not ‘ME’ (month end). Seefrequency aliases for a list of possible freq values.

ambiguous‘infer’, bool-ndarray, ‘NaT’, default ‘raise’

Only relevant for DatetimeIndex:

‘infer’ will attempt to infer fall dst-transition hours based on order
bool-ndarray where True signifies a DST time, False designates a non-DST time (note that this flag is only applicable for ambiguous times)
‘NaT’ will return NaT where there are ambiguous times
‘raise’ will raise a ValueError if there are ambiguous times.

nonexistent‘shift_forward’, ‘shift_backward’, ‘NaT’, timedelta, default ‘raise’

A nonexistent time does not exist in a particular timezone where clocks moved forward due to DST.

‘shift_forward’ will shift the nonexistent time forward to the closest existing time
‘shift_backward’ will shift the nonexistent time backward to the closest existing time
‘NaT’ will return NaT where there are nonexistent times
timedelta objects will shift nonexistent times by the timedelta
‘raise’ will raise a ValueError if there are nonexistent times.

Returns:

DatetimeIndex, TimedeltaIndex, or Series

Index of the same type for a DatetimeIndex or TimedeltaIndex, or a Series with the same index for a Series.

Raises:

ValueError if the freq cannot be converted.