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

Doc bugs #254

Closed
esheldon opened this issue Sep 27, 2021 · 1 comment
Closed

Doc bugs #254

esheldon opened this issue Sep 27, 2021 · 1 comment
Labels

Comments

@esheldon
Copy link
Collaborator

This says See ~init_sources but should say init_source:

See `~init_sources` for a description of the arguments

This says "Fraction of the background to use as a threshold" but should say it is the background RMS, as in ExtendedSource, e.g. say "Multiple of the backround RMS used as a flux cutoff for morphology initialization.":

Fraction of the background to use as a threshold for

In the docs here https://pmelchior.github.io/scarlet/0-quickstart.html it says

"We can see that this method chooses multiple (here 2) extended components for the first three sources, a single extended component for sources 3 and 5, and compact ones for the rest."

But the outputs don't show any compact sources, only MultiExtendedSource and SingleExtendedSource

@esheldon
Copy link
Collaborator Author

esheldon commented Oct 1, 2021

Also here, I think this needs clarification for newbies like me.

min_snr: float

It says "Mininmum SNR per component to accept the source." From talking to fred it is used to determine how many components are accepted, not if the source (object) is accepted. For fallback=True it will not reject the entire source (object), it will reject components that are not at least min_snr, dropping down to components of zero, which implies that it gets initialized as a point source (but perhaps still modeled as an extended source)

@pmelchior pmelchior added the docs label Jul 6, 2022
pmelchior added a commit that referenced this issue May 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants