Back to the main page.

Bug 1767 - Improve the documentation on filtering

Reported 2012-10-04 10:26:00 +0200
Modified 2013-04-17 12:16:48 +0200
Product: FieldTrip
Component: preproc
Version: unspecified
Hardware: Other
Operating System: All
Importance: P3 enhancement
Assigned to: Roemer van der Meij
Depends on:
See also:

Robert Oostenveld - 2012-10-04 10:26:30 +0200

Given the nice EDA meeting on this topic, i suggest we update some of the wiki material. Important pages and other pages with the tag "filter". Should we move the example to faq? We should extend the documentation to all filters, also bandstop. Where should we document which ft fucntions have ilt options? Which ones have cfg.preproc? I know of datbrowser, timelockanalysis, the artifact detection functions...

Roemer van der Meij - 2012-10-04 12:39:14 +0200

Good idea. Extending the FAQs seems logical, but considering the average depth and specificity of the FAQs, maybe it would make more sense to do it as example script. But at the same time, describing filters is more of an answer to a question than an example... However, there are so many gems in the example script section, that maybe it's a good idea to think of reframing it? It feels we are underselling many of the things in there. Let's discuss in the meeting? Regardless, looking at the other 'example scripts', it would make more sense to do an elaborate one on filtering in that section.

Roemer van der Meij - 2013-04-17 12:10:50 +0200

This kind of ended on the forgotten list. As it happens to be, I'm writing a short entry on filtering together with JM in a new online Springer Encyclopedia thing (JM was invited and kindly co-invited me ;)). It should end up about 600-1800 words, and be largely based on what I outlined in the EDA meeting. Submission deadline is in June. When there is a final version there, I propose I will make a FAQ on filtering, referring very often to the above piece, and talk about how it's implemented in FieldTrip.