Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Update doxygen comments for distance() and interpolate() #2528

Merged
merged 1 commit into from
Feb 23, 2021

Conversation

AndyZe
Copy link
Member

@AndyZe AndyZe commented Feb 22, 2021

Update documentation of interpolate() and distance() to clarify a few things:

  • The t parameter of interpolate isn't a time, it's a fraction
  • distance() just sums the joint difference, for all joints. It's not an L2 norm or SSE or anything like that. Verify here.

Fixes #2527

@AndyZe AndyZe force-pushed the andyz/update_interp_comments branch from 60c7893 to 6ae0dcc Compare February 22, 2021 18:42
Copy link
Member

@tylerjw tylerjw left a comment

Choose a reason for hiding this comment

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

Thank you for doing this! I read through these and they look good. I'll merge this once it passes CI if no one else requests changes.

@codecov
Copy link

codecov bot commented Feb 22, 2021

Codecov Report

Merging #2528 (a62bb4d) into master (41771d0) will decrease coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2528      +/-   ##
==========================================
- Coverage   60.23%   60.22%   -0.00%     
==========================================
  Files         351      351              
  Lines       26470    26470              
==========================================
- Hits        15942    15940       -2     
- Misses      10528    10530       +2     
Impacted Files Coverage Δ
...bot_model/include/moveit/robot_model/robot_model.h 84.22% <ø> (ø)
...bot_state/include/moveit/robot_state/robot_state.h 91.12% <ø> (ø)
...nning_scene_monitor/src/planning_scene_monitor.cpp 67.84% <0.00%> (-0.31%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 41771d0...6ae0dcc. Read the comment docs.

Copy link
Contributor

@simonschmeisser simonschmeisser left a comment

Choose a reason for hiding this comment

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

thanks especially for the corner-case info about active joints!

@AndyZe AndyZe merged commit 7461264 into moveit:master Feb 23, 2021
@v4hn
Copy link
Contributor

v4hn commented Feb 24, 2021 via email

@AndyZe AndyZe mentioned this pull request Mar 29, 2021
6 tasks
@AndyZe
Copy link
Member Author

AndyZe commented Mar 29, 2021

distance() just sums the joint difference, for all joints. It's not an L2 norm or SSE or anything like that.
Just because of the way you formulate this: summing up element-wise differences is the standard L1 norm and I'm missing that term a bit in your patch. There was even a proposal to add weighting to the components, but it was not merged as far as I know.

I'm porting this to MoveIt2 now and will mention L1 norm 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

JointModel interpolate() -- time argument is a misnomer
4 participants