Python API Reference

Reading actigraphy data

Raw file reader

Uniform API to read multiple actigraphy data formats. Currently, the supported formats are:

  • wGT3X-BT, Actigraph (.agd file format only);

  • Actiwatch 4, 7, L(-Plus) and MotionWatch 8, CamNtech (.awd and .mtn);

  • ActTrust 2, Condor Instruments (.txt);

  • Daqtometer, Daqtix (.csv);

  • Actiwatch 2 and Actiwatch Spectrum Plus, Philips Respironics (.csv)

  • Tempatilumi (CE Brasil)

  • MESA dataset file format

  • Biobankaccelerometer file format (BBA)

Associated functions:

read_raw_agd(input_fname[, start_time, period])

Reader function for raw AWD file.

read_raw_atr(input_fname[, mode, ...])

Reader function for .txt file recorded by ActTrust (Condor Instruments)

read_raw_awd(input_fname[, header_size, ...])

Reader function for raw AWD file.

read_raw_bba(input_fname[, name, uuid, ...])

Reader function for files produced by the biobankAccelerometerAnalysis package.

read_raw_dqt(input_fname[, name, ...])

Raw object from .csv file recorded by Daqtometers (Daqtix, Germany)

read_raw_mesa(input_fname[, time_origin, ...])

Reader function for MESA files

read_raw_mtn(input_fname[, start_time, ...])

Reader function for raw MTN file.

read_raw_rpx(input_fname[, language, ...])

Reader function for raw Respironics file.

read_raw_tal(input_fname[, name, sep, ...])

Raw object from .txt file recorded by Tempatilumi (CE Brasil)

These functions return a BaseRaw object. which is the main class in pyActigraphy: pyActigraphy.io.BaseRaw

Batch reader

Reading actigraphy files by batch:

read_raw(input_path, reader_type[, n_jobs, ...])

Reader function for multiple raw files.

This function return a RawReader object: pyActigraphy.io.RawReader

Spurious activity masking

Log files

Rest-Activity Rhythms

Rest and Activity reports

Rest-activity scoring and sleep diary

Light-specific modules

Analysis