Skip to content
Browse files

DOC : update reference + fix some docstrings

  • Loading branch information...
1 parent 792952b commit 1b0ca56c7d94bcc01d6370b3efa57bcbed2dd217 @agramfort committed Aug 5, 2012
View
57 doc/source/python_reference.rst
@@ -32,11 +32,14 @@ Functions reference
read_cov
write_cov
+ compute_covariance
+ compute_raw_data_covariance
label_time_courses
read_label
label_sign_flip
write_label
stc_to_label
+ grow_labels
read_bem_surfaces
read_surface
write_bem_surface
@@ -47,12 +50,18 @@ Functions reference
write_stc
read_w
write_w
+ read_proj
+ write_proj
+ compute_proj_epochs
+ compute_proj_evoked
+ read_selection
fiff.pick_types
fiff.pick_channels
fiff.pick_types_evoked
fiff.pick_channels_regexp
fiff.pick_channels_forward
fiff.pick_types_forward
+ fiff.pick_channels_cov
.. automodule:: mne.minimum_norm
:no-members:
@@ -65,14 +74,40 @@ Functions reference
:template: function.rst
read_inverse_operator
+ write_inverse_operator
+ make_inverse_operator
apply_inverse
apply_inverse_raw
apply_inverse_epochs
- make_inverse_operator
- write_inverse_operator
source_band_induced_power
source_induced_power
+.. automodule:: mne.mixed_norm
+ :no-members:
+ :no-inherited-members:
+
+.. currentmodule:: mne.mixed_norm
+
+.. autosummary::
+ :toctree: generated/
+ :template: function.rst
+
+ mixed_norm
+
+.. automodule:: mne.beamformer
+ :no-members:
+ :no-inherited-members:
+
+.. currentmodule:: mne.beamformer
+
+.. autosummary::
+ :toctree: generated/
+ :template: function.rst
+
+ lcmv
+ lcmv_epochs
+ lcmv_raw
+
.. automodule:: mne.stats
:no-members:
:no-inherited-members:
@@ -115,3 +150,21 @@ Functions reference
induced_power
single_trial_power
compute_raw_psd
+ morlet
+ yule_walker
+ ar_raw
+ iir_filter_raw
+
+.. automodule:: mne.simulation
+ :no-members:
+ :no-inherited-members:
+
+.. currentmodule:: mne.simulation
+
+.. autosummary::
+ :toctree: generated/
+ :template: function.rst
+
+ generate_evoked
+ select_source_in_label
+ generate_sparse_stc
View
2 mne/beamformer/__init__.py
@@ -1,4 +1,4 @@
-"""Artifacts finding/correction related functions
+"""Beamformers for source localization
"""
from ._lcmv import lcmv, lcmv_epochs, lcmv_raw
View
4 mne/cov.py
@@ -470,8 +470,8 @@ def regularize(cov, info, mag=0.1, grad=0.1, eeg=0.1, exclude=None,
proj: bool
Apply or not projections to keep rank of data.
- Return
- ------
+ Returns
+ -------
reg_cov : Covariance
The regularized covariance matrix.
"""
View
14 mne/label.py
@@ -234,17 +234,17 @@ def stc_to_label(stc, src, smooth=5):
def _verts_within_dist(graph, source, max_dist):
"""Find all vertices wihin a maximum geodesic distance from source
- Parameters:
- -----------
+ Parameters
+ ----------
graph : scipy.sparse.csr_matrix
Sparse matrix with distances between adjacent vertices
source : int
Source vertex
max_dist: float
Maximum geodesic distance
- Returns:
- --------
+ Returns
+ -------
verts : array
Vertices within max_dist
dist : array
@@ -292,7 +292,7 @@ def grow_labels(subject, seeds, extents, hemis, subjects_dir=None):
label, or integers, in which case the same extent and hemisphere is
used for each label.
- Parameters:
+ Parameters
----------
subject : string
Name of the subject as in SUBJECTS_DIR
@@ -305,8 +305,8 @@ def grow_labels(subject, seeds, extents, hemis, subjects_dir=None):
subjects_dir : string
Path to SUBJECTS_DIR if not set in the environment
- Returns:
- --------
+ Returns
+ -------
labels : list
List with lables. Each label is a dictionary with keys:
comment Comment with seed vertex and extent
View
4 mne/preprocessing/maxfilter.py
@@ -96,8 +96,8 @@ def apply_maxfilter(in_fname, out_fname, origin=None, frame='device',
Needs Maxfilter license, maxfilter has to be in PATH
- Parameters:
- -----------
+ Parameters
+ ----------
in_fname: string
Input file name
View
8 mne/source_estimate.py
@@ -559,15 +559,15 @@ def mesh_dist(tris, vert):
It generates an adjacency matrix where the entries are the distances
between neighboring vertices.
- Parameters:
- -----------
+ Parameters
+ ----------
tris : array (n_tris x 3)
Mesh triangulation
vert : array (n_vert x 3)
Vertex locations
- Returns:
- --------
+ Returns
+ -------
dist_matrix : scipy.sparse.csr_matrix
Sparse matrix with distances between adjacent vertices
"""
View
4 mne/time_frequency/psd.py
@@ -48,8 +48,8 @@ def compute_raw_psd(raw, tmin=0, tmax=np.inf, picks=None,
proj : bool
Apply SSP projection vectors
- Return
- ------
+ Returns
+ -------
psd: array of float
The PSD for all channels
View
4 mne/transforms.py
@@ -74,8 +74,8 @@ def transform_coordinates(filename, pos, orig, dest):
'mni_tal' is MNI Talairach
'fs_tal' is FreeSurfer Talairach
- Return
- ------
+ Returns
+ -------
trans_pos: array of shape N x 3
The transformed locations

0 comments on commit 1b0ca56

Please sign in to comment.
Something went wrong with that request. Please try again.