Skip to content
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.

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

Source detection+PSF docs updates #984

Merged
merged 1 commit into from
Nov 14, 2023

Conversation

bmorris3
Copy link
Collaborator

@bmorris3 bmorris3 commented Nov 8, 2023

This PR adds narrative docs for users and devs following the introduction of PSF fitting in Source Detection Step (#794, #841). This is a starting point, happy to iterate as reviewers see fit.

Resolves RCAL-708

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 8, 2023
Copy link

codecov bot commented Nov 8, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (50219a1) 73.55% compared to head (437ef0e) 73.55%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #984   +/-   ##
=======================================
  Coverage   73.55%   73.55%           
=======================================
  Files         103      103           
  Lines        6711     6712    +1     
=======================================
+ Hits         4936     4937    +1     
  Misses       1775     1775           
Flag Coverage Δ *Carryforward flag
nightly 63.26% <ø> (ø) Carriedforward from 50219a1

*This pull request uses carry forward flags. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bmorris3 bmorris3 force-pushed the source-detect-psf-docs branch from 7eb5a61 to b7efe27 Compare November 13, 2023 17:24
@bmorris3 bmorris3 marked this pull request as ready for review November 13, 2023 17:29
@bmorris3 bmorris3 requested a review from a team as a code owner November 13, 2023 17:29
Copy link
Collaborator

@schlafly schlafly left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks!

@@ -42,7 +44,7 @@ in a parameter file.
* ``--bkg_boxsize``: If using `calc_threshold_img` size of box in pixels for
2D background / threshold images and if using
calc_threshold_2d, the size of the box used when detecting
sources. Default is 3.
sources. Default is 9.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Good catch! 9 is pretty tiny too. I think we use 256 for the equivalent of this in other surveys!

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This number will still need to be adjusted if there's a crowding, or the source is very bright, etc.

@bmorris3
Copy link
Collaborator Author

bmorris3 commented Nov 13, 2023

I won't update the changelog for this entry until #987 is merged (to avoid a conflict with moving these lines).

@bmorris3 bmorris3 force-pushed the source-detect-psf-docs branch 2 times, most recently from e072759 to 8a7cb2f Compare November 14, 2023 14:08
@bmorris3 bmorris3 force-pushed the source-detect-psf-docs branch from 8a7cb2f to 437ef0e Compare November 14, 2023 14:09
@bmorris3 bmorris3 enabled auto-merge (rebase) November 14, 2023 14:13
@bmorris3 bmorris3 merged commit ff4ffe0 into spacetelescope:main Nov 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants