mne.channels.read_dig_hpts

mne.channels.read_dig_hpts(fname, unit='mm')[source]

Read historical .hpts mne-c files.

Parameters
fnamestr

The filepath of .hpts file.

unit‘m’ | ‘cm’ | ‘mm’

Unit of the positions. Defaults to ‘mm’.

Returns
montageinstance of DigMontage

The montage.

Notes

The hpts format digitzer data file may contain comment lines starting with the pound sign (#) and data lines of the form:

<*category*> <*identifier*> <*x/mm*> <*y/mm*> <*z/mm*>

where:

<*category*>

defines the type of points. Allowed categories are: hpi, cardinal (fiducial), eeg, and extra corresponding to head-position indicator coil locations, cardinal landmarks, EEG electrode locations, and additional head surface points, respectively.

<*identifier*>

identifies the point. The identifiers are usually sequential numbers. For cardinal landmarks, 1 = left auricular point, 2 = nasion, and 3 = right auricular point. For EEG electrodes, identifier = 0 signifies the reference electrode.

<*x/mm*> , <*y/mm*> , <*z/mm*>

Location of the point, usually in the head coordinate system in millimeters. If your points are in [m] then unit parameter can be changed.

For example:

cardinal    2    -5.6729  -12.3873  -30.3671
cardinal    1    -37.6782  -10.4957   91.5228
cardinal    3    -131.3127    9.3976  -22.2363
hpi    1    -30.4493  -11.8450   83.3601
hpi    2    -122.5353    9.2232  -28.6828
hpi    3    -6.8518  -47.0697  -37.0829
hpi    4    7.3744  -50.6297  -12.1376
hpi    5    -33.4264  -43.7352  -57.7756
eeg    FP1  3.8676  -77.0439  -13.0212
eeg    FP2  -31.9297  -70.6852  -57.4881
eeg    F7  -6.1042  -68.2969   45.4939
...

Examples using mne.channels.read_dig_hpts