lsst.ip.diffim.dipoleFitTask.DipoleFitTask Class Reference

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

Public Member Functions
	__init__ (self, schema, algMetadata=None, **kwargs)
	run (self, sources, exposure, posExp=None, negExp=None, **kwargs)

Public Attributes
	plugins_pre
	plugins_post
	dipoleFit
	plugins

Static Public Attributes
	ConfigClass = DipoleFitTaskConfig

Static Protected Attributes
str	_DefaultName = "dipoleFit"

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 127 of file dipoleFitTask.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 139 of file dipoleFitTask.py.

    def __init__(self, schema, algMetadata=None, **kwargs):
        super().__init__(schema, algMetadata, **kwargs)
 
        # Enforce a specific plugin order, so that DipoleFit can fall back on
        # SdssCentroid for non-dipoles
        self.plugins_pre = self.plugins.copy()
        self.plugins_post = self.plugins.copy()
        self.plugins_pre.clear()
        self.plugins_pre["base_SdssCentroid"] = self.plugins["base_SdssCentroid"]
        self.plugins_post.pop("base_SdssCentroid")
        self.dipoleFit = self.plugins_post.pop("ip_diffim_DipoleFit")
        del self.plugins
 

Member Function Documentation

run()

lsst.ip.diffim.dipoleFitTask.DipoleFitTask.run	(		self,
			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
----------
sources : `lsst.afw.table.SourceCatalog`
    ``diaSources`` that will be measured using dipole measurement.
exposure : `lsst.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.
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 153 of file dipoleFitTask.py.

    def run(self, 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
        ----------
        sources : `lsst.afw.table.SourceCatalog`
            ``diaSources`` that will be measured using dipole measurement.
        exposure : `lsst.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.
        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`.
        """
        # Run plugins in a very specific order, so DipoleFitPlugin has a
        # centroid to fall back on.
        self.plugins = self.plugins_pre
        super().run(sources, exposure, **kwargs)
 
        for source in sources:
            self.dipoleFit.measureDipoles(source, exposure, posExp, negExp)
        # Use the new DipoleFit outputs for subsequent measurements, now that
        # non-dipoles have been filled in with the earlier centroid values.
        sources.schema.getAliasMap().set("slot_Centroid", "ip_diffim_DipoleFit")
 
        self.plugins = self.plugins_post
        super().run(sources, exposure, **kwargs)
 
 

Member Data Documentation

_DefaultName

str lsst.ip.diffim.dipoleFitTask.DipoleFitTask._DefaultName = "dipoleFit"

staticprotected

Definition at line 137 of file dipoleFitTask.py.

ConfigClass

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

static

Definition at line 136 of file dipoleFitTask.py.

dipoleFit

lsst.ip.diffim.dipoleFitTask.DipoleFitTask.dipoleFit

Definition at line 149 of file dipoleFitTask.py.

plugins

lsst.ip.diffim.dipoleFitTask.DipoleFitTask.plugins

Definition at line 179 of file dipoleFitTask.py.

plugins_post

lsst.ip.diffim.dipoleFitTask.DipoleFitTask.plugins_post

Definition at line 145 of file dipoleFitTask.py.

plugins_pre

lsst.ip.diffim.dipoleFitTask.DipoleFitTask.plugins_pre

Definition at line 144 of file dipoleFitTask.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/ip_diffim/g1470d8bcf6+cbe83ee85a/python/lsst/ip/diffim/dipoleFitTask.py