astropy / astropy/reproject

Not clear what match_background=True does

Open
#215 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
127
Forks
74
Avg merge
1d 11h
Merged PRs (30d)
2

Description

`reproject_and_coadd` has the `match_background` option, but the docs for this are currently just `'Whether to match the backgrounds of the images.'` (https://reproject.readthedocs.io/en/stable/api/reproject.mosaicking.reproject_and_coadd.html).

From this it's not clear exactly what the effect of setting `match_background=True` is on each of the images that are being coadded, so it would be great to get an expanded description of this.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the reproject_and_coadd API documentation linked in the issue and locate the current match_background parameter description. Clarify the effect of setting match_background=True on each image being coadded, then verify that the generated documentation explains the behavior more precisely.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.