Inheritance diagram for lsst.meas.base.forcedMeasurement.ForcedPlugin:
Public Member Functions | |
| __init__ (self, config, name, schemaMapper, metadata, logName=None) | |
| measure (self, measRecord, exposure, refRecord, refWcs) | |
| measureN (self, measCat, exposure, refCat, refWcs) | |
Static Public Attributes | |
| registry = PluginRegistry(ForcedPluginConfig) | |
| ConfigClass = ForcedPluginConfig | |
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 76 of file forcedMeasurement.py.
Constructor & Destructor Documentation
◆ __init__()
| lsst.meas.base.forcedMeasurement.ForcedPlugin.__init__ | ( | self, | |
| config, | |||
| name, | |||
| schemaMapper, | |||
| metadata, | |||
| logName = None ) |
Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.
Reimplemented in lsst.meas.base.plugins.ForcedPeakCentroidPlugin, lsst.meas.base.plugins.ForcedTransformedCentroidPlugin, lsst.meas.base.plugins.ForcedTransformedShapePlugin, lsst.meas.modelfit.cmodel.cmodelContinued.CModelForcedPlugin, lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxForcedPlugin, and lsst.meas.base.wrappers.WrappedForcedPlugin.
Definition at line 102 of file forcedMeasurement.py.
102 def __init__(self, config, name, schemaMapper, metadata, logName=None):
103 BaseMeasurementPlugin.__init__(self, config, name, logName=logName)
104
Member Function Documentation
◆ measure()
| 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.ForcedPeakCentroidPlugin, lsst.meas.base.plugins.ForcedTransformedCentroidPlugin, lsst.meas.base.plugins.ForcedTransformedCentroidFromCoordPlugin, lsst.meas.base.plugins.ForcedTransformedShapePlugin, lsst.meas.base.wrappers.WrappedForcedPlugin, lsst.meas.modelfit.cmodel.cmodelContinued.CModelForcedPlugin, and lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxForcedPlugin.
Definition at line 105 of file forcedMeasurement.py.
105 def measure(self, measRecord, exposure, refRecord, refWcs):
106 """Measure the properties of a source given an image and a reference.
107
108 Parameters
109 ----------
110 exposure : `lsst.afw.image.ExposureF`
111 The pixel data to be measured, together with the associated PSF,
112 WCS, etc. All other sources in the image should have been replaced
113 by noise according to deblender outputs.
114 measRecord : `lsst.afw.table.SourceRecord`
115 Record describing the object being measured. Previously-measured
116 quantities will be retrieved from here, and it will be updated
117 in-place with the outputs of this plugin.
118 refRecord : `lsst.afw.table.SimpleRecord`
119 Additional parameters to define the fit, as measured elsewhere.
120 refWcs : `lsst.afw.geom.SkyWcs` or `lsst.afw.geom.Angle`
121 The coordinate system for the reference catalog values. An
122 `~lsst.geom.Angle` may be passed, indicating that a local tangent
123 WCS should be created for each object using the given angle as a
124 pixel scale.
125
126 Notes
127 -----
128 In the normal mode of operation, the source centroid will be set to
129 the WCS-transformed position of the reference object, so plugins that
130 only require a reference position should not have to access the
131 reference object at all.
132 """
133 raise NotImplementedError()
134
◆ measureN()
| 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 135 of file forcedMeasurement.py.
135 def measureN(self, measCat, exposure, refCat, refWcs):
136 """Measure the properties of blended sources from image & reference.
137
138 This operates on all members of a blend family at once.
139
140 Parameters
141 ----------
142 exposure : `lsst.afw.image.ExposureF`
143 The pixel data to be measured, together with the associated PSF,
144 WCS, etc. Sources not in the blended hierarchy to be measured
145 should have been replaced with noise using deblender outputs.
146 measCat : `lsst.afw.table.SourceCatalog`
147 Catalog describing the objects (and only those objects) being
148 measured. Previously-measured quantities will be retrieved from
149 here, and it will be updated in-place with the outputs of this
150 plugin.
151 refCat : `lsst.afw.table.SimpleCatalog`
152 Additional parameters to define the fit, as measured elsewhere.
153 Ordered such that ``zip(measCat, refcat)`` may be used.
154 refWcs : `lsst.afw.geom.SkyWcs` or `lsst.afw.geom.Angle`
155 The coordinate system for the reference catalog values. An
156 `~lsst.geom.Angle` may be passed, indicating that a local tangent
157 WCS should be created for each object using the given angle as a
158 pixel scale.
159
160 Notes
161 -----
162 In the normal mode of operation, the source centroids will be set to
163 the WCS-transformed position of the reference object, so plugins that
164 only require a reference position should not have to access the
165 reference object at all.
166 """
167 raise NotImplementedError()
168
169
Member Data Documentation
◆ ConfigClass
|
static |
Definition at line 100 of file forcedMeasurement.py.
◆ registry
|
static |
Definition at line 96 of file forcedMeasurement.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+a4f2ea4efa/python/lsst/meas/base/forcedMeasurement.py
