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

Public Member Functions
	__init__ (self, config, name, schema, metadata, logName=None, **kwds)

	measure (self, measRecord, exposure)

	measureN (self, measCat, exposure)

Static Public Attributes
	registry = PluginRegistry(SingleFramePluginConfig)

	ConfigClass = SingleFramePluginConfig

Detailed Description

Base class for single-frame measurement plugin.

Parameters
----------
config : `SingleFramePlugin.ConfigClass`
    Configuration for this plugin.
name : `str`
    The string with which the plugin was registered.
schema : `lsst.afw.table.Schema`
    The schema for the source table . New fields are added here to
    hold measurements produced by this plugin.
metadata : `lsst.daf.base.PropertySet`
    Plugin metadata that will be attached to the output catalog
logName : `str`, 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.

Definition at line 52 of file sfm.py.

Constructor & Destructor Documentation

◆ init()

lsst.meas.base.sfm.SingleFramePlugin.__init__	(		self,
			config,
			name,
			schema,
			metadata,
			logName = None,
		**	kwds )

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

Reimplemented in lsst.ip.diffim.dipoleMeasurement.ClassificationDipolePlugin, lsst.meas.base.plugins.SingleFrameFPPositionPlugin, lsst.meas.base.plugins.SingleFrameJacobianPlugin, lsst.meas.base.plugins.SingleFramePeakCentroidPlugin, lsst.meas.base.plugins.SingleFrameMomentsClassifierPlugin, lsst.meas.modelfit.cmodel.cmodelContinued.CModelSingleFramePlugin, lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxSingleFramePlugin, lsst.meas.base.wrappers.WrappedSingleFramePlugin, lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin, lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin, and lsst.meas.base.compensatedGaussian._compensatedGaussian.SingleFrameCompensatedGaussianFluxPlugin.

Definition at line 83 of file sfm.py.

    def __init__(self, config, name, schema, metadata, logName=None, **kwds):
        BaseMeasurementPlugin.__init__(self, config, name, logName=logName)
 

Member Function Documentation

◆ measure()

lsst.meas.base.sfm.SingleFramePlugin.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 in lsst.ip.diffim.dipoleMeasurement.ClassificationDipolePlugin, lsst.meas.base.compensatedGaussian._compensatedGaussian.SingleFrameCompensatedGaussianFluxPlugin, lsst.meas.base.plugins.SingleFrameFPPositionPlugin, lsst.meas.base.plugins.SingleFrameJacobianPlugin, lsst.meas.base.plugins.SingleFramePeakCentroidPlugin, lsst.meas.base.plugins.SingleFrameSkyCoordPlugin, lsst.meas.base.plugins.SingleFrameMomentsClassifierPlugin, lsst.meas.base.wrappers.WrappedSingleFramePlugin, lsst.meas.extensions.trailedSources.NaivePlugin.SingleFrameNaiveTrailPlugin, lsst.meas.extensions.trailedSources.VeresPlugin.SingleFrameVeresTrailPlugin, lsst.meas.modelfit.cmodel.cmodelContinued.CModelSingleFramePlugin, and lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxSingleFramePlugin.

Definition at line 86 of file sfm.py.

    def 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.
        """
        raise NotImplementedError()
 

◆ measureN()

lsst.meas.base.sfm.SingleFramePlugin.measureN	(	self,
		measCat,
		exposure )

Measure the properties of blended sources on a single image.

This operates on all members of a blend family at once. The image may
be from a single epoch, or it may be a coadd.

Parameters
----------
measCat : `lsst.afw.table.SourceCatalog`
    Catalog describing the objects (and only those objects) being
    measured. Previously-measured quantities will be retrieved from
    here, and it will be updated in-place with 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.

Notes
-----
Derived classes that do not implement ``measureN`` should just inherit
this disabled version.  Derived classes that do implement ``measureN``
should additionally add a bool doMeasureN config field to their config
class to signal that measureN-mode is available.

Reimplemented in lsst.meas.base.wrappers.WrappedSingleFramePlugin.

Definition at line 104 of file sfm.py.

    def measureN(self, measCat, exposure):
        """Measure the properties of blended sources on a single image.
 
        This operates on all members of a blend family at once. The image may
        be from a single epoch, or it may be a coadd.
 
        Parameters
        ----------
        measCat : `lsst.afw.table.SourceCatalog`
            Catalog describing the objects (and only those objects) being
            measured. Previously-measured quantities will be retrieved from
            here, and it will be updated in-place with 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.
 
        Notes
        -----
        Derived classes that do not implement ``measureN`` should just inherit
        this disabled version.  Derived classes that do implement ``measureN``
        should additionally add a bool doMeasureN config field to their config
        class to signal that measureN-mode is available.
        """
        raise NotImplementedError()
 
 

Member Data Documentation

◆ ConfigClass

lsst.meas.base.sfm.SingleFramePlugin.ConfigClass = SingleFramePluginConfig

static

Definition at line 81 of file sfm.py.

◆ registry

lsst.meas.base.sfm.SingleFramePlugin.registry = PluginRegistry(SingleFramePluginConfig)

static

Definition at line 77 of file sfm.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/sfm.py

Public Member Functions

Static Public Attributes