Skip to content
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.

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

Add imaging_preprocess module #83

Merged
merged 25 commits into from
Aug 11, 2022
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
ac9096c
Create copy of `imaging` module
kabilar May 18, 2022
1cb5460
Add pre-processing tables
kabilar May 18, 2022
0f1b03c
Add `imaging_preprocess` diagram
kabilar Jun 14, 2022
1cee6c8
Add `imaging` module descriptions to README
kabilar Jun 14, 2022
5c40afd
Update to mirror `element-array-ephys`
kabilar Jun 14, 2022
bf7fe6f
Add black code formatting
kabilar Jul 1, 2022
1176fa3
Update to simplify queries
kabilar Jul 1, 2022
f4a1a81
Update attribute to mirror `ephys_precluster`
kabilar Jul 1, 2022
e5ee93e
Update version and changelog
kabilar Jul 1, 2022
9326e8b
Process data based on preprocessed files
kabilar Jul 1, 2022
26c5934
Fix typo
kabilar Jul 27, 2022
2eaa263
Update comments and simplify code
kabilar Aug 4, 2022
94a3eae
Update element_calcium_imaging/imaging_preprocess.py
kabilar Aug 4, 2022
8f26aa2
Update `PreProcess` to `Preprocess`
kabilar Aug 4, 2022
17ec56f
Merge branch 'main' of https://github.com/kabilar/element-calcium-ima…
kabilar Aug 4, 2022
9afa9ae
Update `dj.schema` to `dj.Schema`
kabilar Aug 4, 2022
781a804
Update join statements
kabilar Aug 4, 2022
0791f8c
Apply code review suggestions
kabilar Aug 8, 2022
1e91a69
Update method name
kabilar Aug 9, 2022
d32429d
Update fetch calls
kabilar Aug 9, 2022
b5d177e
Remove extra `join`
kabilar Aug 9, 2022
438c996
Update element_calcium_imaging/imaging_preprocess.py
kabilar Aug 11, 2022
8adff5e
Fix bug
kabilar Aug 11, 2022
efe12e5
Add list comprehension
kabilar Aug 11, 2022
6cf9ff7
Add list comprehension
kabilar Aug 11, 2022
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) convention.

## [0.2.0] - 2022-07-01

+ Add - Imaging module (imaging_preprocess.py) for pre-processing steps

## [0.1.0] - 2022-06-29

+ Add - Support for element-interface
Expand All @@ -28,6 +32,7 @@ Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and
+ Add - `scan` and `imaging` modules
+ Add - Readers for `ScanImage`, `ScanBox`, `Suite2p`, `CaImAn`

[0.2.0]: https://github.com/datajoint/element-calcium-imaging/releases/tag/0.2.0
[0.1.0]: https://github.com/datajoint/element-calcium-imaging/releases/tag/0.1.0
[0.1.0b0]: https://github.com/datajoint/element-calcium-imaging/releases/tag/0.1.0b0
[0.1.0a4]: https://github.com/datajoint/element-calcium-imaging/releases/tag/0.1.0a4
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,31 @@ a fully functional calcium imaging workflow.

## Element architecture

![element-calcium-imaging diagram](images/attached_calcium_imaging_element.svg)
`element-calcium-imaging` is comprised of two schemas, `scan` and `imaging`. To handle
several use cases of this pipeline, we have designed several `imaging` schemas,
including `imaging`, `imaging_no_curation`, and `imaging_preprocess`.

+ `imaging` - Multiple scans are acquired during each session and each scan is processed
independently.

+ `imaging_preprocess` - Multiple scans are acquired during each session and each scan
is processed independently. And pre-processing steps can be
performed on each scan prior to processing with Suite2p or
CaImAn.

### `imaging` module

![imaging diagram](images/attached_calcium_imaging_element.svg)

### `imaging_preprocess` module

![imaging-preprocess diagram](images/attached_calcium_imaging_element_preprocess.svg)

+ As the diagram depicts, the imaging element starts immediately downstream from `Session`, and also requires some notion of:

+ `Scanner` for equipment/device
+ `Scanner` for equipment/device

+ `Location` as a dependency for `ScanLocation`
+ `Location` as a dependency for `ScanLocation`

## Table definitions

Expand Down
Loading