Skip to content

Create Stub for Visual Behavior Definitions #1661

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pickles-bread-and-butter merged 1 commit into from
Jul 16, 2020
Merged

Create Stub for Visual Behavior Definitions #1661

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions doc_template/visual_behavior_terms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
=====================
Visual Behavior Terms
=====================
This document is meant to serve as a reference to a Visual Behavior scientist
or external user who wants to have knowledge of Visual Behavior specific terms.
This document means to aide in research by providing definitions that can then
be used correctly in research.


BehaviorOphysClass (session)
============================
Attributes and methods associated with a single ophys experiment. An interface
to all of the data for a single experimental session from the Visual Behavior
pipeline, aligned to a common time clock.

===================== ============ ========================================================================
Attribute/Method Name Return dtype Description
===================== ============ ========================================================================
average_projection image 2D image of the microscope field of view, averaged across the experiment
===================== ============ ========================================================================

Experiments Table
-----------------
+--------------------------------------+---------------------------------------------+
| experiments_tables | Table/Pandas Dataframe |
+======================================+=============================================+
| A dataframe describing available experiment sessions and associated data |
+----------------------+-------------------------+-----------------------------------+
| Column Name | Data Type | Description |
+----------------------+-------------------------+-----------------------------------+
| ophys_experiment_id | int64 | Unique id for an Ophys Experiment |
+----------------------+-------------------------+-----------------------------------+