Inheritance diagram for lsst.meas.base.plugins.EvaluateLocalWcsPlugin:

Public Member Functions
def	getExecutionOrder (cls)

def	__init__ (self, config, name, schema, metadata)

def	measure (self, measRecord, exposure, center)

def	makeLocalTransformMatrix (self, wcs, center)

def	measureN (self, measCat, exposure, refCat, refWcs)

def	fail (self, measRecord, error=None)

def	makeSingleFramePlugin (cls, name)

def	makeForcedPlugin (cls, name)

def	getLogName (self)

Static Public Member Functions
def	getTransformClass ()

Public Attributes
	cdMatrix11Key

	cdMatrix12Key

	cdMatrix21Key

	cdMatrix22Key

	config

	name

	logName

Static Public Attributes
	ConfigClass = EvaluateLocalWcsPluginConfig

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

Evaluate the local, linear approximation of the Wcs.

The aim is to store the local calib value within the catalog for later
use in the Science Data Model functors.

Definition at line 463 of file plugins.py.

Constructor & Destructor Documentation

◆ init()

def lsst.meas.base.plugins.EvaluateLocalWcsPlugin.__init__	(	self,
		config,
		name,
		schema,
		metadata
	)

Definition at line 476 of file plugins.py.

     def __init__(self, config, name, schema, metadata):
         GenericPlugin.__init__(self, config, name, schema, metadata)
         self.cdMatrix11Key = schema.addField(
             f"{name}_CDMatrix_1_1",
             type="D",
             doc=f"(1, 1) element of the CDMatrix for the linear approximation "
                  "of the WCS at the src location. Gives units in radians.")
         self.cdMatrix12Key = schema.addField(
             f"{name}_CDMatrix_1_2",
             type="D",
             doc=f"(1, 2) element of the CDMatrix for the linear approximation "
                  "of the WCS at the src location. Gives units in radians.")
         self.cdMatrix21Key = schema.addField(
             f"{name}_CDMatrix_2_1",
             type="D",
             doc=f"(2, 1) element of the CDMatrix for the linear approximation "
                  "of the WCS at the src location. Gives units in radians.")
         self.cdMatrix22Key = schema.addField(
             f"{name}_CDMatrix_2_2",
             type="D",
             doc=f"(2, 2) element of the CDMatrix for the linear approximation "
                  "of the WCS at the src location. Gives units in radians.")
  

Member Function Documentation

◆ fail()

def lsst.meas.base.wrappers.GenericPlugin.fail	(	self,
		measRecord,
		error = `None`
	)

inherited

Record a measurement failure.

This default implementation simply records the failure in the source
record.

Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
    Catalog record for the source being measured.
error : `Exception`
    Error causing failure, or `None`.

Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.

Reimplemented in lsst.meas.base.plugins.InputCountPlugin, and lsst.meas.base.plugins.VariancePlugin.

Definition at line 566 of file wrappers.py.

     def fail(self, measRecord, error=None):
         """Record a measurement failure.
  
         This default implementation simply records the failure in the source
         record.
  
         Parameters
         ----------
         measRecord : `lsst.afw.table.SourceRecord`
             Catalog record for the source being measured.
         error : `Exception`
             Error causing failure, or `None`.
         """
         measRecord.set(self._failKey, True)
  

◆ getExecutionOrder()

def lsst.meas.base.plugins.EvaluateLocalWcsPlugin.getExecutionOrder ( cls )

Get the relative execution order of this plugin.

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

Reimplemented from lsst.meas.base.wrappers.GenericPlugin.

Definition at line 473 of file plugins.py.

     def getExecutionOrder(cls):
         return BasePlugin.FLUX_ORDER
  

◆ 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

◆ makeForcedPlugin()

def lsst.meas.base.wrappers.GenericPlugin.makeForcedPlugin	(	cls,
		name
	)

inherited

Produce a ForcedPlugin subclass from this GenericPlugin class.

The class is also registered.

Parameters
----------
name : `str`
    Name of plugin to register.

Definition at line 623 of file wrappers.py.

     def makeForcedPlugin(cls, name):
         """Produce a ForcedPlugin subclass from this GenericPlugin class.
  
         The class is also registered.
  
         Parameters
         ----------
         name : `str`
             Name of plugin to register.
         """
         class ForcedFromGenericConfig(cls.ConfigClass, ForcedPluginConfig):
             pass
  
         @register(name)
         class ForcedFromGenericPlugin(ForcedPlugin):
             ConfigClass = ForcedFromGenericConfig
  
             def __init__(self, config, name, schemaMapper, metadata, logName=None):
                 ForcedPlugin.__init__(self, config, name, schemaMapper, metadata, logName=logName)
                 schema = schemaMapper.editOutputSchema()
                 self._generic = cls(config, name, schema, metadata)
  
             def measure(self, measRecord, exposure, refRecord, refWcs):
                 center = exposure.getWcs().skyToPixel(refWcs.pixelToSky(refRecord.getCentroid()))
                 return self._generic.measure(measRecord, exposure, center)
  
             def measureN(self, measCat, exposure, refCat, refWcs):
                 return self._generic.measureN(measCat, exposure, refCat, refWcs)
  
             def fail(self, measRecord, error=None):
                 self._generic.fail(measRecord, error if error is not None else None)
  
             @staticmethod
             def getExecutionOrder():
                 return cls.getExecutionOrder()
  
             def getTransformClass(self):
                 return self._generic.getTransformClass()
  
         return ForcedFromGenericPlugin

◆ makeLocalTransformMatrix()

def lsst.meas.base.plugins.EvaluateLocalWcsPlugin.makeLocalTransformMatrix	(	self,
		wcs,
		center
	)

Create a local, linear approximation of the wcs transformation
matrix.

The approximation is created as if the center is at RA=0, DEC=0. All
comparing x,y coordinate are relative to the position of center. Matrix
is initially calculated with units arcseconds and then converted to
radians. This yields higher precision results due to quirks in AST.

Parameters
----------
wcs : `lsst.afw.geom.SkyWcs`
    Wcs to approximate
center : `lsst.geom.Point2D`
    Point at which to evaluate the LocalWcs.

Returns
-------
localMatrix : `numpy.ndarray`
    Matrix representation the local wcs approximation with units
    radians.

Definition at line 507 of file plugins.py.

     def makeLocalTransformMatrix(self, wcs, center):
         """Create a local, linear approximation of the wcs transformation
         matrix.
  
         The approximation is created as if the center is at RA=0, DEC=0. All
         comparing x,y coordinate are relative to the position of center. Matrix
         is initially calculated with units arcseconds and then converted to
         radians. This yields higher precision results due to quirks in AST.
  
         Parameters
         ----------
         wcs : `lsst.afw.geom.SkyWcs`
             Wcs to approximate
         center : `lsst.geom.Point2D`
             Point at which to evaluate the LocalWcs.
  
         Returns
         -------
         localMatrix : `numpy.ndarray`
             Matrix representation the local wcs approximation with units
             radians.
         """
         skyCenter = wcs.pixelToSky(center)
         localGnomonicWcs = lsst.afw.geom.makeSkyWcs(
             center, skyCenter, np.diag((self._scale, self._scale)))
         measurementToLocalGnomonic = wcs.getTransform().then(
             localGnomonicWcs.getTransform().inverted()
         )
         localMatrix = measurementToLocalGnomonic.getJacobian(center)
         return np.radians(localMatrix / 3600)
  
  

◆ makeSingleFramePlugin()

def lsst.meas.base.wrappers.GenericPlugin.makeSingleFramePlugin	(	cls,
		name
	)

inherited

Produce a SingleFramePlugin subclass from this GenericPlugin class.

The class is also registered.

Parameters
----------
name : `str`
    Name of plugin to register.

Definition at line 582 of file wrappers.py.

     def makeSingleFramePlugin(cls, name):
         """Produce a SingleFramePlugin subclass from this GenericPlugin class.
  
         The class is also registered.
  
         Parameters
         ----------
         name : `str`
             Name of plugin to register.
         """
         class SingleFrameFromGenericConfig(cls.ConfigClass, SingleFramePluginConfig):
             pass
  
         @register(name)
         class SingleFrameFromGenericPlugin(SingleFramePlugin):
             ConfigClass = SingleFrameFromGenericConfig
  
             def __init__(self, config, name, schema, metadata, logName=None):
                 SingleFramePlugin.__init__(self, config, name, schema, metadata, logName=logName)
                 self._generic = cls(config, name, schema, metadata)
  
             def measure(self, measRecord, exposure):
                 center = measRecord.getCentroid()
                 return self._generic.measure(measRecord, exposure, center)
  
             def measureN(self, measCat, exposure, refCat, refWcs):
                 return self._generic.measureN(measCat, exposure, refCat, refWcs)
  
             def fail(self, measRecord, error=None):
                 self._generic.fail(measRecord, error if error is not None else None)
  
             @staticmethod
             def getExecutionOrder():
                 return cls.getExecutionOrder()
  
             def getTransformClass(self):
                 return self._generic.getTransformClass()
  
         return SingleFrameFromGenericPlugin
  

◆ measure()

def lsst.meas.base.plugins.EvaluateLocalWcsPlugin.measure	(	self,
		measRecord,
		exposure,
		center
	)

Measure a single source.

It is the responsibility of this method to perform the desired
measurement and record the result in the `measRecord`.

Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
    Catalog record for the source being measured.
exposure : `lsst.afw.image.Exposure`
    Exposure on which the source is being measured.
center : `lsst.geom.Point2D`
    Pixel coordinates of the object.

Raises
------
MeasurementError
    Raised if the measurement fails for a known/justifiable reason.

Reimplemented from lsst.meas.base.wrappers.GenericPlugin.

Definition at line 499 of file plugins.py.

     def measure(self, measRecord, exposure, center):
         wcs = exposure.getWcs()
         localMatrix = self.makeLocalTransformMatrix(wcs, center)
         measRecord.set(self.cdMatrix11Key, localMatrix[0, 0])
         measRecord.set(self.cdMatrix12Key, localMatrix[0, 1])
         measRecord.set(self.cdMatrix21Key, localMatrix[1, 0])
         measRecord.set(self.cdMatrix22Key, localMatrix[1, 1])
  

◆ measureN()

def lsst.meas.base.wrappers.GenericPlugin.measureN	(	self,
		measCat,
		exposure,
		refCat,
		refWcs
	)

inherited

Measure multiple sources.

It is the responsibility of this method to perform the desired
measurement and record the result in the `measCat`.

Parameters
----------
measCat : `lsst.afw.table.SourceCatalog`
    Catalog for the sources being measured.
exposure : `lsst.afw.image.Exposure`
    Exposure on which the source is being measured.
refCat : `lsst.afw.table.SourceCatalog`
    Reference catalog.
refWcs : `lsst.afw.image.Wcs`
    Astrometric solution for the reference image.

Raises
------
MeasurementError
    Raised if the measurement fails for a known/justifiable reason.

Definition at line 542 of file wrappers.py.

     def measureN(self, measCat, exposure, refCat, refWcs):
         """Measure multiple sources.
  
         It is the responsibility of this method to perform the desired
         measurement and record the result in the `measCat`.
  
         Parameters
         ----------
         measCat : `lsst.afw.table.SourceCatalog`
             Catalog for the sources being measured.
         exposure : `lsst.afw.image.Exposure`
             Exposure on which the source is being measured.
         refCat : `lsst.afw.table.SourceCatalog`
             Reference catalog.
         refWcs : `lsst.afw.image.Wcs`
             Astrometric solution for the reference image.
  
         Raises
         ------
         MeasurementError
             Raised if the measurement fails for a known/justifiable reason.
         """
         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.

◆ cdMatrix11Key

lsst.meas.base.plugins.EvaluateLocalWcsPlugin.cdMatrix11Key

Definition at line 478 of file plugins.py.

◆ cdMatrix12Key

lsst.meas.base.plugins.EvaluateLocalWcsPlugin.cdMatrix12Key

Definition at line 483 of file plugins.py.

◆ cdMatrix21Key

lsst.meas.base.plugins.EvaluateLocalWcsPlugin.cdMatrix21Key

Definition at line 488 of file plugins.py.

◆ cdMatrix22Key

lsst.meas.base.plugins.EvaluateLocalWcsPlugin.cdMatrix22Key

Definition at line 493 of file plugins.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.base.plugins.EvaluateLocalWcsPlugin.ConfigClass = EvaluateLocalWcsPluginConfig

static

Definition at line 469 of file plugins.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.

◆ 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/1a1d771/Linux64/meas_base/20.0.0/python/lsst/meas/base/plugins.py

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ fail()

◆ getExecutionOrder()

◆ getLogName()

◆ getTransformClass()

◆ makeForcedPlugin()

◆ makeLocalTransformMatrix()

◆ makeSingleFramePlugin()

◆ measure()

◆ measureN()

Member Data Documentation

◆ APCORR_ORDER

◆ cdMatrix11Key

◆ cdMatrix12Key

◆ cdMatrix21Key

◆ cdMatrix22Key

◆ CENTROID_ORDER

◆ config

◆ ConfigClass

◆ DEFAULT_CATALOGCALCULATION

◆ FLUX_ORDER

◆ logName

◆ name

◆ SHAPE_ORDER

◆ init()