lsst.meas.base.sfm.SingleFrameMeasurementTask Class Reference

Inheritance diagram for lsst.meas.base.sfm.SingleFrameMeasurementTask:

Public Member Functions
	__init__ (self, schema, algMetadata=None, **kwds)
	run (self, measCat, exposure, noiseImage=None, exposureId=None, beginOrder=None, endOrder=None, footprints=None)
	runPlugins (self, noiseReplacer, measCat, exposure, beginOrder=None, endOrder=None)
	measure (self, measCat, exposure)

Public Attributes
	schema
	plugins
	doBlendedness
	blendPlugin
	NOISE_SEED_MULTIPLIER
	NOISE_SOURCE
	NOISE_OFFSET
	NOISE_EXPOSURE_ID

Static Public Attributes
	ConfigClass = SingleFrameMeasurementConfig
str	NOISE_SEED_MULTIPLIER = "NOISE_SEED_MULTIPLIER"
str	NOISE_SOURCE = "NOISE_SOURCE"
str	NOISE_OFFSET = "NOISE_OFFSET"
str	NOISE_EXPOSURE_ID = "NOISE_EXPOSURE_ID"

Detailed Description

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

Parameters
----------
schema : `lsst.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.
algMetadata : `lsst.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`.

Definition at line 161 of file sfm.py.

Constructor & Destructor Documentation

__init__()

lsst.meas.base.sfm.SingleFrameMeasurementTask.__init__	(		self,
			schema,
			algMetadata = None,
		**	kwds )

Reimplemented from lsst.meas.base.baseMeasurement.BaseMeasurementTask.

Definition at line 195 of file sfm.py.

    def __init__(self, schema, algMetadata=None, **kwds):
        super(SingleFrameMeasurementTask, self).__init__(algMetadata=algMetadata, **kwds)
        self.schema = schema
        self.config.slots.setupSchema(self.schema)
        self.initializePlugins(schema=self.schema)
 
        # Check to see if blendedness is one of the plugins
        if 'base_Blendedness' in self.plugins:
            self.doBlendedness = True
            self.blendPlugin = self.plugins['base_Blendedness']
        else:
            self.doBlendedness = False
 

Member Function Documentation

measure()

lsst.meas.base.sfm.SingleFrameMeasurementTask.measure	(		self,
			measCat,
			exposure )

Backwards-compatibility alias for `run`.

Definition at line 361 of file sfm.py.

    def measure(self, measCat, exposure):
        """Backwards-compatibility alias for `run`.
        """
        self.run(measCat, exposure)

run()

lsst.meas.base.sfm.SingleFrameMeasurementTask.run	(		self,
			measCat,
			exposure,
			noiseImage = None,
			exposureId = None,
			beginOrder = None,
			endOrder = None,
			footprints = None )

Run single frame measurement over an exposure and source catalog.

    Parameters
    ----------
    measCat : `lsst.afw.table.SourceCatalog`
        Catalog to be filled with the results of measurement. Must contain
        all the `lsst.afw.table.SourceRecord`\ s to be measured (with
        `lsst.afw.detection.Footprint`\ s attached), and have a schema
        that is a superset of ``self.schema``.
    exposure : `lsst.afw.image.ExposureF`
        Image containing the pixel data to be measured together with
        associated PSF, WCS, etc.
    noiseImage : `lsst.afw.image.ImageF`, optional
        Can be used to specify the a predictable noise replacement field
        for testing purposes.
    exposureId : `int`, optional
        Unique exposure identifier used to calculate the random number
        generator seed during noise replacement.
    beginOrder : `float`, optional
        Start execution order (inclusive): measurements with
        ``executionOrder < beginOrder`` are not executed. `None` for no
        limit.
    endOrder : `float`, optional
        Final execution order (exclusive): measurements with
        ``executionOrder >= endOrder`` are not executed. `None` for no
        limit.
    footprints : `dict` {`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.

Definition at line 209 of file sfm.py.

    ):
        r"""Run single frame measurement over an exposure and source catalog.
 
        Parameters
        ----------
        measCat : `lsst.afw.table.SourceCatalog`
            Catalog to be filled with the results of measurement. Must contain
            all the `lsst.afw.table.SourceRecord`\ s to be measured (with
            `lsst.afw.detection.Footprint`\ s attached), and have a schema
            that is a superset of ``self.schema``.
        exposure : `lsst.afw.image.ExposureF`
            Image containing the pixel data to be measured together with
            associated PSF, WCS, etc.
        noiseImage : `lsst.afw.image.ImageF`, optional
            Can be used to specify the a predictable noise replacement field
            for testing purposes.
        exposureId : `int`, optional
            Unique exposure identifier used to calculate the random number
            generator seed during noise replacement.
        beginOrder : `float`, optional
            Start execution order (inclusive): measurements with
            ``executionOrder < beginOrder`` are not executed. `None` for no
            limit.
        endOrder : `float`, optional
            Final execution order (exclusive): measurements with
            ``executionOrder >= endOrder`` are not executed. `None` for no
            limit.
        footprints : `dict` {`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.
        """
        assert measCat.getSchema().contains(self.schema)
        if footprints is None:
            footprints = self.getFootprintsFromCatalog(measCat)
 
        # noiseReplacer is used to fill the footprints with noise and save
        # heavy footprints of the source pixels so that they can be restored
        # one at a time for measurement.  After the NoiseReplacer is
        # constructed, all pixels in the exposure.getMaskedImage() which
        # belong to objects in measCat will be replaced with noise
 
        if self.config.doReplaceWithNoise:
            noiseReplacer = NoiseReplacer(self.config.noiseReplacer, exposure, footprints,
                                          noiseImage=noiseImage, log=self.log, exposureId=exposureId)
            algMetadata = measCat.getMetadata()
            if algMetadata is not None:
                algMetadata.addInt(self.NOISE_SEED_MULTIPLIER, self.config.noiseReplacer.noiseSeedMultiplier)
                algMetadata.addString(self.NOISE_SOURCE, self.config.noiseReplacer.noiseSource)
                algMetadata.addDouble(self.NOISE_OFFSET, self.config.noiseReplacer.noiseOffset)
                if exposureId is not None:
                    algMetadata.addLong(self.NOISE_EXPOSURE_ID, exposureId)
        else:
            noiseReplacer = DummyNoiseReplacer()
 
        self.runPlugins(noiseReplacer, measCat, exposure, beginOrder, endOrder)
 

runPlugins()

lsst.meas.base.sfm.SingleFrameMeasurementTask.runPlugins	(		self,
			noiseReplacer,
			measCat,
			exposure,
			beginOrder = None,
			endOrder = None )

Call the configured measument plugins on an image.

Parameters
----------
noiseReplacer : `NoiseReplacer`
    Used to fill sources not being measured with noise.
measCat : `lsst.afw.table.SourceCatalog`
    Catalog to be filled with the results of measurement. Must contain
    all the `lsst.afw.table.SourceRecord`\ s to be measured (with
    `lsst.afw.detection.Footprint`\ s attached), and have a schema
    that is a superset of ``self.schema``.
exposure : `lsst.afw.image.ExposureF`
    Image containing the pixel data to be measured together with
    associated PSF, WCS, etc.
beginOrder : `float`, optional
    Start execution order (inclusive): measurements with
    ``executionOrder < beginOrder`` are not executed. `None` for no
    limit.
endOrder : `float`, optional
    Final execution order (exclusive): measurements with
    ``executionOrder >= endOrder`` are not executed. `None` for no
    limit.

Definition at line 274 of file sfm.py.

    def runPlugins(self, noiseReplacer, measCat, exposure, beginOrder=None, endOrder=None):
        r"""Call the configured measument plugins on an image.
 
        Parameters
        ----------
        noiseReplacer : `NoiseReplacer`
            Used to fill sources not being measured with noise.
        measCat : `lsst.afw.table.SourceCatalog`
            Catalog to be filled with the results of measurement. Must contain
            all the `lsst.afw.table.SourceRecord`\ s to be measured (with
            `lsst.afw.detection.Footprint`\ s attached), and have a schema
            that is a superset of ``self.schema``.
        exposure : `lsst.afw.image.ExposureF`
            Image containing the pixel data to be measured together with
            associated PSF, WCS, etc.
        beginOrder : `float`, optional
            Start execution order (inclusive): measurements with
            ``executionOrder < beginOrder`` are not executed. `None` for no
            limit.
        endOrder : `float`, optional
            Final execution order (exclusive): measurements with
            ``executionOrder >= endOrder`` are not executed. `None` for no
            limit.
        """
        # First, create a catalog of all parentless sources. Loop through all
        # the parent sources, first processing the children, then the parent.
        measParentCat = measCat.getChildren(0)
 
        nMeasCat = len(measCat)
        nMeasParentCat = len(measParentCat)
        self.log.info("Measuring %d source%s (%d parent%s, %d child%s) ",
                      nMeasCat, ("" if nMeasCat == 1 else "s"),
                      nMeasParentCat, ("" if nMeasParentCat == 1 else "s"),
                      nMeasCat - nMeasParentCat, ("" if nMeasCat - nMeasParentCat == 1 else "ren"))
 
        # Wrap the task logger into a period logger
        periodicLog = PeriodicLogger(self.log)
 
        childrenIter = measCat.getChildren([measParentRecord.getId() for measParentRecord in measParentCat])
        for parentIdx, (measParentRecord, measChildCat) in enumerate(zip(measParentCat, childrenIter)):
            # first get all the children of this parent, insert footprint in
            # turn, and measure
            # TODO: skip this loop if there are no plugins configured for
            # single-object mode
            for measChildRecord in measChildCat:
                noiseReplacer.insertSource(measChildRecord.getId())
                self.callMeasure(measChildRecord, exposure, beginOrder=beginOrder, endOrder=endOrder)
 
                if self.doBlendedness:
                    self.blendPlugin.cpp.measureChildPixels(exposure.getMaskedImage(), measChildRecord)
 
                noiseReplacer.removeSource(measChildRecord.getId())
 
            # Then insert the parent footprint, and measure that
            noiseReplacer.insertSource(measParentRecord.getId())
            self.callMeasure(measParentRecord, exposure, beginOrder=beginOrder, endOrder=endOrder)
 
            if self.doBlendedness:
                self.blendPlugin.cpp.measureChildPixels(exposure.getMaskedImage(), measParentRecord)
 
            # Finally, process both parent and child set through measureN
            self.callMeasureN(measParentCat[parentIdx:parentIdx+1], exposure,
                              beginOrder=beginOrder, endOrder=endOrder)
            self.callMeasureN(measChildCat, exposure, beginOrder=beginOrder, endOrder=endOrder)
            noiseReplacer.removeSource(measParentRecord.getId())
            # Log a message if it has been a while since the last log.
            periodicLog.log("Measurement complete for %d parents (and their children) out of %d",
                            parentIdx + 1, nMeasParentCat)
 
        # When done, restore the exposure to its original state
        noiseReplacer.end()
 
        # Undeblended plugins only fire if we're running everything
        if endOrder is None:
            for sourceIndex, source in enumerate(measCat):
                for plugin in self.undeblendedPlugins.iter():
                    self.doMeasurement(plugin, source, exposure)
                # Log a message if it has been a while since the last log.
                periodicLog.log("Undeblended measurement complete for %d sources out of %d",
                                sourceIndex + 1, nMeasCat)
 
        # Now we loop over all of the sources one more time to compute the
        # blendedness metrics
        if self.doBlendedness:
            for source in measCat:
                self.blendPlugin.cpp.measureParentPixels(exposure.getMaskedImage(), source)
 

Member Data Documentation

blendPlugin

lsst.meas.base.sfm.SingleFrameMeasurementTask.blendPlugin

Definition at line 204 of file sfm.py.

ConfigClass

lsst.meas.base.sfm.SingleFrameMeasurementTask.ConfigClass = SingleFrameMeasurementConfig

static

Definition at line 177 of file sfm.py.

doBlendedness

lsst.meas.base.sfm.SingleFrameMeasurementTask.doBlendedness

Definition at line 203 of file sfm.py.

NOISE_EXPOSURE_ID [1/2]

str lsst.meas.base.sfm.SingleFrameMeasurementTask.NOISE_EXPOSURE_ID = "NOISE_EXPOSURE_ID"

static

Definition at line 191 of file sfm.py.

NOISE_EXPOSURE_ID [2/2]

lsst.meas.base.sfm.SingleFrameMeasurementTask.NOISE_EXPOSURE_ID

Definition at line 268 of file sfm.py.

NOISE_OFFSET [1/2]

str lsst.meas.base.sfm.SingleFrameMeasurementTask.NOISE_OFFSET = "NOISE_OFFSET"

static

Definition at line 187 of file sfm.py.

NOISE_OFFSET [2/2]

lsst.meas.base.sfm.SingleFrameMeasurementTask.NOISE_OFFSET

Definition at line 266 of file sfm.py.

NOISE_SEED_MULTIPLIER [1/2]

str lsst.meas.base.sfm.SingleFrameMeasurementTask.NOISE_SEED_MULTIPLIER = "NOISE_SEED_MULTIPLIER"

static

Definition at line 179 of file sfm.py.

NOISE_SEED_MULTIPLIER [2/2]

lsst.meas.base.sfm.SingleFrameMeasurementTask.NOISE_SEED_MULTIPLIER

Definition at line 264 of file sfm.py.

NOISE_SOURCE [1/2]

str lsst.meas.base.sfm.SingleFrameMeasurementTask.NOISE_SOURCE = "NOISE_SOURCE"

static

Definition at line 183 of file sfm.py.

NOISE_SOURCE [2/2]

lsst.meas.base.sfm.SingleFrameMeasurementTask.NOISE_SOURCE

Definition at line 265 of file sfm.py.

plugins

lsst.meas.base.sfm.SingleFrameMeasurementTask.plugins

Definition at line 202 of file sfm.py.

schema

lsst.meas.base.sfm.SingleFrameMeasurementTask.schema

Definition at line 197 of file sfm.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/meas_base/gd397e13551+18f805d5e0/python/lsst/meas/base/sfm.py