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

Public Member Functions
	measure (self, measRecord, exposure, refRecord, refWcs)

Public Attributes
	centroidKey

	flagKey

Static Public Attributes
	ConfigClass = ForcedTransformedCentroidFromCoordConfig

Detailed Description

Record the transformation of the reference catalog coord.

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

Parameters
----------
config : `ForcedTransformedCentroidFromCoordConfig`
    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 can be used as the slot centroid in forced measurement when only a
reference coord exist, allowing subsequent measurements to simply refer to
the slot value just as they would in single-frame measurement.

Definition at line 853 of file plugins.py.

Member Function Documentation

◆ measure()

lsst.meas.base.plugins.ForcedTransformedCentroidFromCoordPlugin.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.plugins.ForcedTransformedCentroidPlugin.

Definition at line 880 of file plugins.py.

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

Member Data Documentation

◆ centroidKey

lsst.meas.base.plugins.ForcedTransformedCentroidFromCoordPlugin.centroidKey

Definition at line 884 of file plugins.py.

◆ ConfigClass

lsst.meas.base.plugins.ForcedTransformedCentroidFromCoordPlugin.ConfigClass = ForcedTransformedCentroidFromCoordConfig

static

Definition at line 878 of file plugins.py.

◆ flagKey

lsst.meas.base.plugins.ForcedTransformedCentroidFromCoordPlugin.flagKey

Definition at line 887 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/g212a7c68fe+04a9158687/python/lsst/meas/base/plugins.py

Public Member Functions

Public Attributes