search

soft-matter / trackpy

Python particle tracking toolkit
http://soft-matter.github.io/trackpy
Other
443 stars 131 forks source link

seems that `image` is not an input to tp.locate #679

Open alexlib opened 3 years ago

alexlib commented 3 years ago

https://github.com/soft-matter/trackpy/blob/3b280ea9ccbf25dd2e3f07512398071a882ef0c1/trackpy/feature.py#L222

the docstring says there are two inputs: raw_image and image - maybe I'm wrong, but there's only one input raw_image

MaartenBransen commented 1 year ago

This still seems to be an issue in v0.6.0, image is a documented parameter but not actually an argument to locate. Looking at the code there is both a raw_image and an image variable, where the latter is given that name after pre-processing. Perhaps the intended behaviour was at some point that this allowed for a custom pre-processing pipeline instead of the default preprocess option?

nkeim commented 1 year ago

Thanks for bringing this up. Yes, without reviewing those old PRs, there are a few functions that implement portions of the locate pipeline, and I believe they were added to simplify locate for the most common all-in-one use case. In this spirit I propose removing image from the docstring of locate in the next release.