Skip to content

Commit

Permalink
Doc 1104 stimulus (#1140)
Browse files Browse the repository at this point in the history
* updated stimulus parameters answer

* punctuation
  • Loading branch information
saskiad authored Nov 4, 2024
1 parent 3c2c99d commit bb33e44
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions docs/source/session.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,11 @@ the Stimulus Class, but the trial-by-trial stimulus information belongs in the N

Great question! We began defining specific classes for different stimulus and behavior modalities, but quickly found
that this won't be scalable. You can currently use these classes if they work for you. However, in the long run we
would like this to move into the `script` field. This field uses the Software class, which has a field for stimulus
parameters, where users can define their own dictionary of parameters used in the script to control the stimulus/
behavior. We recommend that you use software to define these and be consistent within your projects. Please reach out
with questions and we can help you with this.
would like this to move into the `script` field. This field uses the Software class, which has a field for
`parameters`. Users should use this to document the parameters used to control the stimulus or behavior. parameters
should have unambiguous names (e.g. "trial_duration" rather than "duration") and units must be provided as a separate
field (e.g. "trial_duration_unit"). We recommend that you use software to define these and be consistent within your
projects. Please reach out with questions and we can help you with this.

**Q: What should I put for the `session_type`?**

Expand All @@ -77,8 +78,8 @@ and SLIMS. Until this is fully functional, these files must be created manually.
**Q: How do I know if my mouse platform is "active"?**

There are experiments in which the mouse platform is actively controlled by the stimulus/behavior software - i.e. the
resistance of the wheel is adjusted based on the subjects activity. This is an "active" mouse platform. Most platforms
we use are not active in this way.
resistance of the wheel is adjusted based on the subject's activity. This is an "active" mouse platform. Most platforms
we use are currently not active in this way.

**Q: How do I use the Calibration field?**

Expand Down

0 comments on commit bb33e44

Please sign in to comment.