royerlab / ultrack

Cell tracking and segmentation software
https://royerlab.github.io/ultrack
BSD 3-Clause "New" or "Revised" License
64 stars 7 forks source link

Improve documentation for "detection" (and other frequently used terms) #81

Closed tischi closed 1 month ago

tischi commented 4 months ago

It would be nice to add some documentation to frequently used terms to the documentation.

For instance, the word detection is not entirely clear to me. Is that always a boolean type array with True being the foreground pixels? If so, maybe even consider renaming this variable to foreground?

Maybe then also writing a bit about how the edges or boundaries should look like could be helpful.