LSSTApplications  19.0.0-10-g920eed2,19.0.0-11-g48a0200+2,19.0.0-18-gfc4e62b+11,19.0.0-2-g3b2f90d+2,19.0.0-2-gd671419+5,19.0.0-20-g5a5a17ab+9,19.0.0-21-g2644856+11,19.0.0-22-gc5dc5b1+6,19.0.0-23-gdc29a50+3,19.0.0-24-g923e380+11,19.0.0-25-g6c8df7140,19.0.0-28-g9b887e2,19.0.0-3-g2b32d65+5,19.0.0-3-g8227491+10,19.0.0-3-g9c54d0d+10,19.0.0-3-gca68e65+6,19.0.0-3-gcfc5f51+5,19.0.0-3-ge110943+9,19.0.0-3-ge74d124,19.0.0-3-gfe04aa6+11,19.0.0-4-g06f5963+5,19.0.0-4-g3d16501+11,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+11,19.0.0-4-ge404a01+10,19.0.0-5-g40f3a5a,19.0.0-5-g4db63b3,19.0.0-5-gfb03ce7+11,19.0.0-6-gbaebbfb+10,19.0.0-60-gafafd468+11,19.0.0-67-g3ab1e6e,19.0.0-7-g039c0b5+9,19.0.0-7-gbea9075+4,19.0.0-7-gc567de5+11,19.0.0-8-g3a3ce09+6,19.0.0-9-g463f923+10,w.2020.21
LSSTDataManagementBasePackage
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.base.forcedMeasurement.ForcedPlugin Class Reference
Inheritance diagram for lsst.meas.base.forcedMeasurement.ForcedPlugin:
lsst.meas.base.baseMeasurement.BaseMeasurementPlugin lsst.meas.base.pluginsBase.BasePlugin lsst.meas.base.plugins.ForcedPeakCentroidPlugin lsst.meas.base.plugins.ForcedTransformedCentroidPlugin lsst.meas.base.plugins.ForcedTransformedShapePlugin lsst.meas.base.wrappers.WrappedForcedPlugin lsst.meas.modelfit.cmodel.cmodelContinued.CModelForcedPlugin lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxForcedPlugin

Public Member Functions

def __init__ (self, config, name, schemaMapper, metadata, logName=None)
 
def measure (self, measRecord, exposure, refRecord, refWcs)
 
def measureN (self, measCat, exposure, refCat, refWcs)
 
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(ForcedPluginConfig)
 
 ConfigClass = ForcedPluginConfig
 
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 forced measurement plugins.

Parameters
----------
config : `ForcedPlugin.ConfigClass`
    Configuration for this plugin.
name : `str`
    The string with which the plugin was registered.
schemaMapper : `lsst.afw.table.SchemaMapper`
    A mapping from reference catalog fields to output catalog fields.
    Output fields should be added to the output schema. While most plugins
    will not need to map fields from the reference schema, if they do so,
    those fields will be transferred before any plugins are run.
metadata : `lsst.daf.base.PropertySet`
    Plugin metadata that will be attached to the output catalog.
logName : `str`, optional
    Name to use when logging errors.

Definition at line 75 of file forcedMeasurement.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.base.forcedMeasurement.ForcedPlugin.__init__ (   self,
  config,
  name,
  schemaMapper,
  metadata,
  logName = None 
)

Reimplemented in lsst.meas.base.wrappers.WrappedForcedPlugin.

Definition at line 101 of file forcedMeasurement.py.

101  def __init__(self, config, name, schemaMapper, metadata, logName=None):
102  BaseMeasurementPlugin.__init__(self, config, name, logName=logName)
103 

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.forcedMeasurement.ForcedPlugin.measure (   self,
  measRecord,
  exposure,
  refRecord,
  refWcs 
)
Measure the properties of a source given an image and a reference.

Parameters
----------
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.
measRecord : `lsst.afw.table.SourceRecord`
    Record describing the object being measured. Previously-measured
    quantities will be retrieved from here, and it will be updated
    in-place with the outputs of this plugin.
refRecord : `lsst.afw.table.SimpleRecord`
    Additional parameters to define the fit, as measured elsewhere.
refWcs : `lsst.afw.geom.SkyWcs` or `lsst.afw.geom.Angle`
    The coordinate system for the reference catalog values. An
    `~lsst.geom.Angle` may be passed, indicating that a local tangent
    WCS should be created for each object using the given angle as a
    pixel scale.

Notes
-----
In the normal mode of operation, the source centroid will be set to
the WCS-transformed position of the reference object, so plugins that
only require a reference position should not have to access the
reference object at all.

Reimplemented in lsst.meas.base.plugins.ForcedTransformedShapePlugin, lsst.meas.base.plugins.ForcedTransformedCentroidPlugin, lsst.meas.base.plugins.ForcedPeakCentroidPlugin, lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxForcedPlugin, lsst.meas.modelfit.cmodel.cmodelContinued.CModelForcedPlugin, and lsst.meas.base.wrappers.WrappedForcedPlugin.

Definition at line 104 of file forcedMeasurement.py.

104  def measure(self, measRecord, exposure, refRecord, refWcs):
105  """Measure the properties of a source given an image and a reference.
106 
107  Parameters
108  ----------
109  exposure : `lsst.afw.image.ExposureF`
110  The pixel data to be measured, together with the associated PSF,
111  WCS, etc. All other sources in the image should have been replaced
112  by noise according to deblender outputs.
113  measRecord : `lsst.afw.table.SourceRecord`
114  Record describing the object being measured. Previously-measured
115  quantities will be retrieved from here, and it will be updated
116  in-place with the outputs of this plugin.
117  refRecord : `lsst.afw.table.SimpleRecord`
118  Additional parameters to define the fit, as measured elsewhere.
119  refWcs : `lsst.afw.geom.SkyWcs` or `lsst.afw.geom.Angle`
120  The coordinate system for the reference catalog values. An
121  `~lsst.geom.Angle` may be passed, indicating that a local tangent
122  WCS should be created for each object using the given angle as a
123  pixel scale.
124 
125  Notes
126  -----
127  In the normal mode of operation, the source centroid will be set to
128  the WCS-transformed position of the reference object, so plugins that
129  only require a reference position should not have to access the
130  reference object at all.
131  """
132  raise NotImplementedError()
133 

◆ measureN()

def lsst.meas.base.forcedMeasurement.ForcedPlugin.measureN (   self,
  measCat,
  exposure,
  refCat,
  refWcs 
)
Measure the properties of blended sources from image & reference.

This operates on all members of a blend family at once.

Parameters
----------
exposure : `lsst.afw.image.ExposureF`
    The pixel data to be measured, together with the associated PSF,
    WCS, etc. Sources not in the blended hierarchy to be measured
    should have been replaced with noise using deblender outputs.
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.
refCat : `lsst.afw.table.SimpleCatalog`
    Additional parameters to define the fit, as measured elsewhere.
    Ordered such that ``zip(measCat, refcat)`` may be used.
refWcs : `lsst.afw.geom.SkyWcs` or `lsst.afw.geom.Angle`
    The coordinate system for the reference catalog values. An
    `~lsst.geom.Angle` may be passed, indicating that a local tangent
    WCS should be created for each object using the given angle as a
    pixel scale.

Notes
-----
In the normal mode of operation, the source centroids will be set to
the WCS-transformed position of the reference object, so plugins that
only require a reference position should not have to access the
reference object at all.

Reimplemented in lsst.meas.base.wrappers.WrappedForcedPlugin.

Definition at line 134 of file forcedMeasurement.py.

134  def measureN(self, measCat, exposure, refCat, refWcs):
135  """Measure the properties of blended sources from image & reference.
136 
137  This operates on all members of a blend family at once.
138 
139  Parameters
140  ----------
141  exposure : `lsst.afw.image.ExposureF`
142  The pixel data to be measured, together with the associated PSF,
143  WCS, etc. Sources not in the blended hierarchy to be measured
144  should have been replaced with noise using deblender outputs.
145  measCat : `lsst.afw.table.SourceCatalog`
146  Catalog describing the objects (and only those objects) being
147  measured. Previously-measured quantities will be retrieved from
148  here, and it will be updated in-place with the outputs of this
149  plugin.
150  refCat : `lsst.afw.table.SimpleCatalog`
151  Additional parameters to define the fit, as measured elsewhere.
152  Ordered such that ``zip(measCat, refcat)`` may be used.
153  refWcs : `lsst.afw.geom.SkyWcs` or `lsst.afw.geom.Angle`
154  The coordinate system for the reference catalog values. An
155  `~lsst.geom.Angle` may be passed, indicating that a local tangent
156  WCS should be created for each object using the given angle as a
157  pixel scale.
158 
159  Notes
160  -----
161  In the normal mode of operation, the source centroids will be set to
162  the WCS-transformed position of the reference object, so plugins that
163  only require a reference position should not have to access the
164  reference object at all.
165  """
166  raise NotImplementedError()
167 
168 

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.forcedMeasurement.ForcedPlugin.ConfigClass = ForcedPluginConfig
static

Definition at line 99 of file forcedMeasurement.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.forcedMeasurement.ForcedPlugin.registry = PluginRegistry(ForcedPluginConfig)
static

Definition at line 95 of file forcedMeasurement.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