lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxForcedPlugin Class Reference

Inheritance diagram for lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxForcedPlugin:

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

Static Public Attributes
	ConfigClass = GeneralShapeletPsfApproxForcedConfig

Detailed Description

Minimal subclass of GeneralShapeletPsfApproxMixin to conform to the
forced measurement API.

This class simply provides __init__ and measure methods that matched the
ForcedPlugin signatures and delegate to the
GeneralShapeletPsfApproxMixin's implementations.

Definition at line 238 of file psfContinued.py.

Constructor & Destructor Documentation

__init__()

lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxForcedPlugin.__init__	(		self,
			config,
			name,
			schemaMapper,
			metadata )

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

Definition at line 255 of file psfContinued.py.

    def __init__(self, config, name, schemaMapper, metadata):
        GeneralShapeletPsfApproxMixin.__init__(self, config, name,
                                               schemaMapper.editOutputSchema())
        lsst.meas.base.ForcedPlugin.__init__(self, config, name, schemaMapper,
                                             metadata)
 

Member Function Documentation

fail()

lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxForcedPlugin.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 264 of file psfContinued.py.

    def fail(self, measRecord, error=None):
        GeneralShapeletPsfApproxMixin.fail(self, measRecord, error)

getExecutionOrder()

lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxForcedPlugin.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 252 of file psfContinued.py.

    def getExecutionOrder():
        return 1.0
 

measure()

lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxForcedPlugin.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 261 of file psfContinued.py.

    def measure(self, measRecord, exposure, refRecord, refWcs):
        GeneralShapeletPsfApproxMixin.measure(self, measRecord, exposure)
 

Member Data Documentation

ConfigClass

lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxForcedPlugin.ConfigClass = GeneralShapeletPsfApproxForcedConfig

static

Definition at line 249 of file psfContinued.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+df404f777f/python/lsst/meas/modelfit/psf/psfContinued.py