Inheritance diagram for lsst.ip.diffim.dipoleFitTask.DipoleFitTask:

Public Member Functions
def	__init__ (self, schema, algMetadata=None, **kwargs)

def	run (self, sources, exposure, posExp=None, negExp=None, **kwargs)

Public Attributes
	dipoleFitter

Static Public Attributes
	ConfigClass = DipoleFitTaskConfig

Detailed Description

A task that fits a dipole to a difference image, with an optional separate detection image.

Because it subclasses SingleFrameMeasurementTask, and calls
SingleFrameMeasurementTask.run() from its run() method, it still
can be used identically to a standard SingleFrameMeasurementTask.

Definition at line 129 of file dipoleFitTask.py.

Constructor & Destructor Documentation

◆ init()

def lsst.ip.diffim.dipoleFitTask.DipoleFitTask.__init__	(		self,
			schema,
			algMetadata = `None`,
		**	kwargs
	)

Definition at line 140 of file dipoleFitTask.py.

     def __init__(self, schema, algMetadata=None, **kwargs):
  
         measBase.SingleFrameMeasurementTask.__init__(self, schema, algMetadata, **kwargs)
  
         dpFitPluginConfig = self.config.plugins['ip_diffim_DipoleFit']
  
         self.dipoleFitter = DipoleFitPlugin(dpFitPluginConfig, name=self._DefaultName,
                                             schema=schema, metadata=algMetadata)

Member Function Documentation

◆ run()

def lsst.ip.diffim.dipoleFitTask.DipoleFitTask.run	(		self,
			sources,
			exposure,
			posExp = `None`,
			negExp = `None`,
		**	kwargs
	)

Run dipole measurement and classification

Parameters
----------
sources : `lsst.afw.table.SourceCatalog`
    ``diaSources`` that will be measured using dipole measurement
exposure : `lsst.afw.image.Exposure`
    The difference exposure on which the ``diaSources`` of the ``sources`` parameter
    were detected. If neither ``posExp`` nor ``negExp`` are set, then the dipole is also
    fitted directly to this difference image.
posExp : `lsst.afw.image.Exposure`, optional
    "Positive" exposure, typically a science exposure, or None if unavailable
    When `posExp` is `None`, will compute `posImage = exposure + negExp`.
negExp : `lsst.afw.image.Exposure`, optional
    "Negative" exposure, typically a template exposure, or None if unavailable
    When `negExp` is `None`, will compute `negImage = posExp - exposure`.
**kwargs
    Additional keyword arguments for `lsst.meas.base.sfm.SingleFrameMeasurementTask`.

Definition at line 150 of file dipoleFitTask.py.

     def run(self, sources, exposure, posExp=None, negExp=None, **kwargs):
         """Run dipole measurement and classification
  
         Parameters
         ----------
         sources : `lsst.afw.table.SourceCatalog`
             ``diaSources`` that will be measured using dipole measurement
         exposure : `lsst.afw.image.Exposure`
             The difference exposure on which the ``diaSources`` of the ``sources`` parameter
             were detected. If neither ``posExp`` nor ``negExp`` are set, then the dipole is also
             fitted directly to this difference image.
         posExp : `lsst.afw.image.Exposure`, optional
             "Positive" exposure, typically a science exposure, or None if unavailable
             When `posExp` is `None`, will compute `posImage = exposure + negExp`.
         negExp : `lsst.afw.image.Exposure`, optional
             "Negative" exposure, typically a template exposure, or None if unavailable
             When `negExp` is `None`, will compute `negImage = posExp - exposure`.
         **kwargs
             Additional keyword arguments for `lsst.meas.base.sfm.SingleFrameMeasurementTask`.
         """
  
         measBase.SingleFrameMeasurementTask.run(self, sources, exposure, **kwargs)
  
         if not sources:
             return
  
         for source in sources:
             self.dipoleFitter.measure(source, exposure, posExp, negExp)
  
  

Member Data Documentation

◆ ConfigClass

lsst.ip.diffim.dipoleFitTask.DipoleFitTask.ConfigClass = DipoleFitTaskConfig

static

Definition at line 137 of file dipoleFitTask.py.

◆ dipoleFitter

lsst.ip.diffim.dipoleFitTask.DipoleFitTask.dipoleFitter

Definition at line 146 of file dipoleFitTask.py.

The documentation for this class was generated from the following file:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/ip_diffim/22.0.1-24-g1ad7a390+a9625a72a8/python/lsst/ip/diffim/dipoleFitTask.py

Public Member Functions

Public Attributes

Static Public Attributes