soft-matter / trackpy

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

ChannelPredict flow_axis #689

Closed gui-miotto closed 1 year ago

gui-miotto commented 2 years ago

I was playing around with ChannelPredict and I noticed something weird: it accepts any value for flow_axis. Here is a bit of my code (a modified walkthrough):

features = tp.batch(
    frames=dataset,
    diameter=11,
)

pred = tp.predict.ChannelPredict(
    bin_size=1.,
    flow_axis="foo",  # ?
)

tracks_0 = pred.link_df(
    features,
    search_range=10,
    memory=1,
    )

I was expecting this crash due to an invalid value for flow_axis, but it doesn't. It just do business as usual. So, my questions are:

  1. Is there something wrong with my code?
  2. If not, is this the intended behavior (to not raise an exception)?
  3. What are the actual valid values for flow_axis? Can I use something like "-y"?
nkeim commented 1 year ago

This should be fixed by #710.