lsst.meas.base.plugins.SingleFrameSkyCoordPlugin Class Reference

Inheritance diagram for lsst.meas.base.plugins.SingleFrameSkyCoordPlugin:

Public Member Functions
	getExecutionOrder (cls)
	measure (self, measRecord, exposure)
	fail (self, measRecord, error=None)

Static Public Attributes
	ConfigClass = SingleFrameSkyCoordConfig

Detailed Description

Record the sky position of an object based on its centroid slot and WCS.

The position is record in the ``coord`` field, which is part of the
`~lsst.afw.table.SourceCatalog` minimal schema.

Parameters
----------
config : `SingleFrameSkyCoordConfig`
    Plugin configuraion.
name : `str`
    Plugin name.
schema : `lsst.afw.table.Schema`
    The schema for the measurement output catalog. New fields will be
    added to hold measurements produced by this plugin.
metadata : `lsst.daf.base.PropertySet`
    Plugin metadata that will be attached to the output catalog

Definition at line 608 of file plugins.py.

Member Function Documentation

fail()

lsst.meas.base.plugins.SingleFrameSkyCoordPlugin.fail	(		self,
			measRecord,
			error = None )

Record a failure of the `measure` or `measureN` method.

Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
    Table record describing the source being measured.
error : `MeasurementError`, optional
    Only provided if the measurement failed due to a
    `MeasurementError` being raised; otherwise, will be `None`.

Notes
-----
When the plugin raises an exception, framework will call
`BasePlugin.fail` to allow the plugin to set its failure flag
field(s).  When `BasePlugin.measureN` raises an exception,
`BasePlugin.fail` will be called repeatedly with all the records that
were being measured.

If the exception is an `MeasurementError`, it will be passed as the
error argument; in all other cases the error argument will be `None`,
and the failure will be logged by the measurement framework as a
warning.

Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.

Definition at line 641 of file plugins.py.

    def fail(self, measRecord, error=None):
        # Override fail() to do nothing in the case of an exception: this is
        # not ideal, but we don't have a place to put failures because we
        # don't allocate any fields.  Should consider fixing as part of
        # DM-1011
        pass
 
 

getExecutionOrder()

lsst.meas.base.plugins.SingleFrameSkyCoordPlugin.getExecutionOrder

(

cls

)

Get the relative execution order of this plugin.

Must be reimplemented as a class method by concrete derived classes.

Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.

Definition at line 630 of file plugins.py.

    def getExecutionOrder(cls):
        return cls.SHAPE_ORDER
 

measure()

lsst.meas.base.plugins.SingleFrameSkyCoordPlugin.measure	(		self,
			measRecord,
			exposure )

Measure the properties of a source on a single image.

The image may be from a single epoch, or it may be a coadd.

Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
    Record describing the object being measured. Previously-measured
    quantities may be retrieved from here, and it will be updated
    in-place tih the outputs of this plugin.
exposure : `lsst.afw.image.ExposureF`
    The pixel data to be measured, together with the associated PSF,
    WCS, etc. All other sources in the image should have been replaced
    by noise according to deblender outputs.

Reimplemented from lsst.meas.base.sfm.SingleFramePlugin.

Definition at line 633 of file plugins.py.

    def measure(self, measRecord, exposure):
        # There should be a base class method for handling this exception. Put
        # this on a later ticket. Also, there should be a python Exception of
        # the appropriate type for this error
        if not exposure.hasWcs():
            raise RuntimeError("Wcs not attached to exposure.  Required for " + self.name + " algorithm")
        measRecord.updateCoord(exposure.getWcs())
 

Member Data Documentation

ConfigClass

lsst.meas.base.plugins.SingleFrameSkyCoordPlugin.ConfigClass = SingleFrameSkyCoordConfig

static

Definition at line 627 of file plugins.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_base/g48712c4677+f88676dd22/python/lsst/meas/base/plugins.py