ExtendedPsfSubtractTask#
- class lsst.pipe.tasks.extended_psf.ExtendedPsfSubtractTask(initInputs=None, *args, **kwargs)#
Bases:
PipelineTaskSubtract a fitted extended PSF model from stars in a detector image.
Methods Summary
run(preliminary_visit_image, extended_psf, ...)Subtract fitted extended-PSF models from selected stars.
runQuantum(butlerQC, inputRefs, outputRefs)Do butler IO and transform to provide in memory objects for tasks
runmethod.Methods Documentation
- run(preliminary_visit_image: ExposureF, extended_psf: ExtendedPsfImage, ref_obj_loader: ReferenceObjectLoader, preliminary_visit_image_background: BackgroundList | None = None)#
Subtract fitted extended-PSF models from selected stars.
This method clones the input exposure, optionally restores the associated background model for fitting, selects subtraction stars from the reference catalog, and fits/subtracts the warped extended-PSF model for each star in sequence. Stars are always processed in magnitude order from brightest to faintest, and
max_stars_per_detector(if non-zero) is applied after sorting so only the brightest stars are retained. After per-star subtraction, the method optionally re-estimates the background model. When re-estimation is enabled, both updated exposure and background outputs are returned.Parameters#
- preliminary_visit_image
lsst.afw.image.ExposureF Background-subtracted image.
- extended_psf
ExtendedPsfImage Extended PSF model to be warped and fit per star.
- ref_obj_loader
lsst.meas.algorithms.ReferenceObjectLoader Reference object loader used for star selection.
- preliminary_visit_image_background :
lsst.afw.math.BackgroundList, optional Supplied input background model associated with the input image. This is restored onto the working exposure whendo_restore_backgroundis True.
- preliminary_visit_image
- runQuantum(butlerQC, inputRefs, outputRefs)#
Do butler IO and transform to provide in memory objects for tasks
runmethod.Parameters#
- butlerQC
QuantumContext A butler which is specialized to operate in the context of a
lsst.daf.butler.Quantum.- inputRefs
InputQuantizedConnection Datastructure whose attribute names are the names that identify connections defined in corresponding
PipelineTaskConnectionsclass. The values of these attributes are thelsst.daf.butler.DatasetRefobjects associated with the defined input/prerequisite connections.- outputRefs
OutputQuantizedConnection Datastructure whose attribute names are the names that identify connections defined in corresponding
PipelineTaskConnectionsclass. The values of these attributes are thelsst.daf.butler.DatasetRefobjects associated with the defined output connections.
- butlerQC