Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Compute neighbor distance #392

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Compute neighbor distance #392

wants to merge 2 commits into from
+570 −33

Conversation

schroedtert
Copy link
Collaborator

Closes #246

@schroedtert schroedtert force-pushed the neighbors-distance branch 2 times, most recently from 2082fe9 to 5dfdd1a Compare December 8, 2024 12:05
schroedtert

This comment was marked as outdated.

# to view

@schroedtert schroedtert marked this pull request as ready for review February 22, 2025 16:50
schroedtert
schroedtert commented Feb 22, 2025
View reviewed changes
pedpy/methods/method_utils.py Outdated
Comment on lines 293 to 294
as_list (bool): Return the neighbors as a list per pedestrian and frame,
if true, otherwise each neighbor is in a single row.
Copy link
Collaborator Author

@schroedtert schroedtert Feb 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a warning in the API description and the user guide notebook that discourages usage of the function with the default value. Do we additionally want to emit a deprecation warning if it is set to True?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After thinking about: I also added a deprecation warning, this way everybody gets informed when using the function, without any need to read a up-to-date documentation. This way more user will update their scripts (hopefully).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this explicit solution better.

@schroedtert schroedtert requested a review from chraibi February 22, 2025 16:55
@schroedtert schroedtert force-pushed the neighbors-distance branch 3 times, most recently from 6f86a73 to 3c8bbaa Compare February 23, 2025 09:12
@schroedtert
Add additional dataframe return for neighbor computation
bc13f97 
Also add the (preferable) option to give the neighbors not as a list,
but as rows. This way they can later better be used in other
computations.
@schroedtert
Add function to compute distances between neighbors
43c290b
chraibi
chraibi reviewed Feb 25, 2025
View reviewed changes
Copy link
Collaborator

@chraibi chraibi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me. Need to check functionality.

@codecov Codecov
Copy link

codecov bot commented Feb 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.69%. Comparing base (0e5e402) to head (43c290b).
Report is 1 commits behind head on main.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@chraibi chraibi chraibi left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Compute distance to neighbors
2 participants
@schroedtert @chraibi