Add colorbar and an option to plot the velocities to plot_traj()#800
Open
T0T0R wants to merge 1 commit into
Open
Add colorbar and an option to plot the velocities to plot_traj()#800T0T0R wants to merge 1 commit into
T0T0R wants to merge 1 commit into
Conversation
nkeim
reviewed
Jun 15, 2026
nkeim
left a comment
Contributor
There was a problem hiding this comment.
Thanks for this pull request! In the interest of keeping trackpy's API simple and memorable, I wonder if the colorbar_units argument is really necessary. It should be possible to choose the units automatically based on whether mpp or fps (or both) are given, which is currently the behavior for the position axes. This also avoids the ambiguity of the half-real units µm/frame and px/s.
Also, the current master branch fixes the automated checks which would be helpful for testing. If you're comfortable with rebasing this PR, please do so; no worries if not.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
A color bar can now be added when plotting the trajectories, which is helpful with

colorby='frame'. The title of this colorbar can be selected between "Frame number" or "Time (s)".Example with
tp.plot_traj(t, mpp=1.0, fps=24, colorby='frame', cmap='cividis', colorbar_units='frames', superimpose=background):Example with

tp.plot_traj(t, mpp=1.0, fps=24, colorby='frame', cmap='cividis', colorbar_units='real', superimpose=background):Another feature is added,

colorby='velocity'allowing to color the trajectories by the speed of the objects. The title of the color bar can be selected between "Speed (px/s)" or "Speed (µm/s)".Example with
tp.plot_traj(t, mpp=1.0, fps=24, colorby='velocity', cmap='inferno', colorbar_units='frames', superimpose=background);:Example with

tp.plot_traj(t, mpp=1.0, fps=24, colorby='velocity', cmap='inferno', colorbar_units='real', superimpose=background);: