pyActigraphy.io.read_raw_rpx

pyActigraphy.io.read_raw_rpx(input_fname, language='ENG_US', dayfirst=None, start_time=None, period=None, data_dtype='float', light_dtype='float', delimiter=',', decimal='.', drop_na=True)[source]

Reader function for raw Respironics file.

Parameters

  • input_fname (str) – Path to the rpx file.

  • language (str, optional) – Language of the input csv file. Available options are: ‘ENG_UK’, ‘ENG_US’, ‘FR’, ‘GER’. Default is ‘ENG_US’.

  • dayfirst (bool, optional) – Whether to interpret the first value of a date as the day. If None, rely on the laguage: * ENG_US: False * ENG_UK or FR or GER: True Default is None.

  • 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).

  • data_dtype (dtype, optional) – The dtype of the raw data. Default is ‘float’.

  • light_dtype (dtype, optional) – The dtype of the raw light data. Default is ‘float’.

  • delimiter (str, optional) – Delimiter to use when reading the input file. Default is ‘,’

  • decimal (str, optional) – Decimal character to use when reading the input file. Default is ‘.’

  • drop_na (bool, optional) – If set to True, drop epochs where activity is NaN. Default is True.

Returns

raw – An object containing raw RPX data

Return type

Instance of RawRPX