Module quantum_inferno.utilities.date_time

Collection of functions to convert between time bases

Functions

def convert_time_unit(input_time: Union[numpy.ndarray, float], input_unit: str, output_unit: str) ‑> Union[numpy.ndarray, float]

Convert time data from a given time unit to another time unit.

:param input_time: time data to convert :param input_unit: time unit of the input data :param output_unit: time unit to convert the input data to :return: converted time data

def get_datetime_from_timestamp_to_utc(timestamp: float, utc_offset_h: float, input_unit: str = 's') ‑> datetime.datetime

Convert a timestamp to a UTC datetime object using the UTC offset.

:param timestamp: timestamp to convert into UTC time :param utc_offset_h: UTC offset of the timestamp in hours :param input_unit: time units (default: seconds) :return: converted UTC datetime object

def set_datetime_to_utc(datetime_obj: datetime.datetime, tzinfo_warning: bool = False) ‑> datetime.datetime

Convert a datetime object to a UTC datetime object. If the input datetime object is not timezone-aware, it is assumed to be in UTC.

:param datetime_obj: datetime object to convert :param tzinfo_warning: flag to raise a warning if the input datetime object is not timezone-aware :return: converted UTC datetime object

def set_timestamp_to_utc(timestamp: float, utc_offset_h: float, input_unit: str = 's') ‑> float

Convert a timestamp to be in UTC using the UTC offset.

:param timestamp: timestamp to convert :param utc_offset_h: UTC offset of the timestamp in hours :param input_unit: time unit of the timestamp (default: seconds) :return: converted timestamp in UTC while keeping the same unit

def utc_datetime_to_utc_timestamp(datetime_obj: datetime.datetime, output_unit: str = 's') ‑> float

Convert a UTC datetime object to a UTC timestamp. If datetime_object is not timezone aware, it will be assumed to be in UTC. If datetime_object is timezone aware, it will be converted to UTC.

:param datetime_obj: UTC datetime object to convert :param output_unit: time unit to convert the UTC timestamp to (default: seconds) :return: converted UTC timestamp

def utc_timestamp_to_utc_datetime(timestamp: float, input_unit: str = 's') ‑> datetime.datetime

Convert a UTC timestamp to a UTC datetime object. Note: timestamp is assumed to be in UTC.

:param timestamp: UTC timestamp to convert :param input_unit: time unit of the UTC timestamp (default: seconds) :return: converted UTC datetime object