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

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)

def	measure (self, measRecord, exposure)

Static Public Member Functions
def	getExecutionOrder ()

def	getTransformClass ()

Public Attributes
	config

	name

	logName

	sequence

Static Public Attributes
	ConfigClass = GeneralShapeletPsfApproxForcedConfig

	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

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

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

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

def lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxForcedPlugin.fail	(	self,
		measRecord,
		error = `None`
	)

Reimplemented from lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxMixin.

Definition at line 264 of file psfContinued.py.

264 def fail(self, measRecord, error=None):

265 GeneralShapeletPsfApproxMixin.fail(self, measRecord, error)

◆ getExecutionOrder() [1/2]

def lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxForcedPlugin.getExecutionOrder ( )

static

Definition at line 252 of file psfContinued.py.

     def getExecutionOrder():
         return 1.0
  

◆ getExecutionOrder() [2/2]

def lsst.meas.base.pluginsBase.BasePlugin.getExecutionOrder ( cls )

inherited

Get the relative execution order of this plugin.

Must be reimplemented as a class method by concrete derived classes.

Definition at line 121 of file pluginsBase.py.

     def getExecutionOrder(cls):
         """Get the relative execution order of this plugin.
  
         Must be reimplemented as a class method by concrete derived classes.
         """
         raise NotImplementedError("All plugins must implement getExecutionOrder()")
  

◆ getLogName()

def lsst.meas.base.pluginsBase.BasePlugin.getLogName ( self )

inherited

Definition at line 134 of file pluginsBase.py.

     def getLogName(self):
         return self.logName
  

◆ getTransformClass()

def lsst.meas.base.pluginsBase.BasePlugin.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.

     def getTransformClass():
         """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.
         """
         return PassThroughTransform

◆ measure() [1/2]

def lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxMixin.measure	(	self,
		measRecord,
		exposure
	)

inherited

Fit the configured sequence of models the given Exposure's Psf, as
evaluated at measRecord.getCentroid(), then save the results to
measRecord.

Reimplemented in lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxSingleFramePlugin.

Definition at line 141 of file psfContinued.py.

     def measure(self, measRecord, exposure):
         """Fit the configured sequence of models the given Exposure's Psf, as
         evaluated at measRecord.getCentroid(), then save the results to
         measRecord.
         """
         if not exposure.hasPsf():
             raise lsst.meas.base.FatalAlgorithmError(
                 "GeneralShapeletPsfApprox requires Exposure to have a Psf")
         psf = exposure.getPsf()
         psfImage = psf.computeKernelImage(measRecord.getCentroid())
         psfShape = psf.computeShape(measRecord.getCentroid())
         lastError = None
         lastModel = None
         # Fit the first element in the sequence, using the PSFs moments to
         # initialize the parameters For every other element in the fitting
         # sequence, use the previous fit to initialize the parameters
         lastResult = None
         for fitter, name in self.sequence:
             try:
                 if lastModel is None:
                     fitter.measure(measRecord, psfImage, psfShape)
                 else:
                     fitter.measure(measRecord, psfImage,
                                    fitter.adapt(lastResult, lastModel))
                 lastResult = measRecord.get(fitter.getKey())
                 lastModel = fitter.getModel()
             except lsst.meas.base.baseMeasurement.FATAL_EXCEPTIONS:
                 raise
             except lsst.meas.base.MeasurementError as error:
                 fitter.fail(measRecord, error.cpp)
                 lastError = error
             except Exception as error:
                 fitter.fail(measRecord)
                 lastError = error
         # When we are done with all the fitters, raise the last error if there
         # was one. This gives the calling task a chance to do whatever it
         # wants
         if lastError is not None:
             raise lastError
  

◆ measure() [2/2]

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

◆ measureN()

def lsst.meas.base.forcedMeasurement.ForcedPlugin.measureN	(	self,
		measCat,
		exposure,
		refCat,
		refWcs
	)

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 135 of file forcedMeasurement.py.

     def measureN(self, measCat, exposure, refCat, refWcs):
         """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.
         """
         raise NotImplementedError()
  
  

Member Data Documentation

◆ APCORR_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.APCORR_ORDER = 3.0

staticinherited

Definition at line 98 of file pluginsBase.py.

◆ CENTROID_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.CENTROID_ORDER = 0.0

staticinherited

Definition at line 72 of file pluginsBase.py.

◆ config

lsst.meas.base.pluginsBase.BasePlugin.config

inherited

Definition at line 130 of file pluginsBase.py.

◆ ConfigClass

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

static

Definition at line 249 of file psfContinued.py.

◆ DEFAULT_CATALOGCALCULATION

float lsst.meas.base.pluginsBase.BasePlugin.DEFAULT_CATALOGCALCULATION = 4.0

staticinherited

Definition at line 108 of file pluginsBase.py.

◆ FLUX_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.FLUX_ORDER = 2.0

staticinherited

Definition at line 89 of file pluginsBase.py.

◆ logName

lsst.meas.base.pluginsBase.BasePlugin.logName

inherited

Definition at line 132 of file pluginsBase.py.

◆ name

lsst.meas.base.pluginsBase.BasePlugin.name

inherited

Definition at line 131 of file pluginsBase.py.

◆ registry

lsst.meas.base.forcedMeasurement.ForcedPlugin.registry = PluginRegistry(ForcedPluginConfig)

staticinherited

Definition at line 96 of file forcedMeasurement.py.

◆ sequence

lsst.meas.modelfit.psf.psfContinued.GeneralShapeletPsfApproxMixin.sequence

inherited

Definition at line 132 of file psfContinued.py.

◆ SHAPE_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.SHAPE_ORDER = 1.0

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/lsst-scipipe-0.7.0/Linux64/meas_modelfit/22.0.1-4-g44f2e3d+9e4ab0f4fa/python/lsst/meas/modelfit/psf/psfContinued.py

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ fail()

◆ getExecutionOrder() [1/2]

◆ getExecutionOrder() [2/2]

◆ getLogName()

◆ getTransformClass()

◆ measure() [1/2]

◆ measure() [2/2]

◆ measureN()

Member Data Documentation

◆ APCORR_ORDER

◆ CENTROID_ORDER

◆ config

◆ ConfigClass

◆ DEFAULT_CATALOGCALCULATION

◆ FLUX_ORDER

◆ logName

◆ name

◆ registry

◆ sequence

◆ SHAPE_ORDER

◆ init()