BaseInjectTask

class lsst.source.injection.BaseInjectTask(*, config: PipelineTaskConfig | None = None, log: logging.Logger | LsstLogAdapter | None = None, initInputs: dict[str, Any] | None = None, **kwargs: Any)

Bases: PipelineTask

Base class for injecting sources into images.

Methods Summary

run(injection_catalogs, input_exposure[, ...])

Inject sources into an image.

Methods Documentation

run(injection_catalogs: list[Table], input_exposure: ExposureF | CellCoadd, psf: Psf | None = None, photo_calib: PhotoCalib | None = None, wcs: SkyWcs | None = None)

Inject sources into an image.

Parameters

injection_catalogslist [astropy.table.Table]

Tract level injection catalogs that potentially cover the named input exposure.

input_exposurelsst.afw.image.ExposureF or lsst.images.CellCoadd

The exposure sources will be injected into.

psf: lsst.meas.algorithms.ImagePsf

PSF model. Only required if input_exposure is an ExposureF.

photo_caliblsst.afw.image.PhotoCalib

Photometric calibration used to calibrate injected sources. Only required if input_exposure is an ExposureF.

wcslsst.afw.geom.SkyWcs

WCS used to calibrate injected sources. Only required if input_exposure is an ExposureF.

Returns

output_structlsst.pipe.base.Struct

containsoutput_exposurelsst.afw.image.ExposureF

output_catalog : lsst.afw.table.SourceCatalog