SingleFramePlugin#

class lsst.meas.base.SingleFramePlugin(config, name, schema, metadata, logName=None, **kwds)#

Bases: BaseMeasurementPlugin

Base class for single-frame measurement plugin.

Parameters#

configSingleFramePlugin.ConfigClass

Configuration for this plugin.

namestr

The string with which the plugin was registered.

schemalsst.afw.table.Schema

The schema for the source table . New fields are added here to hold measurements produced by this plugin.

metadatalsst.daf.base.PropertySet

Plugin metadata that will be attached to the output catalog

logNamestr, optional

Name to use when logging errors.

Notes#

New plugins can be created in Python by inheriting directly from this class and implementing the measure, fail (from BasePlugin), and optionally __init__ and measureN methods. Plugins can also be defined in C++ via the WrappedSingleFramePlugin class.

Attributes Summary

registry

Registry of subclasses of SingleFramePlugin (PluginRegistry).

Methods Summary

measure(measRecord, exposure)

Measure the properties of a source on a single image.

Attributes Documentation

registry = <lsst.meas.base.pluginRegistry.PluginRegistry object>#

Registry of subclasses of SingleFramePlugin (PluginRegistry).

Methods Documentation

measure(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#

measRecordlsst.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.

exposurelsst.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.