LsstSource

class lsst.meas.extensions.scarlet.LsstSource(frame, peak, observation, bgRms, bbox, thresh=1, symmetric=True, monotonic=True, centerStep=5, pointSource=False, **componentKwargs)

Bases: scarlet.source.ExtendedSource

LSST Base Source

It is most likely that a source in LSST might be slightly different than the default scarlet sources, so this class allows us to define the default initialization and update constraints for general sources in LSST images.

Attributes Summary

coord The coordinate in a ComponentTree.
frame The frame of this component
morph Numpy view of the component morphology
sed Numpy view of the component SED
shape Shape of the image (Channel, Height, Width)
step_morph
step_sed

Methods Summary

backward_prior() Use the prior to update the gradient
display_model([observation, ax, filters, Q, …])
get_flux() Get flux in every band
get_model([sed, morph, observation]) Get the model for this component.
modelToHeavy(filters[, xy0, observation, dtype]) Convert the model to a MultibandFootprint
morphToHeavy(peakSchema[, xy0]) Convert the morphology to a HeavyFootprint
update() Default update parameters for an ExtendedSource

Attributes Documentation

coord

The coordinate in a ComponentTree.

frame

The frame of this component

morph

Numpy view of the component morphology

sed

Numpy view of the component SED

shape

Shape of the image (Channel, Height, Width)

step_morph
step_sed

Methods Documentation

backward_prior()

Use the prior to update the gradient

display_model(observation=None, ax=None, filters=None, Q=10, stretch=1, show=True)
get_flux()

Get flux in every band

get_model(sed=None, morph=None, observation=None)

Get the model for this component.

Parameters:
sed: array

An sed to use in the model. If sed is None then self.sed is used.

morph: array

A morphology to use in the model. If morph is None then self.morph is used.

Returns:
model: array or tensor

(Bands, Height, Width) image of the model

modelToHeavy(filters, xy0=Point2I(0, 0), observation=None, dtype=<class 'numpy.float32'>)

Convert the model to a MultibandFootprint

morphToHeavy(peakSchema, xy0=Point2I(0, 0))

Convert the morphology to a HeavyFootprint

update()

Default update parameters for an ExtendedSource

This method can be overwritten if a different set of constraints or update functions is desired.