cut_series_after_max

trashpanda.cut_series_after_max(series_to_cut: pandas.core.series.Series) → pandas.core.series.Series

Cuts a Series after its maximum value.

Warning

This method is being replaced by :func:trashpanda.cut_after_max in the next release.

Parameters

series_to_cut (Series) – Source frame to be cut at the cutting index.

Returns

Series

Examples

>>> from pandas import Series, Index
>>> import numpy as np
>>> from doctestprinter import doctest_print
>>> from trashpanda import cut_series_after_max
>>> sample_data = np.sin(np.arange(0.0, np.pi, np.pi/4.0))
>>> sample_series = Series(
...     data=sample_data,
...     name="a",
...     index=Index(numpy.arange(0.0, 0.4, 0.1), name="x")
... )
>>> doctest_print(sample_series)
x
0.0    0.000000
0.1    0.707107
0.2    1.000000
0.3    0.707107
Name: a, dtype: float64
>>> cut_sample = cut_series_after_max(sample_series)
>>> doctest_print(cut_sample)
x
0.0    0.000000
0.1    0.707107
0.2    1.000000
Name: a, dtype: float64
>>> doctest_print(cut_series_after_max(cut_sample))
x
0.0    0.000000
0.1    0.707107
0.2    1.000000
Name: a, dtype: float64