Inheritance diagram for lsst.meas.base.plugins.ForcedTransformedCentroidPlugin:

Public Member Functions
	getExecutionOrder (cls)

	__init__ (self, config, name, schemaMapper, metadata)

	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 794 of file plugins.py.

Constructor & Destructor Documentation

◆ init()

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

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

Definition at line 825 of file plugins.py.

    def __init__(self, config, name, schemaMapper, metadata):
        ForcedPlugin.__init__(self, config, name, schemaMapper, metadata)
        schema = schemaMapper.editOutputSchema()
        # Allocate x and y fields, join these into a single FunctorKey for ease-of-use.
        xKey = schema.addField(name + "_x", type="D", doc="transformed reference centroid column",
                               units="pixel")
        yKey = schema.addField(name + "_y", type="D", doc="transformed reference centroid row",
                               units="pixel")
        self.centroidKey = lsst.afw.table.Point2DKey(xKey, yKey)
        # Because we're taking the reference position as given, we don't bother transforming its
        # uncertainty and reporting that here, so there are no sigma or cov fields.  We do propagate
        # the flag field, if it exists.
        if "slot_Centroid_flag" in schemaMapper.getInputSchema():
            self.flagKey = schema.addField(name + "_flag", type="Flag",
                                           doc="whether the reference centroid is marked as bad")
        else:
            self.flagKey = None
 

Member Function Documentation

◆ getExecutionOrder()

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 822 of file plugins.py.

    def getExecutionOrder(cls):
        return cls.CENTROID_ORDER
 

◆ measure()

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 843 of file plugins.py.

    def measure(self, measRecord, exposure, refRecord, refWcs):
        targetWcs = exposure.getWcs()
        if not refWcs == targetWcs:
            targetPos = targetWcs.skyToPixel(refWcs.pixelToSky(refRecord.getCentroid()))
            measRecord.set(self.centroidKey, targetPos)
        else:
            measRecord.set(self.centroidKey, refRecord.getCentroid())
        if self.flagKey is not None:
            measRecord.set(self.flagKey, refRecord.getCentroidFlag())
 
 

Member Data Documentation

◆ centroidKey

lsst.meas.base.plugins.ForcedTransformedCentroidPlugin.centroidKey

Definition at line 833 of file plugins.py.

◆ ConfigClass

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

static

Definition at line 819 of file plugins.py.

◆ flagKey

lsst.meas.base.plugins.ForcedTransformedCentroidPlugin.flagKey

Definition at line 838 of file plugins.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_base/gf18bd8381d+8d59551888/python/lsst/meas/base/plugins.py

Public Member Functions

Public Attributes

Static Public Attributes