Add support for new args from cellfinder #150
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
What is this PR
Why is this PR needed?
Cellfinder recently got / is in the process of getting new args. This adds support for those, including updating the docs to match those from cellfinder.
Also, cellfinder was called using positional args instead of keyword args, making adding new args to cellfinder harder. This switches to only use keyword args.
What does this PR do?
detection_batch_sizeandclassification_batch_size, instead of the singularbatch_size. And marked the latter as deprecated. Python 3.13+ has an actualdeprecatedarg we can use, but we can't use it yet. Ifbatch_sizeis provided, it still setsclassification_batch_sizelike before.References
It's WIP until these PRs with potential new parameters are resolved: brainglobe/cellfinder#542, brainglobe/cellfinder#545, and brainglobe/cellfinder#546.
Also, it requires brainglobe/brainglobe-utils#128.
How has this PR been tested?
I tested it with data locally.
Is this a breaking change?
It only breaks things in the sense that it will require the latest version of
cellfinderandbrainglobe-utils. Because older versions won't support these function calls. We probably should set the min versions in the dependencies.Does this PR require an update to the documentation?
No.
Checklist: