Skip to content

Conversation

@yunjunz
Copy link
Member

@yunjunz yunjunz commented May 31, 2025

Description of proposed changes

  • objects.sensor.py

    • add parameters for BIOMASS/SWOT/NISAR-S
    • add NESZ for several missions
  • more print out message for multilook.py and unwrap_error_phase_closure.py

Reminders

  • Pass Pre-commit check (green)
  • Pass Codacy code review (green)
  • Pass Circle CI test (green)

+ objects.sensor.py
   - add parameters for BIOMASS/SWOT/NISAR-S
   - add NESZ for several missions

+ more print out message for multilook.py and unwrap_error_phase_closure.py
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 31, 2025

Reviewer's Guide

This PR extends the sensor definitions by introducing new missions (SWOT, NISAR-S, BIOMASS), enriches existing sensor metadata with NESZ values and updated parameters, and improves user feedback in the CLI by adding example flags in multilook.py and logging in unwrap_error_phase_closure.py.

Class Diagram for New Sensor Definitions (SWOT, NISAR-S, BIOMASS)

classDiagram
    class SWOT {
        +altitude: number
        +orbit_inclination: number
        +carrier_frequency: number
        +pulse_repetition_frequency: number
        +chirp_bandwidth: number
        +sampling_frequency: number
    }

    class NISAR_S {
        +altitude: number
        +orbit_inclination: number
        +repeat_cycle: number
        +carrier_frequency: number
        +antenna_radius: number
        +pulse_repetition_frequency: number
        +chirp_bandwidth: number
        +azimuth_resolution: number
        +noise_equivalent_sigma_zero: number
    }

    class BIOMASS {
        +altitude: number
        +orbit_inclination: number
        +repeat_cycle: number
        +carrier_frequency: number
        +antenna_length: number
        +pulse_repetition_frequency: number
        +chirp_bandwidth: number
        +range_pixel_size: number
        +azimuth_pixel_size: number
        +noise_equivalent_sigma_zero: number
    }
Loading

Class Diagram: Updates to Sensor Configuration Dictionaries

classDiagram
    class SENSOR_DICT {
      <<Dictionary>>
      +String bio : BIOMASS <<added>>
      %%
        ... other existing entries
    }
    class BIOMASS {
      %% Defined in "New Sensor Definitions" diagram
      %% Attributes: altitude, orbit_inclination, etc.
    }
    SENSOR_DICT o-- BIOMASS : "entry 'bio'"

    class MISSION_ALIASES {
      <<Dictionary>>
      +String bio : List~String~ <<added>> %% Value: ["bio", "biomass"]
      %%
        ... other existing entries
    }
Loading

Class Diagram: Illustrative Updates to Existing Sensor Parameters

classDiagram
    class RCM {
        <<Sensor>>
        +chirp_bandwidth: number <<added>>
        +noise_equivalent_sigma_zero: number <<added>>
        %%
          ... other existing attributes
    }

    class SEN {
        <<Sensor>>
        +antenna_width: number <<updated>>
        +noise_equivalent_sigma_zero: number <<added>>
        %%
          ... other existing attributes
    }

    class ALOS4 {
        <<Sensor>>
        +carrier_frequency: number <<added>>
        +chirp_bandwidth: number <<added>>
        +range_resolution: number <<added>>
        +noise_equivalent_sigma_zero: number <<added>>
        %%
          ... other existing attributes
    }

    class GF3 {
        <<Sensor>>
        +antenna_width: number <<updated>>
        +noise_equivalent_sigma_zero: number <<added>>
        %%
          ... other existing attributes
    }
    %% Other sensors updated primarily with 'noise_equivalent_sigma_zero':
    %% - HJ1C, ALOS, ALOS2, SAOCOM, LT1, UAV_L, NISAR_L
Loading

File-Level Changes

Change Details Files
Extend sensor definitions with new missions
  • Add SWOT (Ka-band) sensor dict
  • Add NISAR_S (S-band) sensor dict
  • Add BIOMASS (P-band) sensor dict
  • Include new sensors in SENSOR_DICT and alias map
src/mintpy/objects/sensor.py
Enhance existing sensor metadata with NESZ and updated parameters
  • Insert noise_equivalent_sigma_zero fields for multiple missions
  • Update antenna_width, sampling_frequency, and chirp_bandwidth values
  • Add active date and reference comments for various sensors
src/mintpy/objects/sensor.py
Improve CLI example usage in multilook.py
  • Add '-m nearest' option to multilook usage examples
  • Adjust spacing in example commands for consistency
src/mintpy/cli/multilook.py
Add dataset name logging in unwrap_error_phase_closure.py
  • Print 'used dataset name' after interferogram and triplet counts
src/mintpy/unwrap_error_phase_closure.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!

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

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 and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟢 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.

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@yunjunz yunjunz merged commit cc2cc9a into insarlab:main May 31, 2025
7 checks passed
@yunjunz yunjunz deleted the sensor branch May 31, 2025 03:44
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.

1 participant