Skip to content

fix compute start, stop distance bug #500

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.

Sign up for GitHub

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

Jump to bottom
Merged
aissah merged 1 commit into from
Apr 27, 2025
Merged

fix compute start, stop distance bug #500

aissah merged 1 commit into from
Apr 27, 2025

Conversation

@aissah
Copy link
Collaborator

@aissah aissah commented Apr 27, 2025 •
edited by coderabbitai bot
Loading

Description

Checklist

I have (if applicable):

  • referenced the GitHub issue this PR closes.
  • documented the new feature with docstrings or appropriate doc page.
  • included a test. See testing guidelines.
  • your name has been added to the contributors page (docs/contributors.md).
  • [] added the "ready_for_review" tag once the PR is ready to be reviewed.

Summary by CodeRabbit

  • Bug Fixes
    • Corrected the calculation of the distance axis range, ensuring the start and stop coordinates are accurately derived from the provided attributes. This results in improved accuracy for distance-based data representations.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 27, 2025 •
edited
Loading

Walkthrough

The update revises the internal logic of the _get_distance_coord function in dascore/io/tdms/utils.py. The calculation of the start and stop coordinates for the distance axis is modified: the start is now directly assigned from the attribute dictionary without adding the total length, and the stop is set as the start plus the total length. The computation of the step size and the use of these values to generate the coordinate array remain unchanged. No changes were made to public interfaces or function signatures.

Changes

File(s) Change Summary
dascore/io/tdms/utils.py Modified _get_distance_coord to set start directly from attributes and stop as start plus total length.

Possibly related issues

Poem

In the warren of code, a hop and a bound,
Distance recalculated, precision now found.
No more extra length at the start of the line,
Just start plus the total—oh, how divine!
With step still the same, and logic so neat,
This bunny declares: the fix is complete! 🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cd15e43 and 5765713.

📒 Files selected for processing (1)
  • dascore/io/tdms/utils.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (15)
  • GitHub Check: test_code (windows-latest, 3.12)
  • GitHub Check: test_code (windows-latest, 3.10)
  • GitHub Check: test_code (windows-latest, 3.11)
  • GitHub Check: test_code (ubuntu-latest, 3.10)
  • GitHub Check: test_code (macos-latest, 3.12)
  • GitHub Check: test_code (macos-latest, 3.10)
  • GitHub Check: test_code (macos-latest, 3.11)
  • GitHub Check: test_code (ubuntu-latest, 3.12)
  • GitHub Check: test_code (ubuntu-latest, 3.11)
  • GitHub Check: test_code_min_deps (windows-latest, 3.13)
  • GitHub Check: test_code_min_deps (windows-latest, 3.12)
  • GitHub Check: test_code_min_deps (ubuntu-latest, 3.13)
  • GitHub Check: test_code_min_deps (macos-latest, 3.12)
  • GitHub Check: test_code_min_deps (ubuntu-latest, 3.12)
  • GitHub Check: test_code_min_deps (macos-latest, 3.13)
🔇 Additional comments (2)
dascore/io/tdms/utils.py (2)

165-165: Correct fix for start distance calculation

This change properly addresses the issue described in PR #498. Removing the addition of total_length to StartPosition[m] is the correct approach, as it eliminates the unintended shift in the distance coordinates when loading TDMS files.

167-167: Appropriate stop calculation method

The new calculation of stop = start + total_length is mathematically sound and aligns better with the physical interpretation of the data. This provides the correct distance range for the fiber measurements, ensuring data from Silixa iDAS measurements will be properly aligned.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@aissah
Copy link
Collaborator Author

aissah commented Apr 27, 2025

@d-chambers could you review this?

@codecov
Copy link

codecov bot commented Apr 27, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.85%. Comparing base (cd15e43) to head (5765713).
Report is 1 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master     #500   +/-   ##
=======================================
  Coverage   99.85%   99.85%           
=======================================
  Files         118      118           
  Lines        9711     9711           
=======================================
  Hits         9697     9697           
  Misses         14       14
Flag Coverage Δ
unittests 99.85% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

d-chambers
d-chambers approved these changes Apr 27, 2025
View reviewed changes
Copy link
Contributor

@d-chambers d-chambers left a comment

Choose a reason for hiding this comment

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

Looks great

@aissah aissah merged commit a9880e5 into master Apr 27, 2025
19 checks passed
@d-chambers d-chambers mentioned this pull request May 27, 2025
Closed
@d-chambers d-chambers deleted the issue498 branch September 19, 2025 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@d-chambers d-chambers d-chambers approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@aissah @d-chambers