lsst.meas.modelfit.cmodel.cmodelContinued.CModelForcedPlugin Class Reference

Inheritance diagram for lsst.meas.modelfit.cmodel.cmodelContinued.CModelForcedPlugin:

Public Member Functions
	__init__ (self, config, name, schemaMapper, metadata)
	measure (self, measRecord, exposure, refRecord, refWcs)
	fail (self, measRecord, error=None)

Static Public Member Functions
	getExecutionOrder ()

Public Attributes
	algorithm

Static Public Attributes
	ConfigClass = CModelForcedConfig

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__()

lsst.meas.modelfit.cmodel.cmodelContinued.CModelForcedPlugin.__init__	(		self,
			config,
			name,
			schemaMapper,
			metadata )

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

Definition at line 98 of file cmodelContinued.py.

    def __init__(self, config, name, schemaMapper, metadata):
        lsst.meas.base.ForcedPlugin.__init__(self, config, name, schemaMapper, metadata)
        self.algorithm = CModelAlgorithm(name, config.makeControl(), schemaMapper)
 

Member Function Documentation

fail()

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.

    def fail(self, measRecord, error=None):
        self.algorithm.fail(measRecord, error.cpp if error is not None else None)

getExecutionOrder()

lsst.meas.modelfit.cmodel.cmodelContinued.CModelForcedPlugin.getExecutionOrder ( )

static

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 95 of file cmodelContinued.py.

    def getExecutionOrder():
        return 3.0
 

measure()

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.

    def measure(self, measRecord, exposure, refRecord, refWcs):
        if refWcs != exposure.getWcs():
            raise lsst.meas.base.FatalAlgorithmError(
                "CModel forced measurement currently requires the measurement image to have the same"
                " Wcs as the reference catalog (this is a temporary limitation)."
            )
        self.algorithm.measure(measRecord, exposure, refRecord)
 

Member Data Documentation

algorithm

lsst.meas.modelfit.cmodel.cmodelContinued.CModelForcedPlugin.algorithm

Definition at line 100 of file cmodelContinued.py.

ConfigClass

lsst.meas.modelfit.cmodel.cmodelContinued.CModelForcedPlugin.ConfigClass = CModelForcedConfig

static

Definition at line 92 of file cmodelContinued.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_modelfit/g591dd9f2cf+ffa42b374e/python/lsst/meas/modelfit/cmodel/cmodelContinued.py