lsst.meas.base  14.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
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:

Public Member Functions

def __init__
 Initialize the measurement object. More...
 
def measure
 Measure the properties of a source on a single image (single-epoch image or coadd). More...
 
def measureN
 Measure the properties of a group of blended sources on a single image (single-epoch image or coadd). More...
 

Static Public Attributes

tuple registry = PluginRegistry(SingleFramePluginConfig)
 
 ConfigClass = SingleFramePluginConfig
 

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

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

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.

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

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

Definition at line 60 of file sfm.py.

tuple 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: