skalalab / cell-analysis-tools

Collection of tools used for pre-processing, processing and post processing
GNU General Public License v3.0
2 stars 0 forks source link

Merging em_dev back to main #3

Closed emmanuel-contreras closed 3 years ago

emmanuel-contreras commented 3 years ago

Main changes:

emmanuel-contreras commented 3 years ago

for the regionprops, I think it makes sense to have them in their own function so that their documentation can be displayed alongside each other in sphinx, putting them in a single function with a switch statement would put them in a black box and in a single function. Having them as their own functions would also allow combining the ones you need into a single "regionprops" for specific need mitochondria vs cells vs organoids Screenshot 2021-10-04 095922 x.

Prehani commented 3 years ago

For the regionprops, if it makes documentation easier, that makes sense as is then.

I think my major hesitation with this comes from the fact that now we need to update our implementation whenever scikit image updates theirs right? Like if features change/imports change, then it falls on us to update our wrapper of the function? I'd lean toward just referencing their documentation directly instead of replicating the functions and documentation on our end: https://scikit-image.org/docs/dev/api/skimage.measure.html#skimage.measure.regionprops Here's an example of how BTrack does a similar-ish thing with their properties parameter: https://github.com/quantumjot/BayesianTracker/blob/ac397675a425bf4abe6d9c09fd65f80072bf4950/btrack/_localization.py#L105
I'm not super pressed for one way or the other, but this is just what I've seen others do