DipoleFitTask¶
-
class
lsst.ip.diffim.
DipoleFitTask
(schema, algMetadata=None, **kwds)¶ Bases:
lsst.meas.base.sfm.SingleFrameMeasurementTask
!Subclass of SingleFrameMeasurementTask which accepts up to three input images in its run() method.
Because it subclasses SingleFrameMeasurementTask, and calls SingleFrameMeasurementTask.run() from its run() method, it still can be used identically to a standard SingleFrameMeasurementTask.
Methods Summary
run
(sources, exposure[, posExp, negExp])!Run dipole measurement and classification Methods Documentation
-
run
(sources, exposure, posExp=None, negExp=None, **kwds)¶ !Run dipole measurement and classification
@param sources diaSources that will be measured using dipole measurement @param exposure Difference exposure on which the diaSources were detected; exposure = posExp - negExp @param posExp “Positive” exposure, typically a science exposure, or None if unavailable @param negExp “Negative” exposure, typically a template exposure, or None if unavailable @param **kwds Sent to SingleFrameMeasurementTask
@note When
posExp
isNone
, will computeposImage = exposure + negExp
. Likewise, whennegExp
isNone
, will computenegImage = posExp - exposure
. If bothposExp
andnegExp
areNone
, will attempt to fit the dipole to just theexposure
with no constraint.
-