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

Report distance from track origin #158

Merged
merged 3 commits into from
Dec 18, 2023
Merged

Report distance from track origin #158

merged 3 commits into from
Dec 18, 2023

Conversation

adamltyson
Copy link
Member

@adamltyson adamltyson commented Dec 18, 2023

Before submitting a pull request (PR), please read the contributing guide.

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?

This PR calculates the distance along the spline fit from the first point. This allows the user to know that e.g. point 40 is 400um from the first point, or find out the total length of the track.

References

Closes #37

How has this PR been tested?

Manually tested & automated tests updated.

Is this a breaking change?

It could break downstream workflows if they rely on csv column ordering, but this would be easily fixed.

Does this PR require an update to the documentation?

Yes - brainglobe/brainglobe.github.io#128

Checklist:

  • The code has been tested locally
  • Tests have been added to cover all new functionality (unit & integration)
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

Copy link
Member

@alessandrofelder alessandrofelder left a comment

Choose a reason for hiding this comment

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

Tiny suggestion to make docs explicit, otherwise happy with this.

brainglobe_segmentation/tracks/analysis.py Outdated Show resolved Hide resolved
@adamltyson adamltyson merged commit 0ca1f2e into main Dec 18, 2023
10 checks passed
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.

output total probe track distance (from surface to last point in track)
2 participants