LSSTApplications  19.0.0-10-g920eed2,19.0.0-11-g48a0200+2,19.0.0-18-gfc4e62b+10,19.0.0-2-g3b2f90d+2,19.0.0-2-gd671419+5,19.0.0-20-g5a5a17ab+8,19.0.0-21-g2644856+10,19.0.0-22-gc5dc5b1+5,19.0.0-23-gdc29a50+2,19.0.0-24-g923e380+10,19.0.0-25-g6c8df7140,19.0.0-27-g567f04d+6,19.0.0-3-g2b32d65+5,19.0.0-3-g8227491+9,19.0.0-3-g9c54d0d+9,19.0.0-3-gca68e65+5,19.0.0-3-gcfc5f51+5,19.0.0-3-ge110943+8,19.0.0-3-ge74d124,19.0.0-3-gfe04aa6+10,19.0.0-4-g06f5963+5,19.0.0-4-g3d16501+10,19.0.0-4-g4a9c019+5,19.0.0-4-g5a8b323,19.0.0-4-g66397f0+1,19.0.0-4-g8278b9b+1,19.0.0-4-g8557e14,19.0.0-4-g8964aba+10,19.0.0-4-ge404a01+9,19.0.0-5-g40f3a5a,19.0.0-5-g4db63b3,19.0.0-5-gfb03ce7+10,19.0.0-6-gbaebbfb+9,19.0.0-60-gafafd468+10,19.0.0-64-gf672fef+7,19.0.0-7-g039c0b5+8,19.0.0-7-gbea9075+4,19.0.0-7-gc567de5+10,19.0.0-8-g3a3ce09+5,19.0.0-9-g463f923+9,w.2020.21
LSSTDataManagementBasePackage
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.base.sfm.SingleFramePlugin Class Reference
Inheritance diagram for lsst.meas.base.sfm.SingleFramePlugin:
lsst.meas.base.baseMeasurement.BaseMeasurementPlugin lsst.meas.base.pluginsBase.BasePlugin lsst.ip.diffim.dipoleMeasurement.ClassificationDipolePlugin lsst.meas.base.plugins.SingleFrameFPPositionPlugin lsst.meas.base.plugins.SingleFrameJacobianPlugin lsst.meas.base.plugins.SingleFramePeakCentroidPlugin lsst.meas.base.plugins.SingleFrameSkyCoordPlugin lsst.meas.base.wrappers.WrappedSingleFramePlugin lsst.meas.modelfit.cmodel.cmodelContinued.CModelSingleFramePlugin lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxSingleFramePlugin

Public Member Functions

def __init__ (self, config, name, schema, metadata, logName=None, **kwds)
 
def measure (self, measRecord, exposure)
 
def measureN (self, measCat, exposure)
 
def getExecutionOrder (cls)
 
def getLogName (self)
 
def fail (self, measRecord, error=None)
 

Static Public Member Functions

def getTransformClass ()
 

Public Attributes

 config
 
 name
 
 logName
 

Static Public Attributes

 registry = PluginRegistry(SingleFramePluginConfig)
 
 ConfigClass = SingleFramePluginConfig
 
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
 

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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 82 of file sfm.py.

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

Member Function Documentation

◆ fail()

def lsst.meas.base.pluginsBase.BasePlugin.fail (   self,
  measRecord,
  error = None 
)
inherited
Record a failure of the `measure` or `measureN` method.

Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
    Table record describing the source being measured.
error : `MeasurementError`, optional
    Only provided if the measurement failed due to a
    `MeasurementError` being raised; otherwise, will be `None`.

Notes
-----
When the plugin raises an exception, framework will call
`BasePlugin.fail` to allow the plugin to set its failure flag
field(s).  When `BasePlugin.measureN` raises an exception,
`BasePlugin.fail` will be called repeatedly with all the records that
were being measured.

If the exception is an `MeasurementError`, it will be passed as the
error argument; in all other cases the error argument will be `None`,
and the failure will be logged by the measurement framework as a
warning.

Reimplemented in lsst.meas.base.plugins.SingleFrameSkyCoordPlugin, lsst.meas.base.plugins.SingleFramePeakCentroidPlugin, lsst.meas.base.wrappers.GenericPlugin, lsst.meas.base.plugins.InputCountPlugin, lsst.meas.base.plugins.VariancePlugin, lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxForcedPlugin, lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxSingleFramePlugin, lsst.meas.base.plugins.SingleFrameJacobianPlugin, lsst.meas.base.plugins.SingleFrameFPPositionPlugin, lsst.meas.modelfit.cmodel.cmodelContinued.CModelForcedPlugin, lsst.meas.base.classification.CatalogCalculationClassificationPlugin, lsst.ip.diffim.dipoleMeasurement.ClassificationDipolePlugin, lsst.meas.base.wrappers.WrappedForcedPlugin, lsst.meas.modelfit.cmodel.cmodelContinued.CModelSingleFramePlugin, lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin, and lsst.meas.base.wrappers.WrappedSingleFramePlugin.

Definition at line 137 of file pluginsBase.py.

137  def fail(self, measRecord, error=None):
138  """Record a failure of the `measure` or `measureN` method.
139 
140  Parameters
141  ----------
142  measRecord : `lsst.afw.table.SourceRecord`
143  Table record describing the source being measured.
144  error : `MeasurementError`, optional
145  Only provided if the measurement failed due to a
146  `MeasurementError` being raised; otherwise, will be `None`.
147 
148  Notes
149  -----
150  When the plugin raises an exception, framework will call
151  `BasePlugin.fail` to allow the plugin to set its failure flag
152  field(s). When `BasePlugin.measureN` raises an exception,
153  `BasePlugin.fail` will be called repeatedly with all the records that
154  were being measured.
155 
156  If the exception is an `MeasurementError`, it will be passed as the
157  error argument; in all other cases the error argument will be `None`,
158  and the failure will be logged by the measurement framework as a
159  warning.
160 
161  """
162  traceback.print_exc()
163  message = ("The algorithm '%s' thinks it cannot fail, but it did; "
164  "please report this as a bug (the full traceback is above)."
165  % (self.__class__.__name__,))
166  raise NotImplementedError(message)
167 

◆ getExecutionOrder()

def lsst.meas.base.pluginsBase.BasePlugin.getExecutionOrder (   cls)
inherited

◆ getLogName()

def lsst.meas.base.pluginsBase.BasePlugin.getLogName (   self)
inherited

Definition at line 134 of file pluginsBase.py.

134  def getLogName(self):
135  return self.logName
136 

◆ getTransformClass()

def lsst.meas.base.pluginsBase.BasePlugin.getTransformClass ( )
staticinherited
Get the measurement transformation appropriate to this plugin.

This returns a subclass of `transforms.MeasurementTransform`, which
may be instantiated with details of the algorithm configuration and
then called with information about calibration and WCS to convert from
raw measurement quantities to calibrated units. Calibrated data is
then provided in a separate output table.

Notes
-----
By default, we copy everything from the input to the output without
transformation.

Reimplemented in lsst.meas.base.plugins.ForcedPeakCentroidPlugin, and lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.

Definition at line 169 of file pluginsBase.py.

169  def getTransformClass():
170  """Get the measurement transformation appropriate to this plugin.
171 
172  This returns a subclass of `transforms.MeasurementTransform`, which
173  may be instantiated with details of the algorithm configuration and
174  then called with information about calibration and WCS to convert from
175  raw measurement quantities to calibrated units. Calibrated data is
176  then provided in a separate output table.
177 
178  Notes
179  -----
180  By default, we copy everything from the input to the output without
181  transformation.
182  """
183  return PassThroughTransform

◆ measure()

def 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.meas.base.plugins.SingleFrameSkyCoordPlugin, lsst.meas.base.plugins.SingleFramePeakCentroidPlugin, lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxSingleFramePlugin, lsst.meas.base.plugins.SingleFrameJacobianPlugin, lsst.meas.base.plugins.SingleFrameFPPositionPlugin, lsst.ip.diffim.dipoleMeasurement.ClassificationDipolePlugin, lsst.meas.modelfit.cmodel.cmodelContinued.CModelSingleFramePlugin, and lsst.meas.base.wrappers.WrappedSingleFramePlugin.

Definition at line 85 of file sfm.py.

85  def measure(self, measRecord, exposure):
86  """Measure the properties of a source on a single image.
87 
88  The image may be from a single epoch, or it may be a coadd.
89 
90  Parameters
91  ----------
92  measRecord : `lsst.afw.table.SourceRecord`
93  Record describing the object being measured. Previously-measured
94  quantities may be retrieved from here, and it will be updated
95  in-place tih the outputs of this plugin.
96  exposure : `lsst.afw.image.ExposureF`
97  The pixel data to be measured, together with the associated PSF,
98  WCS, etc. All other sources in the image should have been replaced
99  by noise according to deblender outputs.
100  """
101  raise NotImplementedError()
102 

◆ measureN()

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

103  def measureN(self, measCat, exposure):
104  """Measure the properties of blended sources on a single image.
105 
106  This operates on all members of a blend family at once. The image may
107  be from a single epoch, or it may be a coadd.
108 
109  Parameters
110  ----------
111  measCat : `lsst.afw.table.SourceCatalog`
112  Catalog describing the objects (and only those objects) being
113  measured. Previously-measured quantities will be retrieved from
114  here, and it will be updated in-place with the outputs of this
115  plugin.
116  exposure : `lsst.afw.image.ExposureF`
117  The pixel data to be measured, together with the associated PSF,
118  WCS, etc. All other sources in the image should have been replaced
119  by noise according to deblender outputs.
120 
121  Notes
122  -----
123  Derived classes that do not implement ``measureN`` should just inherit
124  this disabled version. Derived classes that do implement ``measureN``
125  should additionally add a bool doMeasureN config field to their config
126  class to signal that measureN-mode is available.
127  """
128  raise NotImplementedError()
129 
130 

Member Data Documentation

◆ APCORR_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.APCORR_ORDER = 3.0
staticinherited

Definition at line 98 of file pluginsBase.py.

◆ CENTROID_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.CENTROID_ORDER = 0.0
staticinherited

Definition at line 72 of file pluginsBase.py.

◆ config

lsst.meas.base.pluginsBase.BasePlugin.config
inherited

Definition at line 130 of file pluginsBase.py.

◆ ConfigClass

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

Definition at line 80 of file sfm.py.

◆ DEFAULT_CATALOGCALCULATION

float lsst.meas.base.pluginsBase.BasePlugin.DEFAULT_CATALOGCALCULATION = 4.0
staticinherited

Definition at line 108 of file pluginsBase.py.

◆ FLUX_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.FLUX_ORDER = 2.0
staticinherited

Definition at line 89 of file pluginsBase.py.

◆ logName

lsst.meas.base.pluginsBase.BasePlugin.logName
inherited

Definition at line 132 of file pluginsBase.py.

◆ name

lsst.meas.base.pluginsBase.BasePlugin.name
inherited

Definition at line 131 of file pluginsBase.py.

◆ registry

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

Definition at line 76 of file sfm.py.

◆ SHAPE_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.SHAPE_ORDER = 1.0
staticinherited

Definition at line 80 of file pluginsBase.py.


The documentation for this class was generated from the following file:
lsst::ip::isr.fringe.measure
def measure(mi, x, y, size, statistic, stats)
Definition: fringe.py:506