question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[DOC] Improve tutorials for generating `-trans.fif`

See original GitHub issue

In the process of setting up a source-space-analysis, it took me a really long time to realize all the steps necessary to create a -trans.fif. As I am new to these type of analyses, it could be just me not knowing the terminology and what to look for, but I think there could be a more intuitive description of the procedure here.

Specifically, I needed several readings of the tutorials and attempts in implementing to figure out these things:

  • if I haven’t created a -trans.fifmyself or use an existing data set for which someone else has created that file, I will have to run mne coreg (i.e. the phrasing in the tutorials implies that normally this file is present, and only in the exceptional case that it is not, I need to take actions. So, it looked for it in different places, and tried to find out how I could extract it)
  • getting the head shapes/surfaces with BEM or with make_scalp_surfaces is a prerequisite for running mne coreg
  • to obtain the trans.fif I first need to complete other analysis steps (i.e. FS segmentation, BEM)

Proposed documentation enhancement

I don’t know what would make the most sense. Relevant doc regarding the trans.fif file can be found in these two tutorials:

The procedure to run mne coreg is currently buried quite deep in the Source alignment tutorial, which is primarily about understanding all the relevant coordinate systems. Perhaps it would make sense to split the tutorial in two? Or add the part Defining the head↔MRI trans using the GUI to “The typical M/EEG workflow” when talking about the trans.fif file?

Also, the figure in the “The typical M/EEG workflow” tutorial is misleading in that it implies getting the MRI-head trans does not depend on any other analysis step before. That is not true as you need Freesurfer to run its segmentation and to set up a BEM model (afaik, at least). So, I think the figure should be adapted to reflect that, and maybe some textual changes in the tutorial could clarify the dependencies. Figure 1

Issue Analytics

  • State:open
  • Created 2 years ago
  • Reactions:3
  • Comments:8 (8 by maintainers)

github_iconTop GitHub Comments

1reaction
vagechirkovcommented, Mar 30, 2021

Regarding the -trans.fif file generation this tutorial from NiBabel was very useful to me.

0reactions
larsonercommented, Oct 22, 2021

Bumping the milestone on this one, but if someone is motivated to fix/update the docs in the next week or so it could still make it into 0.24

Read more comments on GitHub >

github_iconTop Results From Across the Web

Import digitization from text file and align with individual MRI
to align the fiducials using the file with the Raw object, and save the -trans.fif file. The plot above was generated with the...
Read more >
Python Tutorial - MEEP Documentation - Read the Docs
Python Tutorial. We will review several examples using the Python interface that demonstrate the process of computing fields, transmittance/reflectance ...
Read more >
Biopython Tutorial and Cookbook
Basically, we just like to program in Python and want to make it as easy as possible to use Python for bioinformatics by...
Read more >
Basic Graphics Programming With The XCB Library - X.Org
Creating and destroying a mouse cursor; Setting a window's mouse cursor; Complete example. Translation of basic Xlib functions and macros.
Read more >
Spresense SDK Examples & Tutorials - Developer World - Sony
When build succeeded, nuttx.spk binary file will be generated under sdk ... Pointing the camera at a person's face will increase the "person...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found