Add double alpha channel support and improve metadata behaviours for BackgroundCompositor #2696

yukaribbba · 2023-12-16T05:06:53Z

Current BackgroundCompositor assumes that only foreground has an alpha band. What if both of them do? Like the newly added #2557 , both LowCloudCompositor and HighCloudCompositor generate images with alpha channels.

Here's an example of a high_cloud stacked on a low_cloud:
This is the result of current compositor. Apparently it can't handle the background alpha correctly.

Below is by this PR. It recognizes both alpha channels, and builds a new alpha.

Closes Improvements for BackgroundCompositor #2695
Tests added
Fully documented

codecov · 2023-12-16T08:33:31Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.94%. Comparing base (f5a8532) to head (05fdcbf).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2696   +/-   ##
=======================================
  Coverage   95.94%   95.94%           
=======================================
  Files         379      379           
  Lines       53673    53693   +20     
=======================================
+ Hits        51494    51515   +21     
+ Misses       2179     2178    -1

Flag	Coverage Δ
behaviourtests	`4.09% <8.57%> (+<0.01%)`	⬆️
unittests	`96.04% <100.00%> (+<0.01%)`	⬆️

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.

coveralls · 2023-12-16T10:33:25Z

Pull Request Test Coverage Report for Build 8762065249

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 0.0%

Totals
Change from base Build 8732515933:	0.0%
Covered Lines:	0
Relevant Lines:	0

💛 - Coveralls

satpy/composites/__init__.py

djhoese · 2023-12-16T15:27:50Z

Could you describe the use case here? If the foreground has invalid pixels that you don't want to be filled in with background, why are you using the background compositor? Additionally, I believe there are "Filler" compositors that will fill in invalid data with a specific value. This could be done before calling the BackgroundCompositor.

yukaribbba · 2023-12-16T15:43:22Z

Well this is a little more complicated than I expected. I have to organize my thoughts. I think maybe I need a third channel used for masking area, just like there's a "high_resolution_band" in SharpenedCompositor

yukaribbba · 2023-12-18T08:34:22Z

pre-commit.ci autofix

for more information, see https://pre-commit.ci

…b.com/yukaribbba/satpy into add_features_to_background_compositor

mraspaud

just some comments

satpy/composites/__init__.py

…b.com/yukaribbba/satpy into add_features_to_background_compositor

mraspaud

LGTM! thanks for the simplifications

mraspaud · 2024-04-19T06:23:05Z

@djhoese rtd seems to fail, but I can't see any problem in the logs, any idea where I should look next?

djhoese · 2024-04-19T15:20:56Z

Right in the middle of the log:


/home/docs/checkouts/readthedocs.org/user_builds/satpy/conda/2696/lib/python3.10/site-packages/satpy/composites/__init__.py:docstring of satpy.composites.BackgroundCompositor:5: ERROR: Unexpected indentation.

mraspaud · 2024-04-19T15:38:37Z

Right in the middle of the log:


/home/docs/checkouts/readthedocs.org/user_builds/satpy/conda/2696/lib/python3.10/site-packages/satpy/composites/__init__.py:docstring of satpy.composites.BackgroundCompositor:5: ERROR: Unexpected indentation.

duh, I was grep for warning... thanks
@yukaribbba the identation of the docstring doesn't seem to agree with sphinx...

yukaribbba · 2024-04-19T15:44:30Z

Right in the middle of the log:
/home/docs/checkouts/readthedocs.org/user_builds/satpy/conda/2696/lib/python3.10/site-packages/satpy/composites/__init__.py:docstring of satpy.composites.BackgroundCompositor:5: ERROR: Unexpected indentation.
duh, I was grep for warning... thanks @yukaribbba the identation of the docstring doesn't seem to agree with sphinx...

Dang...This should be fine now.

mraspaud · 2024-04-19T15:52:28Z

@yukaribbba shinx build now passes, but I'm not sure it looks like you intended, see here https://satpy--2696.org.readthedocs.build/en/2696/api/satpy.composites.html#satpy.composites.BackgroundCompositor

yukaribbba · 2024-04-19T15:55:13Z

damn, how can I do that? Is there something special like \n that rtd can recogonize?

mraspaud · 2024-04-19T15:56:28Z

See here to find something you can use: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
Maybe a bullet list?

yukaribbba · 2024-04-19T16:10:04Z

Maybe a table would be better. Let's see how it renders.

yukaribbba · 2024-04-19T16:17:52Z

Heading to bed. I'll see this tomorrow.

yukaribbba · 2024-04-20T02:54:54Z

Done. https://satpy--2696.org.readthedocs.build/en/2696/api/satpy.composites.html#satpy.composites.BackgroundCompositor

mraspaud

LGTM!

yukaribbba added 6 commits December 16, 2023 13:04

Update __init__.py

6f4ca38

Update __init__.py

c21651a

Update test_composites.py

09c281e

Update __init__.py

d82057a

Update __init__.py

557853a

Update __init__.py

61930e6

yukaribbba added 7 commits December 16, 2023 16:46

Update __init__.py

1d12212

Update __init__.py

d1b9dd8

Update __init__.py

0ef787d

Update __init__.py

afd9f8a

Update __init__.py

19e41df

Update __init__.py

13896c3

Update __init__.py

23ddfba

yukaribbba changed the title ~~Add background_fill_in kwarg and double alpha channel support to BackgroundCompositor~~ Add bg_fill_in kwarg and double alpha channel support to BackgroundCompositor Dec 16, 2023

djhoese reviewed Dec 16, 2023

View reviewed changes

satpy/composites/__init__.py Outdated Show resolved Hide resolved

yukaribbba added 2 commits December 17, 2023 23:48

Update __init__.py

a87631e

composite and test

9d306e5

yukaribbba changed the title ~~Add bg_fill_in kwarg and double alpha channel support to BackgroundCompositor~~ Add a third optional dataset for masking and double alpha channel support to BackgroundCompositor Dec 18, 2023

pre-commit-ci bot and others added 7 commits December 18, 2023 08:34

[pre-commit.ci] auto fixes from pre-commit.com hooks

01af472

for more information, see https://pre-commit.ci

Update __init__.py

d1ef7dc

Merge branch 'add_features_to_background_compositor' of https://githu…

d76f600

…b.com/yukaribbba/satpy into add_features_to_background_compositor

Update __init__.py

1d20d45

Update test_composites.py

89818ad

EDIT

27eb158

Update test_composites.py

ff4cb2e

mraspaud reviewed Apr 17, 2024

View reviewed changes

satpy/composites/__init__.py Outdated Show resolved Hide resolved

satpy/composites/__init__.py Outdated Show resolved Hide resolved

yukaribbba and others added 7 commits April 18, 2024 15:26

Update __init__.py

71a2aca

Update test_composites.py

258e32d

Merge branch 'pytroll:main' into add_features_to_background_compositor

5cf7e13

Update test_composites.py

cd6fecf

Merge branch 'add_features_to_background_compositor' of https://githu…

6b9383a

…b.com/yukaribbba/satpy into add_features_to_background_compositor

Update __init__.py

92b435c

Update __init__.py

95f26b5

yukaribbba requested a review from mraspaud April 18, 2024 08:49

mraspaud approved these changes Apr 19, 2024

View reviewed changes

Update __init__.py

e0c06de

Update __init__.py

807e0a4

Update __init__.py

5f8c3eb

yukaribbba added 3 commits April 20, 2024 10:25

Update __init__.py

58901ef

Update __init__.py

00f1710

Update __init__.py

05fdcbf

yukaribbba requested a review from mraspaud April 20, 2024 02:55

mraspaud approved these changes Apr 22, 2024

View reviewed changes

mraspaud merged commit 211cda2 into pytroll:main Apr 22, 2024
18 of 19 checks passed

yukaribbba deleted the add_features_to_background_compositor branch April 22, 2024 10:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add double alpha channel support and improve metadata behaviours for BackgroundCompositor #2696

Add double alpha channel support and improve metadata behaviours for BackgroundCompositor #2696

yukaribbba commented Dec 16, 2023 •

edited

Loading

codecov bot commented Dec 16, 2023 •

edited

Loading

coveralls commented Dec 16, 2023 •

edited

Loading

djhoese commented Dec 16, 2023

yukaribbba commented Dec 16, 2023

yukaribbba commented Dec 18, 2023

mraspaud left a comment

mraspaud left a comment

mraspaud commented Apr 19, 2024

djhoese commented Apr 19, 2024

mraspaud commented Apr 19, 2024

yukaribbba commented Apr 19, 2024

mraspaud commented Apr 19, 2024

yukaribbba commented Apr 19, 2024

mraspaud commented Apr 19, 2024

yukaribbba commented Apr 19, 2024 •

edited

Loading

yukaribbba commented Apr 19, 2024

yukaribbba commented Apr 20, 2024

mraspaud left a comment

Add double alpha channel support and improve metadata behaviours for BackgroundCompositor #2696

Add double alpha channel support and improve metadata behaviours for BackgroundCompositor #2696

Conversation

yukaribbba commented Dec 16, 2023 • edited Loading

codecov bot commented Dec 16, 2023 • edited Loading

Codecov Report

coveralls commented Dec 16, 2023 • edited Loading

Pull Request Test Coverage Report for Build 8762065249

Details

💛 - Coveralls

djhoese commented Dec 16, 2023

yukaribbba commented Dec 16, 2023

yukaribbba commented Dec 18, 2023

mraspaud left a comment

Choose a reason for hiding this comment

mraspaud left a comment

Choose a reason for hiding this comment

mraspaud commented Apr 19, 2024

djhoese commented Apr 19, 2024

mraspaud commented Apr 19, 2024

yukaribbba commented Apr 19, 2024

mraspaud commented Apr 19, 2024

yukaribbba commented Apr 19, 2024

mraspaud commented Apr 19, 2024

yukaribbba commented Apr 19, 2024 • edited Loading

yukaribbba commented Apr 19, 2024

yukaribbba commented Apr 20, 2024

mraspaud left a comment

Choose a reason for hiding this comment

yukaribbba commented Dec 16, 2023 •

edited

Loading

codecov bot commented Dec 16, 2023 •

edited

Loading

coveralls commented Dec 16, 2023 •

edited

Loading

yukaribbba commented Apr 19, 2024 •

edited

Loading