meegpype.interfaces.mne.preprocessing.headposition module🔗

class meegpype.interfaces.mne.preprocessing.headposition.ComputeHeadPos(from_file=None, resource_monitor=None, ignore_exception=False, **inputs)🔗

Bases: BaseInterface

Mandatory Inputs:

raw (a pathlike object or string representing an existing file or a pathlike object or string representing an existing directory) – The input raw file.

Optional Inputs:

  • calibration (a pathlike object or string representing an existing file or None) – The calibration associated to the raw file. (no used).

  • crosstalk (a pathlike object or string representing an existing file or None) – The crosstalk associated to the raw file. (no used).

  • emptyroom (a pathlike object or string representing an existing file or a pathlike object or string representing an existing directory or None) – The emptyroom associated to the raw file. (no used).

  • overwrite (a boolean) – Overwrite existing files.

  • rotation_velocity_limit (a float) – Head rotation velocity limit in degrees per second.

  • translation_velocity_limit (a float) – Head translation velocity limit in meters per second.

  • verbose (a boolean) – Enable verbose mode (printing of log messages).

Outputs:

  • calibration (a pathlike object or string representing an existing file or None) – The calibration associated to the raw file.

  • crosstalk (a pathlike object or string representing an existing file or None) – The crosstalk associated to the raw file.

  • emptyroom (a pathlike object or string representing an existing file or None) – The emptyroom associated to the raw file.

  • head_positions (a pathlike object or string representing an existing file) – File containing the head postions in txt format.

  • raw (a pathlike object or string representing an existing file) – The raw file.

  • splits (a list of items which are a pathlike object or string representing an existing file)