feat: add basic trajectory metrics#943
Open
goktugsina wants to merge 2 commits intoneuroinformatics-unit:mainfrom
Open
feat: add basic trajectory metrics#943goktugsina wants to merge 2 commits intoneuroinformatics-unit:mainfrom
goktugsina wants to merge 2 commits intoneuroinformatics-unit:mainfrom
Conversation
|
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
1 participant
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?
Currently, the kinematics module provides several metrics such as distances and kinetic energy, but it lacks basic trajectory-level summary metrics. Adding trajectory length and trajectory variance helps users quickly quantify motion patterns and provides a simple foundation for further analysis.
What does this PR do?
Adds a new module: trajectory_metrics.py
Implements:
trajectory_length: computes total path length of a trajectory
trajectory_variance: computes overall spatial variance of the trajectory
Exposes the new functions in kinematics/init.py
Adds a unit test for trajectory_length
References
No related issues found. This is an initial contribution to extend trajectory analysis capabilities.
How has this PR been tested?
Added a unit test (test_trajectory_length) to verify correctness
Tested locally by running the test suite
Verified that existing functionality remains unchanged (no modifications to existing logic)
Is this a breaking change?
No. This PR only adds new functionality and does not modify any existing behavior.
Does this PR require an update to the documentation?
No major documentation changes are required, as this is a small additive feature. However, documentation can be extended in the future to include examples of trajectory metrics usage.
Checklist: