Thanks to visit codestin.com
Credit goes to github.com

Skip to content

sensor: add UAVSAR-L #1320

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
yunjunz merged 3 commits into from
Feb 10, 2025
Merged

sensor: add UAVSAR-L #1320

yunjunz merged 3 commits into from
Feb 10, 2025

Conversation

@yunjunz
Copy link
Member

@yunjunz yunjunz commented Feb 10, 2025 •
edited
Loading

Description of proposed changes

  • objects/sensor: add UAVSAR-L info

  • utils.network.py:

    • refactor critical_perp_baseline() to incorporate different near_range value of different sensors
    • simulate_coherence_v2(): add SNR as an input argument

  • utils.ptime.get_date_range(): ensure output dt_list is within the input [dmin, dmax]

Reminders

  • Pass Pre-commit check (green)
  • Pass Codacy code review (green)
  • Pass Circle CI test (green)
  • Make sure that your code follows our style. Use the other functions/files as a basis.
  • If modifying functionality, describe changes to function behavior and arguments in a comment below the function declaration.

@yunjunz
sensor: add UAVSAR-L
0435a37
@yunjunz
utils/network: more generic critical_perp_baseline()
89edc77 
+ `utils.network.py`:
   - refactor `critical_perp_baseline()` to incorporate different near_range value of different sensors
   - `simulate_coherence_v2()`: add SNR as a input argument

+ `utils.ptime.get_date_range()`: ensure output dt_list is within the input `[dmin, dmax]`
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 10, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request introduces several enhancements including adding UAVSAR-L sensor info, refactoring critical_perp_baseline to use sensor-specific near_range values and improved defaults, updating the simulate_coherence_v2 function to accept an SNR parameter, and ensuring the output date range is properly bounded in get_date_range.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Add UAVSAR-L sensor definition and documentation.
  • Introduced new UAVSAR-L sensor information with parameters like altitude, carrier frequency, antenna properties, and resolutions.
  • Added relevant reference links and documentation comments for UAVSAR-L.
 src/mintpy/objects/sensor.py
Refactor critical_perp_baseline in network module.
  • Updated function signature with a default inc_angle value and enhanced docstring documentation.
  • Introduced a sensor name check to validate input and fetch sensor-specific near_range values from a mapping.
  • Replaced manual trigonometric calculation with np.deg2rad for clarity.
  • Modified the print message handling based on the print_msg parameter (with a conditional print or none).
 src/mintpy/utils/network.py
Update simulate_coherence_v2 to accept SNR as an input.
  • Modified the function signature to include SNR, allowing users to pass an SNR value as an argument.
  • Revised the SNR to coherence conversion using the passed SNR to calculate coh_thermal.
 src/mintpy/utils/network.py
Ensure date range output in get_date_range is within [dmin, dmax].
  • Added a check to verify that the generated datetime objects do not exceed the maximum date (dmax) and adjusted the list accordingly.
  • Maintained the conversion of datetime objects to the specified string format.
 src/mintpy/utils/ptime.py
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@codeautopilot
Copy link

codeautopilot bot commented Feb 10, 2025 •
edited by yunjunz
Loading

PR Summary

This Pull Request introduces several enhancements and fixes across different modules of the codebase:

  1. Addition of UAVSAR-L Sensor Information: The src/mintpy/objects/sensor.py file has been updated to include information about the UAVSAR-L sensor. This addition expands the sensor dictionary with parameters specific to UAVSAR-L, such as carrier frequency, antenna dimensions, and resolution metrics.

  2. Refactoring of critical_perp_baseline(): The function critical_perp_baseline() in src/mintpy/utils/network.py has been refactored to handle different near_range values for various sensors. This change makes the function more flexible and accurate for different sensor configurations.

  3. Enhancement of simulate_coherence_v2(): The simulate_coherence_v2() function now accepts an additional parameter, SNR (Signal-to-Noise Ratio), allowing for more customizable coherence simulations. This change improves the function's usability by enabling users to specify SNR values directly.

  4. Date Range Adjustment in get_date_range(): The get_date_range() function in src/mintpy/utils/ptime.py has been modified to ensure that the output date list is strictly within the specified [dmin, dmax] range. This adjustment prevents potential off-by-one errors in date calculations.

Overall, these changes enhance the functionality and flexibility of the codebase, particularly in handling different sensor configurations and improving date range calculations.

Review Checklist

  • Pass Pre-commit check (green)
  • Pass Codacy code review (green)
  • Pass Circle CI test (green)
  • Ensure code follows style guidelines
  • Describe changes to function behavior and arguments

Suggestion

  • Consider adding unit tests for the newly added UAVSAR-L sensor parameters to ensure their correctness and integration with existing functionalities.
  • It might be beneficial to document the changes in critical_perp_baseline() and simulate_coherence_v2() more thoroughly, especially regarding the impact of the new SNR parameter on coherence simulations.

This comment was generated by AI. Information provided may be incorrect.

Current plan usage: 0%

Have feedback or need help?
Documentation
[email protected]

sourcery-ai[bot]
sourcery-ai bot reviewed Feb 10, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @yunjunz - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a unit test for the critical_perp_baseline function to ensure it returns the expected values for different sensors.
  • The near_range dictionary in critical_perp_baseline could be moved to the sensor.py file to keep sensor-specific information in one place.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@yunjunz yunjunz merged commit 42aa7b5 into insarlab:main Feb 10, 2025
7 checks passed
@yunjunz yunjunz deleted the sensor_uav branch February 10, 2025 05:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@yunjunz