Skip to content

Commit b427c7e

Browse files
committed
Inserted table into concepts.md
1 parent c873231 commit b427c7e

1 file changed

Lines changed: 37 additions & 40 deletions

File tree

docs/src/concepts.md

Lines changed: 37 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -30,46 +30,6 @@ The preprocessing workflow for miniscope imaging includes denoising, motion corr
3030

3131
Based on interviews with UCLA and Inscopix miniscope users and developers, each research lab uses a different preprocessing workflow. These custom workflows are often closed source and not tracked with version control software. For the preprocessing tools that are open source, they are often developed by an individual during their training period and lack funding for long term maintenance. These factors result in a lack of standardization for miniscope preprocessing tools, which is a major obstacle to adoption for new labs.
3232

33-
## Table Architecture
34-
35-
Each of the DataJoint Elements are a set of tables for common neuroinformatics modalities to organize, preprocess, and analyze data. Each node in the following diagram is either a table in the Element itself or a table that would be connected to the Element.
36-
37-
![element-miniscope diagram](https://raw.githubusercontent.com/datajoint/element-miniscope/main/images/attached_miniscope_element.svg)
38-
39-
- Upstream:
40-
41-
- Element Miniscope connects to a ***Session*** table, which is modeled in our [workflow pipeline](https://github.com/datajoint/workflow-miniscope/blob/main/workflow_deeplabcut/pipeline.py).
42-
43-
- Although not requried, most choose to connect ***Session*** to a ***Subject*** table for managing research subjects.
44-
45-
- `miniscope` schema: Tables related to importing, analyzing, and exporting miniscope data:
46-
47-
+ ***Session***: An experimental session where each recording describes a complete 3D dataset from one recording session.
48-
49-
+ ***Recording***: A table containing information about the equipment used (e.g. the acquisition hardware information).
50-
51-
+ ***RecordingInfo***: The metadata about this recording from the Miniscope DAQ software (e.g. frame rate, number of channels, frames, etc.).
52-
53-
+ ***MotionCorrection***: Information about motion correction performed on a recording.
54-
55-
+ ***MotionCorrection.RigidMotionCorrection***: Details of the rigid motion correction (e.g. shifting in x, y).
56-
57-
+ ***MotionCorrection.NonRigidMotionCorrection*** and ***MotionCorrection.Block***: These tables are used to describe the non-rigid motion correction.
58-
59-
+ ***MotionCorrection.Summary***: Ssummary images after motion correction (e.g. average image, correlation image, etc.).
60-
61-
+ ***Segmentation***: This table specifies the segmentation step and its outputs, following the motion correction step.
62-
63-
+ ***Segmentation.Mask***: This table contains the image mask for the segmented region of interest.
64-
65-
+ ***MaskClassification***: This table contains informmation about the classification of ***Segmentation.Mask*** into a type (e.g. soma, axon, dendrite, artifact, etc.).
66-
67-
+ ***Fluorescence***: The output fluorescence traces extracted from each ***Segmentation.Mask***.
68-
69-
+ ***ActivityExtractionMethod***: A record of the activity extraction method (e.g. deconvolution) applied on the fluorescence trace.
70-
71-
+ ***Activity***: The computed neuronal activity trace from fluorescence trace (e.g. spikes).
72-
7333
## Key Partnerships
7434

7535
Until recently, DataJoint had not been used for miniscope pipelines. However, labs we have contacted have been eager to engage and adopt DataJoint-based workflows in their labs.
@@ -83,6 +43,43 @@ Until recently, DataJoint had not been used for miniscope pipelines. However, la
8343
+ Manolis Froudaraki Lab, FORTH
8444
+ Allan Basbaum Lab, UCSF
8545

46+
## Element Architecture
47+
48+
Each of the DataJoint Elements are a set of tables for common neuroinformatics modalities to organize, preprocess, and analyze data. Each node in the following diagram is either a table in the Element itself or a table that would be connected to the Element.
49+
50+
![element-miniscope diagram](https://raw.githubusercontent.com/datajoint/element-miniscope/main/images/attached_miniscope_element.svg)
51+
52+
### `subject` schema
53+
- Although not required, most choose to connect the `Session` table to a `Subject` table.
54+
55+
| Table | Description |
56+
| --- | --- |
57+
| Subject | Basic information of the research subject |
58+
59+
### `session` schema
60+
61+
| Table | Description |
62+
| --- | --- |
63+
| Session | Unique experimental session identifier |
64+
65+
### `miniscope` schema
66+
Tables related to importing, analyzing, and exporting miniscope data.
67+
68+
| Table | Description |
69+
| --- | --- |
70+
| Recording | A table containing information about the equipment used (e.g. the acquisition hardware information). |
71+
| RecordingInfo | The metadata about this recording from the Miniscope DAQ software (e.g. frame rate, number of channels, frames, etc.). |
72+
| MotionCorrection | Information about motion correction performed on a recording. |
73+
| MotionCorrection.RigidMotionCorrection | Details of rigid motion correction (e.g. shiting in x, y). |
74+
| MotionCorrection.NonRigidMotionCorrection and MotionCorrection.Block | These tables are used to describe the non-rigid motion correction. |
75+
| MotionCorrection.Summary | Summary images after motion correction (e.g. average image, correlation image, etc.). |
76+
| Segmentation | This table specifies the segmentation step and its outputs, following the motion correction step. |
77+
| Segmentation.Mask | This table contains the image mask for the segmented region of interest. |
78+
| MaskClassification | This table contains informmation about the classification of `Segmentation.Mask` into a type (e.g. soma, axon, dendrite, artifact, etc.). |
79+
| Fluorescence | The output fluorescence traces extracted from each `Segmentation.Mask`. |
80+
| ActivityExtractionMethod | A record of the activity extraction method (e.g. deconvolution) applied on the fluorescence trace. |
81+
| Activity | The computed neuronal activity trace from fluorescence trace (e.g. spikes). |
82+
8683
## Pipeline Development
8784

8885
With assistance from Peyman Golshani’s Lab (UCLA) we have added support for the UCLA Miniscope DAQ V3 acquisition tool and MiniscopeAnalysis preprocessing tool in `element-miniscope` and `workflow-miniscope`. They have provided example data for development, and will begin validating in March 2021.

0 commit comments

Comments
 (0)