Skip to content

Commit 7e72755

Browse files
committed
Update data pipeline page
1 parent 2cc0ae0 commit 7e72755

File tree

1 file changed

+27
-12
lines changed

1 file changed

+27
-12
lines changed

docs/src/pipeline.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -43,18 +43,33 @@ detailed documentation on each table, see the API docs for the respective schema
4343

4444
| Table | Description |
4545
| --- | --- |
46-
| Recording | A table containing information about the equipment used (e.g. the acquisition hardware information). |
47-
| RecordingInfo | The metadata about this recording from the Miniscope DAQ software (e.g. frame rate, number of channels, frames, etc.). |
48-
| MotionCorrection | A table with information about motion correction performed on a recording. |
49-
| MotionCorrection.RigidMotionCorrection | A table with details of rigid motion correction (e.g. shifting in x, y). |
50-
| MotionCorrection.NonRigidMotionCorrection and MotionCorrection.Block | These tables describe the non-rigid motion correction. |
51-
| MotionCorrection.Summary | A table containing summary images after motion correction. |
52-
| Segmentation | This table specifies the segmentation step and its outputs, following the motion correction step. |
53-
| Segmentation.Mask | This table contains the image mask for the segmented region of interest. |
54-
| MaskClassification | This table contains information about the classification of `Segmentation.Mask` into a type (e.g. soma, axon, dendrite, artifact, etc.). |
55-
| Fluorescence | This table contains the fluorescence traces extracted from each `Segmentation.Mask`. |
56-
| ActivityExtractionMethod | A table with information about the activity extraction method (e.g. deconvolution) applied on the fluorescence trace. |
57-
| Activity | A table with neuronal activity traces from fluorescence trace (e.g. spikes). |
46+
| AcquisitionSoftware | Software used for miniscope acquisition |
47+
| Channel | Number of channels in the miniscope recording |
48+
| Recording | Information about the equipment used (e.g. the acquisition hardware information). |
49+
| RecordingLocation | Brain location of the miniscope recording |
50+
| RecordingInfo | Metadata about this recording from the Miniscope DAQ software (e.g. frame rate, number of channels, frames, etc.) |
51+
| RecordingInfo.File | Relative file paths for the recording files |
52+
| ProcessingMethod | Available analysis suites that can be used in processing of the miniscope datasets |
53+
| ProcessingParamSet | All parameters required to process a miniscope dataset |
54+
| MaskType | All possible classifications of a segmented mask |
55+
| ProcessingTask | Task defined by a combination of Recording and ProcessingParamSet |
56+
| Processing | The core table that executes a ProcessingTask |
57+
| Curation | Curated results |
58+
| MotionCorrection | Results of the motion correction procedure |
59+
| MotionCorrection.RigidMotionCorrection | Details of the rigid motion correction performed on the miniscope data |
60+
| MotionCorrection.NonRigidMotionCorrection | Details of nonrigid motion correction performed on the miniscope data |
61+
| MotionCorrection.NonRigidMotionCorrection.Block | Results of non-rigid motion correction for each block |
62+
| MotionCorrection.Summary | Summary images for each field and channel after motion correction |
63+
| Segmentation | Results of the segmentation |
64+
| Segmentation.Mask | Masks identified in the segmentation procedure |
65+
| MaskClassificationMethod | Method used in the mask classification procedure |
66+
| MaskClassification | Result of the mask classification procedure |
67+
| MaskClassification.MaskType | Classification type assigned to each mask (e.g. soma, axon, dendrite, artifact, etc.) |
68+
| Fluorescence | Fluorescence measurements |
69+
| Fluorescence.Trace | Fluorescence trace for each region of interest |
70+
| ActivityExtractionMethod | Method used in activity extraction |
71+
| Activity | Inferred neural activity |
72+
| Activity.Trace | Inferred neural activity for each fluorescence trace |
5873
| ProcessingQualityMetrics | Quality metrics used to evaluate the results of the calcium imaging analysis pipeline |
5974
| ProcessingQualityMetrics.Mask | Quality metrics used to evaluate the masks |
6075
| ProcessingQualityMetrics.Trace | Quality metrics used to evaluate the fluorescence traces |

0 commit comments

Comments
 (0)