pandas.TimedeltaIndex.floor

TimedeltaIndex.floor(*args, **kwargs)[source]

Выполнить операцию округления вниз данных до указанной частоты freq.

Параметры:

freq:str или смещение

Уровень частоты, до которого необходимо округлить индекс вниз. Должна быть фиксированная частота, например, ‘S’ (секунда), а не ‘ME’ (конец месяца). Список возможных значений freq см. в псевдонимах частот.

ambiguous:‘infer’, булевый массив, ‘NaT’, по умолчанию ‘raise’

Актуально только для DatetimeIndex:

• ‘infer’ попытается определить часы перехода DST по порядку

• булевый массив, где True означает время DST, False — время вне DST (обратите внимание, что этот флаг применим только для неоднозначных моментов времени)

• ‘NaT’ вернет NaT, если имеются неоднозначные моменты времени

• ‘raise’ вызовет AmbiguousTimeError, если имеются неоднозначные моменты времени.

nonexistent:‘shift_forward’, ‘shift_backward’, ‘NaT’, timedelta, по умолчанию ‘raise’

Временной момент не существует в определённой часовой зоне, когда часы перевели вперёд из-за DST.

• ‘shift_forward’ переместит момент времени вперёд к ближайшему существующему

• ‘shift_backward’ переместит момент времени назад к ближайшему существующему

• ‘NaT’ вернёт NaT, если имеются моменты, не существующие в часовой зоне

• объекты timedelta сместят несуществующие моменты времени на timedelta

• ‘raise’ вызовет NonExistentTimeError, если имеются моменты, не существующие в часовой зоне.

Возвращает:

DatetimeIndex, TimedeltaIndex или Series

Индекс того же типа для DatetimeIndex или TimedeltaIndex, или Series с тем же индексом для Series.

Возбуждает:

ValueError, если freq нельзя преобразовать.

Примечания

Если временные метки имеют часовой пояс, округление вниз происходит относительно местного времени («стенные» часы) и повторно локализуется в ту же часовую зону. При округлении вблизи перехода на летнее/зимнее время используйте nonexistent и ambiguous, чтобы управлять поведением повторной локализации.

Примеры

DatetimeIndex

>>> rng = pd.date_range('1/1/2018 11:59:00', periods=3, freq='min')
>>> rng
DatetimeIndex(['2018-01-01 11:59:00', '2018-01-01 12:00:00',
               '2018-01-01 12:01:00'],
              dtype='datetime64[ns]', freq='min')
>>> rng.floor('h')
DatetimeIndex(['2018-01-01 11:00:00', '2018-01-01 12:00:00',
               '2018-01-01 12:00:00'],
              dtype='datetime64[ns]', freq=None)

Series

>>> pd.Series(rng).dt.floor("h")
0   2018-01-01 11:00:00
1   2018-01-01 12:00:00
2   2018-01-01 12:00:00
dtype: datetime64[ns]

При округление вблизи перехода на летнее/зимнее время используйте ambiguous или nonexistent, чтобы управлять тем, как должна быть повторно локализована временная метка.

>>> rng_tz = pd.DatetimeIndex(["2021-10-31 03:30:00"], tz="Europe/Amsterdam")

>>> rng_tz.floor("2h", ambiguous=False)
DatetimeIndex(['2021-10-31 02:00:00+01:00'],
             dtype='datetime64[ns, Europe/Amsterdam]', freq=None)

>>> rng_tz.floor("2h", ambiguous=True)
DatetimeIndex(['2021-10-31 02:00:00+02:00'],
              dtype='datetime64[ns, Europe/Amsterdam]', freq=None)