`unwrap_error_phase_closure`: use user-defined `connCompMinArea` #1336

Alex-Lewandowski · 2025-03-28T20:23:10Z

Make correct_unwrap_error_phase_closure use user-defined connCompMinArea when labeling connected components. It currently always uses the default.

Description of proposed changes

Fixes #1335

adds a cc_min_area arg to correct_unwrap_error_phase_closure so it can be passed to cc_obj.label(min_area=cc_min_area).
- If min_area is not passed label, it uses the default of 2.5e3

Reminders

Fix User-defined connCompMinArea not used during unwrapping error correction with phase_closure method #1335
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.~~
~~If adding new functionality, add a detailed description to the documentation and/or an example.~~

Summary by Sourcery

Modify the phase closure error correction function to allow user-defined minimum area for connected component labeling

New Features:

Introduce a new optional parameter cc_min_area to control the minimum area threshold for connected component labeling

Bug Fixes:

Fix the default connected component labeling by adding a configurable minimum area parameter

Enhancements:

Add flexibility to the phase closure error correction by allowing custom minimum area for connected component labeling

Summary by Sourcery

Modify the phase closure error correction function to allow user-defined minimum area for connected component labeling

New Features:

Add an optional cc_min_area parameter to correct_unwrap_error_phase_closure function to control the minimum area threshold for connected component labeling

Bug Fixes:

Enable flexible configuration of minimum area for connected component labeling, addressing the default hard-coded value

Enhancements:

Improve function flexibility by allowing custom minimum area parameter for connected component labeling

…rea when labeling connected components

sourcery-ai · 2025-03-28T20:23:16Z

Reviewer's Guide by Sourcery

This pull request modifies the correct_unwrap_error_phase_closure function to allow users to specify the minimum area for connected component labeling via the cc_min_area argument. This change provides more flexibility in the phase closure error correction process.

Sequence diagram for `correct_unwrap_error_phase_closure` with user-defined `connCompMinArea`

sequenceDiagram
  participant user as User
  participant correct_unwrap_error_phase_closure as correct_unwrap_error_phase_closure
  participant conncomp_obj as conncomp.connectComponent

  user->>correct_unwrap_error_phase_closure: Call correct_unwrap_error_phase_closure(ifgram_file, common_regions, water_mask_file, ccName, dsNameIn, dsNameOut, cc_min_area)
  correct_unwrap_error_phase_closure->>conncomp_obj: cc_obj = conncomp.connectComponent(conncomp=cc, metadata=stack_obj.metadata)
  correct_unwrap_error_phase_closure->>conncomp_obj: cc_obj.label(min_area=cc_min_area)
  conncomp_obj-->>correct_unwrap_error_phase_closure: labelImg
  correct_unwrap_error_phase_closure->>correct_unwrap_error_phase_closure: measure.regionprops(cc_obj.labelImg)
  correct_unwrap_error_phase_closure-->>user: Returns corrected unwrap phase

File-Level Changes

Change	Details	Files
Modified the `correct_unwrap_error_phase_closure` function to accept a `cc_min_area` argument, allowing users to specify the minimum area for connected component labeling.	Added `cc_min_area` as an argument to the `correct_unwrap_error_phase_closure` function. Passed the `cc_min_area` argument to the `cc_obj.label()` function. Added `cc_min_area` to the `run_unwrap_error_phase_closure` function.	`src/mintpy/unwrap_error_phase_closure.py`

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#1335	Ensure the `correct_unwrap_error_phase_closure` function uses the user-defined `connCompMinArea` value when labeling connected components, instead of the default value.	✅
#1335	The code should use the user-defined `connCompMinArea` value when labeling connected components during phase closure unwrapping error correction.	✅

Possibly linked issues

User-defined connCompMinArea not used during unwrapping error correction with phase_closure method #1335: The PR fixes the issue by adding a cc_min_area arg to correct_unwrap_error_phase_closure so the user-defined connCompMinArea can be passed to the connected component labeling function.

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

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

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

Overall Comments:

Consider adding a check to ensure cc_min_area is a positive value.

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 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.}

src/mintpy/unwrap_error_phase_closure.py

Alex-Lewandowski · 2025-03-28T23:25:37Z

Overall Comments:

Consider adding a check to ensure cc_min_area is a positive value.

Good thought, but maybe it would be best to check in the unwrap_error_phase_closure and unwrap_error_bridging CLIs?

+ objects.conncomp.label_conn_comp: skip removing small objects if there is only one label + cli.unwrap_error_phase_closure: add checking for --num-sample and --min-area

yunjunz

LGTM. Thank you @Alex-Lewandowski!

Make correct_unwrap_error_phase_closure use user-defined connCompMinA…

81f72d1

…rea when labeling connected components

Alex-Lewandowski added the bug label Mar 28, 2025

Alex-Lewandowski marked this pull request as ready for review March 28, 2025 21:00

sourcery-ai bot reviewed Mar 28, 2025

View reviewed changes

src/mintpy/unwrap_error_phase_closure.py Show resolved Hide resolved

Alex-Lewandowski requested a review from forrestfwilliams March 28, 2025 21:02

yunjunz self-requested a review April 1, 2025 08:40

conncomp: skip remove_small_objects if num_label <= 1

88133bf

+ objects.conncomp.label_conn_comp: skip removing small objects if there is only one label + cli.unwrap_error_phase_closure: add checking for --num-sample and --min-area

yunjunz approved these changes Apr 1, 2025

View reviewed changes

yunjunz changed the title ~~Unwrap error correction with phase_closure should use user-defined connCompMinArea~~ unwrap_error_phase_closure: use user-defined connCompMinArea Apr 1, 2025

yunjunz merged commit 4bbca8c into main Apr 1, 2025
8 checks passed

yunjunz deleted the bug/unw_err_phase_closure_use_min_cc_size branch April 1, 2025 09:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`unwrap_error_phase_closure`: use user-defined `connCompMinArea` #1336

`unwrap_error_phase_closure`: use user-defined `connCompMinArea` #1336

Uh oh!

Alex-Lewandowski commented Mar 28, 2025 •

edited

Loading

Uh oh!

sourcery-ai bot commented Mar 28, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

Uh oh!

Alex-Lewandowski commented Mar 28, 2025

Uh oh!

yunjunz left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

unwrap_error_phase_closure: use user-defined connCompMinArea #1336

unwrap_error_phase_closure: use user-defined connCompMinArea #1336

Uh oh!

Conversation

Alex-Lewandowski commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by Sourcery

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

Sequence diagram for correct_unwrap_error_phase_closure with user-defined connCompMinArea

File-Level Changes

Assessment against linked issues

Possibly linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Alex-Lewandowski commented Mar 28, 2025

Uh oh!

yunjunz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

`unwrap_error_phase_closure`: use user-defined `connCompMinArea` #1336

`unwrap_error_phase_closure`: use user-defined `connCompMinArea` #1336

Alex-Lewandowski commented Mar 28, 2025 •

edited

Loading

sourcery-ai bot commented Mar 28, 2025 •

edited

Loading

Sequence diagram for `correct_unwrap_error_phase_closure` with user-defined `connCompMinArea`