LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
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 45 of file sfm.py.

Constructor & Destructor Documentation

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

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

Definition at line 59 of file sfm.py.

59 
60  def __init__(self, config, name, schema, metadata):
61  """!
62  Initialize the measurement object.
63 
64  @param[in] config An instance of this class's ConfigClass.
65  @param[in] name The string the plugin was registered with.
66  @param[in,out] schema The Source schema. New fields should be added here to
67  hold measurements produced by this plugin.
68  @param[in] metadata Plugin metadata that will be attached to the output catalog
69  """
70  BasePlugin.__init__(self, config, name)
lsst::meas::base.sfm.SingleFramePlugin.__init__
def __init__
Initialize the measurement object.
Definition: sfm.py:59

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 71 of file sfm.py.

71 
72  def measure(self, measRecord, exposure):
73  """!
74  Measure the properties of a source on a single image (single-epoch image or coadd).
75 
76  @param[in,out] measRecord lsst.afw.table.SourceRecord to be filled with outputs,
77  and from which previously-measured quantities can be
78  retreived.
79 
80  @param[in] exposure lsst.afw.image.ExposureF, containing the pixel data to
81  be measured and the associated Psf, Wcs, etc. All
82  other sources in the image will have been replaced by
83  noise according to deblender outputs.
84 
85  """
86  raise NotImplementedError()
lsst::meas::base.sfm.SingleFramePlugin.measure
def measure
Measure the properties of a source on a single image (single-epoch image or coadd).
Definition: sfm.py:71
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 87 of file sfm.py.

87 
88  def measureN(self, measCat, exposure):
89  """!
90  Measure the properties of a group of blended sources on a single image
91  (single-epoch image or coadd).
92 
93  @param[in,out] measCat lsst.afw.table.SourceCatalog to be filled with outputs,
94  and from which previously-measured quantities can be
95  retrieved, containing only the sources that should be
96  measured together in this call.
97 
98  @param[in] exposure lsst.afw.image.ExposureF, containing the pixel data to
99  be measured and the associated Psf, Wcs, etc. Sources
100  not in the blended hierarchy to be measured will have
101  been replaced with noise using deblender outputs.
102 
103  Derived classes that do not implement measureN() should just inherit this
104  disabled version. Derived classes that do implement measureN() should additionally
105  add a bool doMeasureN config field to their config class to signal that measureN-mode
106  is available.
107  """
108  raise NotImplementedError()
lsst::meas::base.sfm.SingleFramePlugin.measureN
def measureN
Measure the properties of a group of blended sources on a single image (single-epoch image or coadd)...
Definition: sfm.py:87

Member Data Documentation

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

Definition at line 57 of file sfm.py.

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

Definition at line 56 of file sfm.py.

The documentation for this class was generated from the following file:
Generated on Thu Sep 24 2015 02:29:40 for LSSTApplications by   doxygen 1.8.5