lsst.meas.modelfit.display.cModelDisplay Namespace Reference

Functions
def	displayReconstructedCmodel (exposure, record, config, display="mpl")
def	displayReconstrucedCmodelMpl (exposure, record, config)
def	buildCModelImages (exposure, record, config)
def	reconstructCModel (exposure, record, config)

Function Documentation

buildCModelImages()

def lsst.meas.modelfit.display.cModelDisplay.buildCModelImages	(		exposure,
			record,
			config
	)

Create Images out of the CModel for the given record

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure object that contains the source which was  modeled
record : `lsst.afw.table.SourceRecord`
    Record object which contains the measurements made on the source
config : `lsst.meas.modelfit.CModel(SingleFrame/Forced)Config`
    Configuration object of the CModel plugin used in the measurement
    process

Returns
-------
subImage : `lsst.afw.image.ImageF`
    Sub image of the original data taken from a region defined by the
    bounding box of the footprint for the object defined in the given
    source record
devIm : `lsst.afw.image.ImageF`
    Image created from the dev component of the CModel for the supplied
    record at the same pixel locations as subImage
expIm: `lsst.afw.image.ImageF`
    Image created from the exp component of the CModel for the supplied
    record at the same pixel locations as subImage
jointIm :
    Image created from the joint fit of the dev and exp components of the
    CModel for the supplied record at the same pixel locations as subImage

Definition at line 112 of file cModelDisplay.py.

displayReconstrucedCmodelMpl()

def lsst.meas.modelfit.display.cModelDisplay.displayReconstrucedCmodelMpl	(		exposure,
			record,
			config
	)

Display an image, the Cmodel, and residuals using matplotlib

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure object that contains the source which was  modeled
record : `lsst.afw.table.SourceRecord`
    Record object which contains the measurements made on the source
config : `lsst.meas.modelfit.CModel(SingleFrame/Forced)Config`
    Configuration object of the CModel plugin used in the measurement
    process

Definition at line 44 of file cModelDisplay.py.

displayReconstructedCmodel()

def lsst.meas.modelfit.display.cModelDisplay.displayReconstructedCmodel	(		exposure,
			record,
			config,
			display = "mpl"
	)

Display an image, the Cmodel, and residuals

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure object that contains the source which was modeled
record : `lsst.afw.table.SourceRecord`
    Record object which contains the measurements made on the source
config : `lsst.meas.modelfit.CModel(SingleFrame/Forced)Config`
    Configuration object of the CModel plugin used in the measurement
    process
display : `str`, optional
    Display in which to render the data, may be mpl for matplotlib or afw
    for afwDisplay, defaults to mpl

Raises
------
`NotImplementedError`
    If the display backend specified is not implemented

Definition at line 12 of file cModelDisplay.py.

reconstructCModel()

def lsst.meas.modelfit.display.cModelDisplay.reconstructCModel	(		exposure,
			record,
			config
	)

Reconstruct the CModel for the given record

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure object that contains the source which was  modeled
record : `lsst.afw.table.SourceRecord`
    Record object which contains the measurements made on the source
config : `lsst.meas.modelfit.CModel(SingleFrame/Forced)Config`
    Configuration object of the CModel plugin used in the measurement
    process

Returns
-------
devShapelet : `lsst.shapelet.MultiShapeletFunction`
    Multi-component shapelet model of the dev component of CModel
expShapelet : `lsst.shapelet.MultiShapeletFunction`
    Multi-component shapelet model fo the exp component of CModel
devJointShapelet : `lsst.shapelet.MultiShapeletFunction`
    Multi-component shapelet model of the dev component of CModel jointly
    fit with the exp component
expJointShapelet : `lsst.shapelet.MultiShapeletFunction`
    Multi-component shapelet model of the exp component of Cmodel jointly
    fit with the dev component

Definition at line 172 of file cModelDisplay.py.