lsst.meas.base g226e1bc8dd+33f4102cff
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.base.plugins.ForcedTransformedCentroidPlugin Class Reference
Inheritance diagram for lsst.meas.base.plugins.ForcedTransformedCentroidPlugin:
lsst.meas.base.forcedMeasurement.ForcedPlugin lsst.meas.base.baseMeasurement.BaseMeasurementPlugin lsst.meas.base.pluginsBase.BasePlugin lsst.meas.base.plugins.ForcedTransformedCentroidFromCoordPlugin

Public Member Functions

def getExecutionOrder (cls)
 
def __init__ (self, config, name, schemaMapper, metadata)
 
def measure (self, measRecord, exposure, refRecord, refWcs)
 

Public Attributes

 centroidKey
 
 flagKey
 

Static Public Attributes

 ConfigClass = ForcedTransformedCentroidConfig
 

Detailed Description

Record the transformation of the reference catalog centroid.

The centroid recorded in the reference catalog is tranformed to the
measurement coordinate system and stored.

Parameters
----------
config : `ForcedTransformedCentroidConfig`
    Plugin configuration
name : `str`
    Plugin name
schemaMapper : `lsst.afw.table.SchemaMapper`
    A mapping from reference catalog fields to output
    catalog fields. Output fields are added to the output schema.
metadata : `lsst.daf.base.PropertySet`
    Plugin metadata that will be attached to the output catalog.

Notes
-----
This is used as the slot centroid by default in forced measurement,
allowing subsequent measurements to simply refer to the slot value just as
they would in single-frame measurement.

Definition at line 711 of file plugins.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.base.plugins.ForcedTransformedCentroidPlugin.__init__ (   self,
  config,
  name,
  schemaMapper,
  metadata 
)

Reimplemented from lsst.meas.base.forcedMeasurement.ForcedPlugin.

Definition at line 742 of file plugins.py.

Member Function Documentation

◆ getExecutionOrder()

def lsst.meas.base.plugins.ForcedTransformedCentroidPlugin.getExecutionOrder (   cls)
Get the relative execution order of this plugin.

Must be reimplemented as a class method by concrete derived classes.

Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.

Definition at line 739 of file plugins.py.

◆ measure()

def lsst.meas.base.plugins.ForcedTransformedCentroidPlugin.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 from lsst.meas.base.forcedMeasurement.ForcedPlugin.

Reimplemented in lsst.meas.base.plugins.ForcedTransformedCentroidFromCoordPlugin.

Definition at line 760 of file plugins.py.

Member Data Documentation

◆ centroidKey

lsst.meas.base.plugins.ForcedTransformedCentroidPlugin.centroidKey

Definition at line 750 of file plugins.py.

◆ ConfigClass

lsst.meas.base.plugins.ForcedTransformedCentroidPlugin.ConfigClass = ForcedTransformedCentroidConfig
static

Definition at line 736 of file plugins.py.

◆ flagKey

lsst.meas.base.plugins.ForcedTransformedCentroidPlugin.flagKey

Definition at line 755 of file plugins.py.


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