lsst.meas.base  13.0-26-g0f127ff+5
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.base.sfm.SingleFramePlugin Class Reference

Base class for single-frame plugin algorithms. More...

Inheritance diagram for lsst.meas.base.sfm.SingleFramePlugin:
lsst.meas.base.baseMeasurement.BaseMeasurementPlugin lsst.meas.base.pluginsBase.BasePlugin lsst.meas.base.plugins.SingleFrameFPPositionPlugin lsst.meas.base.plugins.SingleFrameInputCountPlugin lsst.meas.base.plugins.SingleFrameJacobianPlugin lsst.meas.base.plugins.SingleFramePeakCentroidPlugin lsst.meas.base.plugins.SingleFrameSkyCoordPlugin lsst.meas.base.plugins.SingleFrameVariancePlugin lsst.meas.base.wrappers.WrappedSingleFramePlugin

Public Member Functions

def __init__ (self, config, name, schema, metadata, logName=None, kwds)
 Initialize the measurement object. More...
 
def measure (self, measRecord, exposure)
 Measure the properties of a source on a single image (single-epoch image or coadd). More...
 
def measureN (self, measCat, exposure)
 Measure the properties of a group of blended sources on a single image (single-epoch image or coadd). More...
 
- Public Member Functions inherited from lsst.meas.base.pluginsBase.BasePlugin
def getExecutionOrder (cls)
 
def __init__ (self, config, name, logName=None)
 Initialize the plugin object. More...
 
def getLogName (self)
 
def fail (self, measRecord, error=None)
 Record a failure of the measure or measureN() method. More...
 

Static Public Attributes

 registry = PluginRegistry(SingleFramePluginConfig)
 
 ConfigClass = SingleFramePluginConfig
 
- Static Public Attributes inherited from lsst.meas.base.pluginsBase.BasePlugin
float CENTROID_ORDER = 0.0
 
float SHAPE_ORDER = 1.0
 
float FLUX_ORDER = 2.0
 
float APCORR_ORDER = 3.0
 
float DEFAULT_CATALOGCALCULATION = 4.0
 

Additional Inherited Members

- Static Public Member Functions inherited from lsst.meas.base.pluginsBase.BasePlugin
def getTransformClass ()
 Get the measurement transformation appropriate to this plugin. More...
 
- Public Attributes inherited from lsst.meas.base.pluginsBase.BasePlugin
 config
 
 name
 
 logName
 

Detailed Description

Base class for single-frame plugin algorithms.

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

Definition at line 48 of file sfm.py.

Constructor & Destructor Documentation

◆ __init__()

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

Initialize the measurement object.

Parameters
[in]configAn instance of this class's ConfigClass.
[in]nameThe string the plugin was registered with.
[in,out]schemaThe Source schema. New fields should be added here to hold measurements produced by this plugin.
[in]metadataPlugin metadata that will be attached to the output catalog
[in]logNameMay include logName to use for this plugin

Definition at line 62 of file sfm.py.

Member Function Documentation

◆ measure()

def lsst.meas.base.sfm.SingleFramePlugin.measure (   self,
  measRecord,
  exposure 
)

Measure the properties of a source on a single image (single-epoch image or coadd).

Parameters
[in,out]measRecordlsst.afw.table.SourceRecord to be filled with outputs, and from which previously-measured quantities can be retreived.
[in]exposurelsst.afw.image.ExposureF, containing the pixel data to be measured and the associated Psf, Wcs, etc. All other sources in the image will have been replaced by noise according to deblender outputs.

Definition at line 75 of file sfm.py.

◆ measureN()

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

Measure the properties of a group of blended sources on a single image (single-epoch image or coadd).

Parameters
[in,out]measCatlsst.afw.table.SourceCatalog to be filled with outputs, and from which previously-measured quantities can be retrieved, containing only the sources that should be measured together in this call.
[in]exposurelsst.afw.image.ExposureF, containing the pixel data to be measured and the associated Psf, Wcs, etc. Sources not in the blended hierarchy to be measured will have been replaced with noise using deblender outputs.

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.

Definition at line 91 of file sfm.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 60 of file sfm.py.

◆ registry

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

Definition at line 59 of file sfm.py.


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