neuroinformatics-unit / movement

Python tools for analysing body movements across space and time
http://movement.neuroinformatics.dev
BSD 3-Clause "New" or "Revised" License
77 stars 7 forks source link

Consider adding a distance and speed property to accessor #147

Open sfmig opened 3 months ago

sfmig commented 3 months ago

From the kinematics tutorial PR review:

We could add a "distance" property in our accessor to access directly the distance travelled, e.g:

distance_travelled = ds.move.distance

Similarly with speed.

sfmig commented 3 months ago

Make a method instead of a property. Nomenclature: ds.get_cumulative_distance() ?

niksirbi commented 3 months ago

Maybe ds.cumulative_displacement(from=0, to=100)? Because we will literally calculate it as cumsum of the displacement.

niksirbi commented 2 months ago

See exhaustive discussion in #162

sfmig commented 1 month ago

@niksirbi @lochhh seems like we can close this now?

lochhh commented 1 month ago

or edit this to add more convenience methods to the accessor, e.g. compute_speed, compute_distance_travelled as suggested here?

niksirbi commented 1 month ago

Yeah, i'd keep it open, because we may consider adding those convenience methods.