Skip to content

Document rel_thresh parameter in com_psf #63

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.

Sign up for GitHub

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

Merged
cgarling merged 1 commit into from
Jun 9, 2026
Merged

Document rel_thresh parameter in com_psf #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions src/psf.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,16 @@

Determine peak parameters via a fast, non-iterative center-of-mass approach.
Return quantities are typed to `promote_type(T, typeof(maximum(img_ap)))`.
Peak parameters are returned as a NamedTuple with fields

The threshold for the center-of-mass calculation is computed as the average
value of the border pixels (a simple background estimate) plus `rel_thresh`
times the peak pixel value. Pixels below this threshold are clamped to zero.
Larger values of `rel_thresh` isolate the core of the PSF; smaller values
include more of the wings.

Peak parameters are returned as a NamedTuple with fields
- `psf_params`: NamedTuple containing entries `x`, `y`, and `fwhm`
(a tuple of x and y FWHM).
(a tuple of x and y FWHM).
- `psf_model`: `"com"` to indicate center-of-mass
- `psf_data`: the input image cutout (`img_ap`) for reference
"""
Expand Down
Loading