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

What are the returns from fit_im? #9

Open
keflavich opened this issue Sep 3, 2022 · 4 comments
Open

What are the returns from fit_im? #9

keflavich opened this issue Sep 3, 2022 · 4 comments

Comments

@keflavich
Copy link
Contributor

Could you provide some narrative documentation for the returns from fit_im?

res = (stars, model+sky, sky+msky, psf)
return res

My attempt:

  • stars is the star catalog
  • model + sky is the sum of the stellar model and the "background" model
  • sky + msky is the .... sky model? It's low-resolution. I'm not sure how to differentiate sky, msky, and model, though I suspect model is the stars-only image?
  • psf is the fitted PSF (or the original PSF if refitting isn't used)

Which return value would you consider the best representation of the star-subtracted image? i.e., the best representation of the extended emission?

@schlafly
Copy link
Owner

schlafly commented Sep 6, 2022

Thanks for looking at this.
Yes:

  • stars is the star catalog
  • model + sky is the total model; the sum of the model and the sky
  • sky + msky is the total diffuse component; it's the sum of the model sky (msky; already included in model), and the high frequency median sky (sky) that I fit separately from the model.
  • psf is the psf model.
    The best representation of the star-subtracted image would be sky+msky; that's what that third entry is intended to be.

@keflavich
Copy link
Contributor Author

Great, thanks!

Shall we leave this open until you get a chance to put this into the documentation somewhere?

@schlafly
Copy link
Owner

schlafly commented Sep 6, 2022

Yes, I'll leave it open as a reminder that I should add some docstrings for functions---certainly at least some of the major entrance points.

@andrew-saydjari
Copy link
Collaborator

I will say that I also had to explain this to someone in the last 3 months, so it is a high priority doc string.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants