pyActigraphy.io.read_raw_atr¶
- pyActigraphy.io.read_raw_atr(input_fname, mode='PIM', start_time=None, period=None)[source]¶
Reader function for .txt file recorded by ActTrust (Condor Instruments)
- Parameters
input_fname (str) – Path to the ActTrust file.
mode (str, optional) – Activity sampling mode. Available modes are: Proportional Integral Mode (PIM), Time Above Threshold (TAT) and Zero Crossing Mode (ZCM). Default is PIM.
start_time (datetime-like, optional) – Read data from this time. Default is None.
period (str, optional) – Length of the read data. Cf. #timeseries-offset-aliases in <https://pandas.pydata.org/pandas-docs/stable/timeseries.html>. Default is None (i.e all the data).
- Returns
raw – An object containing raw ATR data
- Return type
Instance of RawATR