Skip to content

Commit

Permalink
closes #254
Browse files Browse the repository at this point in the history
  • Loading branch information
pmelchior committed May 1, 2024
1 parent fcd1b29 commit a8248c7
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions scarlet/initialization.py
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ def init_all_sources(
model will be kept, otherwise one component is removed and the source reinitialized.
If a source cannot be initialized, its index is returned in `skipped`.
See `~init_sources` for a description of the arguments
See `~init_source` for a description of the arguments
Parameters
----------
Expand Down Expand Up @@ -404,8 +404,7 @@ def init_source(
The `Observation` that contains the images, weights, and PSF
used to generate the model.
thresh : `float`
Fraction of the background to use as a threshold for
each pixel in the initialization
Multiple of the backround RMS used as a flux cutoff for morphology initialization
max_components : int
The maximum number of components in a source.
If `fallback` is `True` then when
Expand All @@ -417,7 +416,9 @@ def init_source(
The minimum number of components in a source.
Only relevent for `fallback=True`.
min_snr: float
Mininmum SNR per component to accept the source.
Mininmum SNR per component of a multi-component source.
If fallback=True, every component needs to have at least min_snr, otherwise the component number will be reduced
At last resort, the component is initialized with a PointSource morphology
shifting : bool
Whether or not to fit the position of a source.
This is an expensive operation and is typically only used when
Expand Down

0 comments on commit a8248c7

Please sign in to comment.