Diff of /doc/api/preprocessing.rst [000000] .. [7f9fb8]

Switch to unified view

a b/doc/api/preprocessing.rst
1
2
Preprocessing
3
=============
4
5
Projections:
6
7
.. currentmodule:: mne
8
9
.. autosummary::
10
   :toctree: ../generated/
11
   :template: autosummary/class_no_inherited_members.rst
12
13
   Projection
14
15
.. autosummary::
16
   :toctree: ../generated/
17
18
   compute_proj_epochs
19
   compute_proj_evoked
20
   compute_proj_raw
21
   read_proj
22
   write_proj
23
24
:py:mod:`mne.channels`:
25
26
.. currentmodule:: mne.channels
27
28
.. automodule:: mne.channels
29
   :no-members:
30
   :no-inherited-members:
31
32
.. autosummary::
33
   :toctree: ../generated/
34
35
   Layout
36
   DigMontage
37
   compute_native_head_t
38
   fix_mag_coil_types
39
   read_polhemus_fastscan
40
   get_builtin_montages
41
   make_dig_montage
42
   read_dig_polhemus_isotrak
43
   read_dig_captrak
44
   read_dig_dat
45
   read_dig_egi
46
   read_dig_fif
47
   read_dig_hpts
48
   read_dig_localite
49
   make_standard_montage
50
   read_custom_montage
51
   transform_to_head
52
   compute_dev_head_t
53
   read_layout
54
   find_layout
55
   make_eeg_layout
56
   make_grid_layout
57
   find_ch_adjacency
58
   get_builtin_ch_adjacencies
59
   read_ch_adjacency
60
   equalize_channels
61
   unify_bad_channels
62
   rename_channels
63
   generate_2d_layout
64
   make_1020_channel_selections
65
   combine_channels
66
67
:py:mod:`mne.preprocessing`:
68
69
.. currentmodule:: mne.preprocessing
70
71
.. automodule:: mne.preprocessing
72
   :no-members:
73
   :no-inherited-members:
74
75
.. autosummary::
76
   :toctree: ../generated/
77
78
   ICA
79
   Xdawn
80
   EOGRegression
81
   annotate_amplitude
82
   annotate_break
83
   annotate_movement
84
   annotate_muscle_zscore
85
   annotate_nan
86
   compute_average_dev_head_t
87
   compute_current_source_density
88
   compute_bridged_electrodes
89
   compute_fine_calibration
90
   compute_maxwell_basis
91
   compute_proj_ecg
92
   compute_proj_eog
93
   compute_proj_hfc
94
   cortical_signal_suppression
95
   create_ecg_epochs
96
   create_eog_epochs
97
   find_bad_channels_lof
98
   find_bad_channels_maxwell
99
   find_ecg_events
100
   find_eog_events
101
   fix_stim_artifact
102
   ica_find_ecg_events
103
   ica_find_eog_events
104
   infomax
105
   interpolate_bridged_electrodes
106
   equalize_bads
107
   maxwell_filter
108
   maxwell_filter_prepare_emptyroom
109
   oversampled_temporal_projection
110
   peak_finder
111
   read_ica
112
   read_eog_regression
113
   realign_raw
114
   regress_artifact
115
   corrmap
116
   read_ica_eeglab
117
   read_fine_calibration
118
   write_fine_calibration
119
   apply_pca_obs
120
121
:py:mod:`mne.preprocessing.nirs`:
122
123
.. currentmodule:: mne.preprocessing.nirs
124
125
.. automodule:: mne.preprocessing.nirs
126
   :no-members:
127
   :no-inherited-members:
128
129
.. autosummary::
130
   :toctree: ../generated/
131
132
   optical_density
133
   beer_lambert_law
134
   source_detector_distances
135
   short_channels
136
   scalp_coupling_index
137
   temporal_derivative_distribution_repair
138
139
:py:mod:`mne.preprocessing.ieeg`:
140
141
.. currentmodule:: mne.preprocessing.ieeg
142
143
.. automodule:: mne.preprocessing.ieeg
144
   :no-members:
145
   :no-inherited-members:
146
147
.. autosummary::
148
   :toctree: ../generated/
149
150
   project_sensors_onto_brain
151
   make_montage_volume
152
   warp_montage
153
154
:py:mod:`mne.preprocessing.eyetracking`:
155
156
.. currentmodule:: mne.preprocessing.eyetracking
157
158
.. automodule:: mne.preprocessing.eyetracking
159
   :no-members:
160
   :no-inherited-members:
161
162
.. autosummary::
163
   :toctree: ../generated/
164
165
   Calibration
166
   read_eyelink_calibration
167
   set_channel_types_eyetrack
168
   convert_units
169
   get_screen_visual_angle
170
   interpolate_blinks
171
172
EEG referencing:
173
174
.. currentmodule:: mne
175
176
.. autosummary::
177
   :toctree: ../generated/
178
179
   add_reference_channels
180
   set_bipolar_reference
181
   set_eeg_reference
182
183
:py:mod:`mne.filter`:
184
185
.. currentmodule:: mne.filter
186
187
.. automodule:: mne.filter
188
   :no-members:
189
   :no-inherited-members:
190
191
.. autosummary::
192
   :toctree: ../generated/
193
194
   construct_iir_filter
195
   create_filter
196
   estimate_ringing_samples
197
   filter_data
198
   notch_filter
199
   resample
200
201
:py:mod:`mne.chpi`
202
203
.. currentmodule:: mne.chpi
204
205
.. automodule:: mne.chpi
206
   :no-members:
207
   :no-inherited-members:
208
209
.. autosummary::
210
   :toctree: ../generated/
211
212
   compute_chpi_amplitudes
213
   compute_chpi_snr
214
   compute_chpi_locs
215
   compute_head_pos
216
   extract_chpi_locs_ctf
217
   extract_chpi_locs_kit
218
   filter_chpi
219
   get_active_chpi
220
   get_chpi_info
221
   head_pos_to_trans_rot_t
222
   read_head_pos
223
   write_head_pos
224
225
:py:mod:`mne.transforms`
226
227
.. currentmodule:: mne.transforms
228
229
.. automodule:: mne.transforms
230
   :no-members:
231
   :no-inherited-members:
232
233
.. autosummary::
234
   :toctree: ../generated/
235
236
   Transform
237
   quat_to_rot
238
   rot_to_quat
239
   read_ras_mni_t