Skip to content

Commit

Permalink
two more updates
Browse files Browse the repository at this point in the history
  • Loading branch information
zm711 authored Aug 9, 2023
1 parent dadfdf1 commit ad76247
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/generate_recordings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ When drifting templates are generated (:ref:`drift-templates`), drifting recordi
:code:`drifting` is set to :code:`True`. The :code:`preferred_dir` parameter indicates the 3D vector with the
preferred direction of drift ([0,0,1], default, is upwards in the z-direction) and the :code:`angle_tol` (default is 15
degrees) corresponds to the tolerance in this direction.
There are *three* types of :code:`drift_mode`: slow or fast.
There are two types of :code:`drift_mode`: slow or fast.
The different modalities vary in terms of how the drifting template is selected for each spike during the modulated convolution.

For slow drift, a new position is calculated moving from the initial position along the drifting direction with
Expand Down Expand Up @@ -341,7 +341,7 @@ Recordings can also be generated using a Python script, or a jupyter notebook.
recgen = mr.gen_recordings(params=None, templates=None, tempgen=None, n_jobs=None, verbose=False)
The :code:`params` argument can be the path to a yaml file or a dictionary containing the parameters (if :code:`None`` default
The :code:`params` argument can be the path to a yaml file or a dictionary containing the parameters (if :code:`None` default
parameters are used). One of the :code:`templates` or :code:`tempgen` parameters must be indicated, the
former pointing to a generated templates file, the latter instead is a :code:`TemplateGenerator` object.
The :code:`n_jobs` argument indicates how many jobs will be used in parallel (for parallel processing, more than 1 chunk
Expand Down Expand Up @@ -388,4 +388,4 @@ The :code:`RecordingGenerator` class contains several fields:
import MEArec as mr
mr.save_recording_generator(recgen, filename=None)
where :code:`recgen` is a :code:`RecordingGenerator` object and :code:`filename` is the output file name.
where :code:`recgen` is a :code:`RecordingGenerator` object and :code:`filename` is the output file name.

0 comments on commit ad76247

Please sign in to comment.