biopsykit.utils.time module

Module containing helper functions to handle time data.

biopsykit.utils.time.check_tz_aware(data)

Check whether dataframe index is timezone-aware.

Parameters

data (DataFrame) – dataframe with index to check

Returns

True if index of dataframe is a DatetimeIndex and index is timezone-aware, False otherwise

Return type

bool

biopsykit.utils.time.extract_time_from_filename(file_path, filename_pattern, date_pattern=None)

Extract time information from filename.

Parameters

• file_path (Path or str) – filename

• filename_pattern (str) – regex string indicating how to extract time information from filename

• date_pattern (str, optional) – date format pattern or None to use default date format pattern (“%Y%m%d_%H_%M_%S”). Default: None

Returns

extracted date information

Return type

datetime.datetime

biopsykit.utils.time.get_time_from_date(data, is_utc=False, tz_convert=False, timezone=None)

Extract time information from series with date information.

Some functions expect only time information (hour, minute, second, …) without date information (year, month, day). This function can be used to extract only the relevant time information from the complete datetime data.

Parameters

• data (Series) – series with date information

• is_utc (bool, optional) – True if datetime is in UTC, False otherwise. Default: False

• tz_convert (bool, optional) – True to convert datetime into correct timezone before extracting time information or False to localize datetime. Default: False

• timezone (str or datetime.tzinfo) – timezone the datetime objects are in or should be converted to. Default: None, which defaults to time zone “Europe/Berlin”

Returns

pandas series with time information extracted from datetime

Return type

Series

biopsykit.utils.time.time_to_timedelta(data)

Convert time information in a series into datetime.timedelta data.

Parameters

data (Series) – series with time information

Returns

series with data converted into datetime.timedelta

Return type

Series

biopsykit.utils.time.timedelta_to_time(data)

Convert datetime.timedelta data in a series datetime.time data.

Parameters

data (Series) – series with data as datetime.timedelta

Returns

series with data converted into datetime.time

Return type

Series

biopsykit.utils.legacy_helper module biopsykit.example_data module