mne-tools / fiff-constants

Bookkeeping and documentation of FIFF file format constants
4 stars 12 forks source link

FIFF definitions #1

Closed jaeilepp closed 8 years ago

jaeilepp commented 8 years ago

Here are the updated dictionaries. I just added the tag ids to the next available ones.

I didn't include the following:

#
# Additional coordinate frames
#
FIFF.FIFFV_MNE_COORD_TUFTS_EEG   =  300         # For Tufts EEG data
FIFF.FIFFV_MNE_COORD_CTF_DEVICE  = 1001         # CTF device coordinates
FIFF.FIFFV_MNE_COORD_CTF_HEAD    = 1004         # CTF head coordinates
FIFF.FIFFV_MNE_COORD_DIGITIZER   = FIFF.FIFFV_COORD_ISOTRAK # Original (Polhemus) digitizer coordinates
FIFF.FIFFV_MNE_COORD_SURFACE_RAS = FIFF.FIFFV_COORD_MRI     # The surface RAS coordinates
FIFF.FIFFV_MNE_COORD_MRI_VOXEL   = 2001         # The MRI voxel coordinates
FIFF.FIFFV_MNE_COORD_RAS         = 2002         # Surface RAS coordinates with non-zero origin
FIFF.FIFFV_MNE_COORD_MNI_TAL     = 2003         # MNI Talairach coordinates
FIFF.FIFFV_MNE_COORD_FS_TAL_GTZ  = 2004         # FreeSurfer Talairach coordinates (MNI z > 0)
FIFF.FIFFV_MNE_COORD_FS_TAL_LTZ  = 2005         # FreeSurfer Talairach coordinates (MNI z < 0)
FIFF.FIFFV_MNE_COORD_FS_TAL      = 2006         # FreeSurfer Talairach coordinates
#
# 4D and KIT use the same head coordinate system definition as CTF
#
FIFF.FIFFV_MNE_COORD_4D_HEAD     = FIFF.FIFFV_MNE_COORD_CTF_HEAD
FIFF.FIFFV_MNE_COORD_KIT_HEAD    = FIFF.FIFFV_MNE_COORD_CTF_HEAD
#

because I didn't know what they refer to and they're not used anywhere in the code AFAIK.

Ping @agramfort @Eric89GXL

agramfort commented 8 years ago

I would have put in 2 different commits the initial values and the updates. it's better for readability

jaeilepp commented 8 years ago

Just noticed that epochs bookkeeping tags were outside the reserved range. We should probably change that too.

jaeilepp commented 8 years ago

To the first commit I only added the tags that were not conflicting with anything. The second commit includes the changes to existing tags.

jaeilepp commented 8 years ago

I don't know if there is a way to upload text files to github, so I uploaded a gist of the diff compared to the original dictionaries. https://gist.github.com/jaeilepp/e7b8f85e0a6c26754ee7

Edit: seems like the comparison is reversed, but you get the point.

agramfort commented 8 years ago

what I suggested is to have as first commit the initial file. Then update it and commit so the 2nd commit in the history shows the diff of our changes. ok?

agramfort commented 8 years ago

done.

the diff is available in 55fd3c642710a49bfaa7b3a437fa105cb6fcc920