Skip to content

Commit

Permalink
Add documentation for the widget
Browse files Browse the repository at this point in the history
  • Loading branch information
kushalbakshi committed Apr 9, 2024
1 parent 7662b57 commit 594587b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/src/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ the common motifs to create Element Calcium Imaging. Major features include:
- [ ] Deepinterpolation
- [x] Data export to NWB
- [x] Data publishing to DANDI
- [x] Widgets for manual ROI mask creation and curation for cell segmentation of Fluorescent voltage sensitive indicators, neurotransmitter imaging, and neuromodulator imaging
- [ ] Expand creation widget to provide pixel weights for each mask based on Fluorescence intensity traces at each pixel

Further development of this Element is community driven. Upon user requests and based on
guidance from the Scientific Steering Group we will continue adding features to this
Expand Down
5 changes: 5 additions & 0 deletions docs/src/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,8 @@ please set `processing_method="extract"` in the
ProcessingParamSet table, and provide the `params` attribute of the ProcessingParamSet
table in the `{'suite2p': {...}, 'extract': {...}}` dictionary format. Please also
install the [MATLAB engine](https://pypi.org/project/matlabengine/) API for Python.

## Manual ROI Mask Creation and Curation

+ Manual creation of ROI masks for fluorescence activity extraction is supported by the `draw_rois.py` plotly/dash widget. This widget allows the user to draw new ROI masks and submit them to the database. The widget can be launched in a Jupyter notebook after following the [installation instructions](#installation-instructions-for-active-projects) and importing `draw_rois` from the module.
+ ROI masks can be curated using the `widget.py` jupyter widget that allows the user to mark each regions as either a `cell` or `non-cell`. This widget can be launched in a Jupyter notebook after following the [installation instructions](#installation-instructions-for-active-projects) and importing `main` from the module.

0 comments on commit 594587b

Please sign in to comment.