catalystneuro / roiextractors

Python-based module for extracting from, converting between, and handling optical imaging data from several file formats. Inspired by SpikeInterface.
https://roiextractors.readthedocs.io/en/latest/index.html
BSD 3-Clause "New" or "Revised" License
11 stars 7 forks source link

Discuss introducing a new trace for background activity in SegmentationExtractor #375

Open alessandratrapani opened 3 days ago

alessandratrapani commented 3 days ago

What would you like to see added to ROI Extractors?

I would like to introduce two separate traces with their respective spatial components:

  1. _roi_response_neuropilwith the respective _neuropil_images_masks. This can be used to store the actual neuropil signals that sometimes refer to the area surrounding the ROIs.
  2. _roi_response_backgroundwith the respective _background_images_masks. This can be used more generally to store the signal in the field of view that excludes the areas in the identified ROIs.

Right now we define the following: https://github.com/catalystneuro/roiextractors/blob/a6873d2ca0388356b9263e664f0b2ca2a6857b82/src/roiextractors/segmentationextractor.py#L34-L47

Maybe I would also add one for baseline (_roi_response_baseline) activity which spatial components are in common with the _roi_response_raw, _roi_response_denoised, _roi_response_deconvolvedetc..

And _image_maximum_projection to store the maximum projection image that is also a very common summary image for segmentation algos.

@pauladkisson, @h-mayorquin, @weiglszonja @ehennestad what do you think?

Do you have any interest in helping implement the feature?

Yes.

Code of Conduct

pauladkisson commented 3 days ago

This is exactly the sort of API improvement that should be a part of roiextractors 0.6.0.

Just need to figure out how to make it work with our funding situation...