diff --git a/doc_template/visual_behavior_terms.rst b/doc_template/visual_behavior_terms.rst new file mode 100644 index 000000000..9288d7c7c --- /dev/null +++ b/doc_template/visual_behavior_terms.rst @@ -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 | ++----------------------+-------------------------+-----------------------------------+