lsst.ip.diffim gc0f3af6251+39f4c7265c
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | Static Protected Attributes | List of all members
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.

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.

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: