Move preprocessing

bin/mne_clean_eog_ecg.py

@@ -56,7 +56,7 @@ def clean_ecg_eog(in_fif_fname, out_fif_fname=None, eog=True, ecg=True,
     print 'Implementing ECG and EOG artifact rejection on data'
 
     if ecg:
-        ecg_events, _, _  = mne.artifacts.find_ecg_events(raw_in)
+        ecg_events, _, _  = mne.preprocessing.find_ecg_events(raw_in)
         print "Writing ECG events in %s" % ecg_event_fname
         mne.write_events(ecg_event_fname, ecg_events)
 
@@ -73,7 +73,7 @@ def clean_ecg_eog(in_fif_fname, out_fif_fname=None, eog=True, ecg=True,
             print "Error while running : %s" % command
 
     if eog:
-        eog_events = mne.artifacts.find_eog_events(raw_in)
+        eog_events = mne.preprocessing.find_eog_events(raw_in)
         print "Writing EOG events in %s" % eog_event_fname
         mne.write_events(eog_event_fname, eog_events)
 

doc/source/python_reference.rst

@@ -22,7 +22,7 @@ Classes reference
    mne.SourceEstimate
    mne.Label
    mne.BiHemiLabel
-   mne.artifacts.ICA
+   mne.preprocessing.ICA
 
 Functions reference
 ===================
@@ -181,16 +181,18 @@ Functions reference
    plot_topo_image_epochs
    mne_analyze_colormap
 
-.. automodule:: mne.artifacts
+.. automodule:: mne.preprocessing
  :no-members:
  :no-inherited-members:
 
-.. currentmodule:: mne.artifacts
+.. currentmodule:: mne.preprocessing
 
 .. autosummary::
    :toctree: generated/
    :template: function.rst
 
+   compute_proj_ecg
+   compute_proj_eog
    find_eog_events
    find_ecg_events
    ica_find_eog_events

doc/source/whats_new.rst

@@ -73,6 +73,8 @@ API
 
    - Use raw.time_as_index instead of time_to_index (still works but is deprecated).
 
+   - The artifacts module (mne.artifacts) is now merged into mne.preprocessing
+
 .. _changes_0_4:
 
 Version 0.4

mne/artifacts/__init__.py

@@ -1,6 +1,11 @@
 """Artifacts finding/correction related functions
 """
 
-from .eog import find_eog_events
-from .ecg import find_ecg_events
-from .ica import ICA, ica_find_eog_events, ica_find_ecg_events, score_funcs
+from ..utils import deprecated
+from ..preprocessing import find_eog_events, find_ecg_events
+
+_preprocessing = ('The artifacts module will no longer be supported in v0.6.'
+                  ' Please use the preprocessing module instead.')
+
+find_eog_events = deprecated(_preprocessing)(find_eog_events)
+find_ecg_events = deprecated(_preprocessing)(find_ecg_events)