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

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

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

Static Public Member Functions
	getExecutionOrder ()

Public Attributes
	algorithm

Static Public Attributes
	ConfigClass = CModelSingleFrameConfig

Detailed Description

Single-frame measurement interface for CModelAlgorithm.

This class simply provides __init__ and measure methods that matched the SingleFramePlugin signatures
and delegate to the CModelAlgorithm's methods.

Definition at line 46 of file cmodelContinued.py.

Constructor & Destructor Documentation

__init__()

lsst.meas.modelfit.cmodel.cmodelContinued.CModelSingleFramePlugin.__init__	(		self,
			config,
			name,
			schema,
			metadata )

Reimplemented from lsst.meas.base.sfm.SingleFramePlugin.

Definition at line 58 of file cmodelContinued.py.

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

Member Function Documentation

fail()

lsst.meas.modelfit.cmodel.cmodelContinued.CModelSingleFramePlugin.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 65 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.CModelSingleFramePlugin.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 55 of file cmodelContinued.py.

    def getExecutionOrder():
        return 3.0
 

measure()

lsst.meas.modelfit.cmodel.cmodelContinued.CModelSingleFramePlugin.measure	(		self,
			measRecord,
			exposure )

Measure the properties of a source on a single image.

The image may be from a single epoch, or it may be a coadd.

Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
    Record describing the object being measured. Previously-measured
    quantities may be retrieved from here, and it will be updated
    in-place tih the outputs of this plugin.
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.

Reimplemented from lsst.meas.base.sfm.SingleFramePlugin.

Definition at line 62 of file cmodelContinued.py.

    def measure(self, measRecord, exposure):
        self.algorithm.measure(measRecord, exposure)
 

Member Data Documentation

algorithm

lsst.meas.modelfit.cmodel.cmodelContinued.CModelSingleFramePlugin.algorithm

Definition at line 60 of file cmodelContinued.py.

ConfigClass

lsst.meas.modelfit.cmodel.cmodelContinued.CModelSingleFramePlugin.ConfigClass = CModelSingleFrameConfig

static

Definition at line 52 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+97ef3b4495/python/lsst/meas/modelfit/cmodel/cmodelContinued.py