DipoleFitTask

class lsst.ip.diffim.DipoleFitTask(schema, algMetadata=None, **kwargs)

Bases: SingleFrameMeasurementTask

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.

Methods Summary

run(sources, exposure[, posExp, negExp])

Run dipole measurement and classification.

Methods Documentation

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

Run dipole measurement and classification.

Run SdssCentroid first, then switch the centroid slot, then DipoleFit then the rest; DipoleFit will fall back on SdssCentroid for sources not containing positive+negative peaks.

Parameters

sourceslsst.afw.table.SourceCatalog

diaSources that will be measured using dipole measurement.

exposurelsst.afw.image.Exposure

The difference exposure on which the sources were detected. If neither posExp nor negExp are set, then the dipole is also fitted directly to this difference image.

posExplsst.afw.image.Exposure, optional

“Positive” exposure, typically a science exposure, or None if unavailable When posExp is None, will compute posImage = exposure + negExp.

negExplsst.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.