SingleFrameMeasurementTask#

class lsst.meas.base.SingleFrameMeasurementTask(schema, algMetadata=None, **kwds)#

A subtask for measuring the properties of sources on a single exposure.

Parameters#

schemalsst.afw.table.Schema: Schema of the output resultant catalog. Will be updated to provide fields to accept the outputs of plugins which will be executed by this task.
algMetadatalsst.daf.base.PropertyList, optional: Used to record metadaa about algorithm execution. An empty lsst.daf.base.PropertyList will be created if None.
**kwds: Keyword arguments forwarded to BaseMeasurementTask.

Methods Summary

`measure`(measCat, exposure)	Backwards-compatibility alias for `run`.
`run`(measCat, exposure[, noiseImage, ...])	Run single frame measurement over an exposure and source catalog.
`runPlugins`(noiseReplacer, measCat, exposure)	Call the configured measument plugins on an image.

Methods Documentation

run(measCat, exposure, noiseImage=None, exposureId=None, beginOrder=None, endOrder=None, footprints=None)#

Run single frame measurement over an exposure and source catalog.

measCatlsst.afw.table.SourceCatalog: Catalog to be filled with the results of measurement. Must contain all the lsst.afw.table.SourceRecords to be measured (with lsst.afw.detection.Footprints attached), and have a schema that is a superset of self.schema.
exposurelsst.afw.image.ExposureF: Image containing the pixel data to be measured together with associated PSF, WCS, etc.
noiseImagelsst.afw.image.ImageF, optional: Can be used to specify the a predictable noise replacement field for testing purposes.
exposureIdint, optional: Unique exposure identifier used to calculate the random number generator seed during noise replacement.
beginOrderfloat, optional: Start execution order (inclusive): measurements with executionOrder < beginOrder are not executed. None for no limit.
endOrderfloat, optional: Final execution order (exclusive): measurements with executionOrder >= endOrder are not executed. None for no limit.
footprintsdict {int: lsst.afw.detection.Footprint}, optional: List of footprints to use for noise replacement. If this is not supplied then the footprints from the measCat are used.

runPlugins(noiseReplacer, measCat, exposure, beginOrder=None, endOrder=None)#

Call the configured measument plugins on an image.

noiseReplacerNoiseReplacer: Used to fill sources not being measured with noise.
measCatlsst.afw.table.SourceCatalog: Catalog to be filled with the results of measurement. Must contain all the lsst.afw.table.SourceRecords to be measured (with lsst.afw.detection.Footprints attached), and have a schema that is a superset of self.schema.
exposurelsst.afw.image.ExposureF: Image containing the pixel data to be measured together with associated PSF, WCS, etc.
beginOrderfloat, optional: Start execution order (inclusive): measurements with executionOrder < beginOrder are not executed. None for no limit.
endOrderfloat, optional: Final execution order (exclusive): measurements with executionOrder >= endOrder are not executed. None for no limit.