LSST Applications g0603fd7c41+501e3db9f9,g0aad566f14+23d8574c86,g0dd44d6229+a1a4c8b791,g2079a07aa2+86d27d4dc4,g2305ad1205+a62672bbc1,g2bbee38e9b+047b288a59,g337abbeb29+047b288a59,g33d1c0ed96+047b288a59,g3a166c0a6a+047b288a59,g3d1719c13e+23d8574c86,g487adcacf7+cb7fd919b2,g4be5004598+23d8574c86,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+4a9e435310,g63cd9335cc+585e252eca,g858d7b2824+23d8574c86,g88963caddf+0cb8e002cc,g99cad8db69+43388bcaec,g9ddcbc5298+9a081db1e4,ga1e77700b3+a912195c07,gae0086650b+585e252eca,gb0e22166c9+60f28cb32d,gb2522980b2+793639e996,gb3a676b8dc+b4feba26a1,gb4b16eec92+63f8520565,gba4ed39666+c2a2e4ac27,gbb8dafda3b+a5d255a82e,gc120e1dc64+d820f8acdb,gc28159a63d+047b288a59,gc3e9b769f7+f4f1cc6b50,gcf0d15dbbd+a1a4c8b791,gdaeeff99f8+f9a426f77a,gdb0af172c8+b6d5496702,ge79ae78c31+047b288a59,w.2024.19
LSST Data Management Base Package
Loading...
Searching...
No Matches
Classes | Functions | Variables
lsst.scarlet.lite.initialization Namespace Reference

Classes

class  FactorizedChi2Initialization
 
class  FactorizedInitialization
 
class  FactorizedWaveletInitialization
 

Functions

tuple[np.ndarray, Box] trim_morphology (np.ndarray morph, float bg_thresh=0, int padding=5)
 
tuple[Box, np.ndarray|None] init_monotonic_morph (np.ndarray detect, tuple[int, int] center, Box full_box, int padding=5, bool normalize=True, Monotonicity|None monotonicity=None, float thresh=0)
 
np.ndarray multifit_spectra (Observation observation, Sequence[Image] morphs, Image|None model=None)
 

Variables

 logger = logging.getLogger("scarlet.lite.initialization")
 

Function Documentation

◆ init_monotonic_morph()

tuple[Box, np.ndarray | None] lsst.scarlet.lite.initialization.init_monotonic_morph ( np.ndarray detect,
tuple[int, int] center,
Box full_box,
int padding = 5,
bool normalize = True,
Monotonicity | None monotonicity = None,
float thresh = 0 ) 
Initialize a morphology for a monotonic source

Parameters
----------
detect:
    The 2D detection image contained in `full_box`.
center:
    The center of the monotonic source.
full_box:
    The bounding box of `detect`.
padding:
    The number of pixels to grow the morphology in each direction.
    This can be useful if initializing a source with a kernel that
    is known to be narrower than the expected value of the source.
normalize:
    Whether or not to normalize the morphology.
monotonicity:
    When `monotonicity` is `None`,
    the component is initialized with only the
    monotonic pixels, otherwise the monotonicity operator is used to
    project the morphology to a monotonic solution.
thresh:
    The threshold (fraction above the background) to use for trimming the
    morphology.

Returns
-------
bbox:
    The bounding box of the morphology.
morph:
    The initialized morphology.

Definition at line 70 of file initialization.py.

78) -> tuple[Box, np.ndarray | None]:
79 """Initialize a morphology for a monotonic source
80
81 Parameters
82 ----------
83 detect:
84 The 2D detection image contained in `full_box`.
85 center:
86 The center of the monotonic source.
87 full_box:
88 The bounding box of `detect`.
89 padding:
90 The number of pixels to grow the morphology in each direction.
91 This can be useful if initializing a source with a kernel that
92 is known to be narrower than the expected value of the source.
93 normalize:
94 Whether or not to normalize the morphology.
95 monotonicity:
96 When `monotonicity` is `None`,
97 the component is initialized with only the
98 monotonic pixels, otherwise the monotonicity operator is used to
99 project the morphology to a monotonic solution.
100 thresh:
101 The threshold (fraction above the background) to use for trimming the
102 morphology.
103
104 Returns
105 -------
106 bbox:
107 The bounding box of the morphology.
108 morph:
109 The initialized morphology.
110 """
111 center: tuple[int, int] = tuple(center[i] - full_box.origin[i] for i in range(2)) # type: ignore
112
113 if monotonicity is None:
114 _, morph, bounds = prox_monotonic_mask(detect, center, max_iter=0)
115 bbox = bounds_to_bbox(bounds)
116 if bbox.shape == (1, 1) and morph[bbox.slices][0, 0] == 0:
117 return Box((0, 0)), None
118
119 if thresh > 0:
120 morph, bbox = trim_morphology(morph, bg_thresh=thresh, padding=padding)
121
122 # Shift the bounding box to account for the non-zero origin
123 bbox += full_box.origin
124
125 else:
126 morph = monotonicity(detect, center)
127
128 # truncate morph at thresh * bg_rms
129 morph, bbox = trim_morphology(morph, bg_thresh=thresh, padding=padding)
130 # Shift the bounding box to account for the non-zero origin
131 bbox += full_box.origin
132
133 if np.max(morph) == 0:
134 return Box((0, 0), origin=full_box.origin), None
135
136 if normalize:
137 morph /= np.max(morph)
138
139 if padding is not None and padding > 0:
140 # Pad the morphology to allow it to grow
141 bbox = bbox.grow(padding)
142
143 # Ensure that the bounding box is inside the full box,
144 # even after padding.
145 bbox = bbox & full_box
146 return bbox, morph
147
148

◆ multifit_spectra()

np.ndarray lsst.scarlet.lite.initialization.multifit_spectra ( Observation observation,
Sequence[Image] morphs,
Image | None model = None ) 
Fit the spectra of multiple components simultaneously

Parameters
----------
observation:
    The class containing the observation data.
morphs:
    The morphology of each component.
model:
    An optional model for sources that are not factorized,
    and thus will not have their spectra fit.
    This model is subtracted from the data before fitting the other
    spectra.

Returns
-------
spectra:
    The spectrum for each component, in the same order as `morphs`.

Definition at line 149 of file initialization.py.

153) -> np.ndarray:
154 """Fit the spectra of multiple components simultaneously
155
156 Parameters
157 ----------
158 observation:
159 The class containing the observation data.
160 morphs:
161 The morphology of each component.
162 model:
163 An optional model for sources that are not factorized,
164 and thus will not have their spectra fit.
165 This model is subtracted from the data before fitting the other
166 spectra.
167
168 Returns
169 -------
170 spectra:
171 The spectrum for each component, in the same order as `morphs`.
172 """
173 _bands = observation.bands
174 n_bands = len(_bands)
175 dtype = observation.images.dtype
176
177 if model is not None:
178 image = observation.images - model
179 else:
180 image = observation.images.copy()
181
182 morph_images = np.zeros((n_bands, len(morphs), image.data[0].size), dtype=dtype)
183 for idx, morph in enumerate(morphs):
184 _image = morph.repeat(observation.bands)
185 _image = Image.from_box(image.bbox, bands=image.bands).insert(_image)
186 morph_images[:, idx] = observation.convolve(_image).data.reshape(n_bands, -1)
187
188 spectra = np.zeros((len(morphs), n_bands), dtype=dtype)
189
190 for b in range(n_bands):
191 a = np.vstack(morph_images[b]).T
192 spectra[:, b] = np.linalg.lstsq(a, image[observation.bands[b]].data.flatten(), rcond=None)[0]
193 spectra[spectra < 0] = 0
194 return spectra
195
196

◆ trim_morphology()

tuple[np.ndarray, Box] lsst.scarlet.lite.initialization.trim_morphology ( np.ndarray morph,
float bg_thresh = 0,
int padding = 5 ) 
Trim the morphology up to pixels above a threshold

Parameters
----------
morph:
    The morphology to be trimmed.
bg_thresh:
    The morphology is trimmed to pixels above the threshold.
padding:
    The amount to pad each side to allow the source to grow.

Returns
-------
morph:
    The trimmed morphology
box:
    The box that contains the morphology.

Definition at line 40 of file initialization.py.

44) -> tuple[np.ndarray, Box]:
45 """Trim the morphology up to pixels above a threshold
46
47 Parameters
48 ----------
49 morph:
50 The morphology to be trimmed.
51 bg_thresh:
52 The morphology is trimmed to pixels above the threshold.
53 padding:
54 The amount to pad each side to allow the source to grow.
55
56 Returns
57 -------
58 morph:
59 The trimmed morphology
60 box:
61 The box that contains the morphology.
62 """
63 # trim morph to pixels above threshold
64 mask = morph > bg_thresh
65 morph[~mask] = 0
66 bbox = Box.from_data(morph, threshold=0).grow(padding)
67 return morph, bbox
68
69

Variable Documentation

◆ logger

lsst.scarlet.lite.initialization.logger = logging.getLogger("scarlet.lite.initialization")

Definition at line 37 of file initialization.py.

Generated on Thu May 16 2024 08:50:43 for LSST Applications by doxygen 1.10.0