Public Member Functions | |
| def | __init__ (self, config, name, schemaMapper, metadata) |
| def | measure (self, measRecord, exposure, refRecord, refWcs) |
| def | fail (self, measRecord, error=None) |
| def | measureN (self, measCat, exposure, refCat, refWcs) |
| def | getExecutionOrder (cls) |
| def | getLogName (self) |
Static Public Member Functions | |
| def | getExecutionOrder () |
| def | getTransformClass () |
Public Attributes | |
| algorithm | |
| config | |
| name | |
| logName | |
Static Public Attributes | |
| ConfigClass = CModelForcedConfig | |
| registry = PluginRegistry(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
Forced measurement interface for CModelAlgorithm This class simply provides __init__ and measure methods that matched the ForcedPlugin signatures and delegate to CModelAlgorithm implementations. The CModel algorithm currently cannot be run in forced mode when the measurement WCS is different from the reference WCS (as is the case in CCD forced photometry). This is a temporary limitation that will be addressed on DM-5405. CModel forced measurement when the measurement image is the same as the reference image should be almost -- but not quite -- identical to unforced measurement. The primary difference is that the final fit region from the reference measurement will be used for the initial fit in forced mode as well as the exp, dev, and combined exp+dev fits
Definition at line 77 of file cmodelContinued.py.
Constructor & Destructor Documentation
◆ __init__()
| def lsst.meas.modelfit.cmodel.cmodelContinued.CModelForcedPlugin.__init__ | ( | self, | |
| config, | |||
| name, | |||
| schemaMapper, | |||
| metadata | |||
| ) |
Definition at line 98 of file cmodelContinued.py.
Member Function Documentation
◆ fail()
| def lsst.meas.modelfit.cmodel.cmodelContinued.CModelForcedPlugin.fail | ( | self, | |
| measRecord, | |||
error = None |
|||
| ) |
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 from lsst.meas.base.pluginsBase.BasePlugin.
Definition at line 110 of file cmodelContinued.py.
◆ getExecutionOrder() [1/2]
|
static |
Definition at line 95 of file cmodelContinued.py.
◆ getExecutionOrder() [2/2]
|
inherited |
Get the relative execution order of this plugin. Must be reimplemented as a class method by concrete derived classes.
Reimplemented in lsst.meas.base.wrappers.GenericPlugin, lsst.meas.base.plugins.ForcedTransformedShapePlugin, lsst.meas.base.plugins.ForcedTransformedCentroidPlugin, lsst.meas.base.plugins.ForcedPeakCentroidPlugin, lsst.meas.base.plugins.SingleFrameSkyCoordPlugin, lsst.meas.base.plugins.SingleFramePeakCentroidPlugin, lsst.meas.base.plugins.EvaluateLocalWcsPlugin, lsst.meas.base.plugins.EvaluateLocalPhotoCalibPlugin, lsst.meas.base.plugins.InputCountPlugin, lsst.meas.base.plugins.VariancePlugin, lsst.meas.base.plugins.SingleFrameJacobianPlugin, lsst.meas.base.plugins.SingleFrameFPPositionPlugin, lsst.meas.base.footprintArea.CatalogCalculationFootprintAreaPlugin, lsst.meas.base.classification.CatalogCalculationClassificationPlugin, lsst.meas.base.catalogCalculation.CatalogCalculationPlugin, and lsst.ip.diffim.dipoleMeasurement.ClassificationDipolePlugin.
Definition at line 121 of file pluginsBase.py.
◆ getLogName()
|
inherited |
Definition at line 134 of file pluginsBase.py.
◆ 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.
◆ measure()
| def lsst.meas.modelfit.cmodel.cmodelContinued.CModelForcedPlugin.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.
Definition at line 102 of file cmodelContinued.py.
◆ measureN()
|
inherited |
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.
Member Data Documentation
◆ algorithm
| lsst.meas.modelfit.cmodel.cmodelContinued.CModelForcedPlugin.algorithm |
Definition at line 100 of file cmodelContinued.py.
◆ APCORR_ORDER
|
staticinherited |
Definition at line 98 of file pluginsBase.py.
◆ CENTROID_ORDER
|
staticinherited |
Definition at line 72 of file pluginsBase.py.
◆ config
|
inherited |
Definition at line 130 of file pluginsBase.py.
◆ ConfigClass
|
static |
Definition at line 92 of file cmodelContinued.py.
◆ DEFAULT_CATALOGCALCULATION
|
staticinherited |
Definition at line 108 of file pluginsBase.py.
◆ FLUX_ORDER
|
staticinherited |
Definition at line 89 of file pluginsBase.py.
◆ logName
|
inherited |
Definition at line 132 of file pluginsBase.py.
◆ name
|
inherited |
Definition at line 131 of file pluginsBase.py.
◆ registry
|
staticinherited |
Definition at line 95 of file forcedMeasurement.py.
◆ SHAPE_ORDER
|
staticinherited |
Definition at line 80 of file pluginsBase.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/0.4.3/Linux64/meas_modelfit/21.0.0-2-gecfae73+1d3a86e577/python/lsst/meas/modelfit/cmodel/cmodelContinued.py
