aeon.io.api#

aeon.io.api.aeon(seconds)[source]#: Converts a Harp timestamp, in seconds, to a datetime object.

aeon.io.api.chunk(time)[source]#

Returns the whole hour acquisition chunk for a measurement timestamp.

Parameters:: time (datetime or Series) – An object or series specifying the measurement timestamps.
Returns:: A datetime object or series specifying the acquisition chunk for the measurement timestamp.

aeon.io.api.chunk_key(file)[source]#: Returns the acquisition chunk key for the specified file name.

aeon.io.api.chunk_range(start, end)[source]#

Returns a range of whole hour acquisition chunks.

Parameters:

start (datetime) – The left bound of the time range.
end (datetime) – The right bound of the time range.

Returns:

A DatetimeIndex representing the acquisition chunk range.

aeon.io.api.load(root, reader, start=None, end=None, time=None, tolerance=None, epoch=None, **kwargs)[source]#

Extracts chunk data from the root path of an Aeon dataset.

Reads all chunk data using the specified data stream reader. A subset of the data can be loaded by specifying an optional time range, or a list of timestamps used to index the data on file. Returned data will be sorted chronologically.

Parameters:

root (str or PathLike) – The root path, or prioritised sequence of paths, where data is stored.
reader (Reader) – A data stream reader object used to read chunk data from the dataset.
start (datetime, optional) – The left bound of the time range to extract.
end (datetime, optional) – The right bound of the time range to extract.
time (datetime, optional) – An object or series specifying the timestamps to extract.
tolerance (datetime, optional)

The maximum distance between original and new timestamps for inexact matches. :param str, optional epoch: A wildcard pattern to use when searching epoch data. :param optional kwargs: Optional keyword arguments to forward to the reader when reading chunk data. :return: A pandas data frame containing epoch event metadata, sorted by time.