lsst.ip.diffim  14.0-9-g330837b+3
Public Member Functions | Public Attributes | Static Public Attributes | Static Private Attributes | List of all members
lsst.ip.diffim.dipoleFitTask.DipoleFitTask Class Reference

Subclass of SingleFrameMeasurementTask which accepts up to three input images in its run() method. More...

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

Public Member Functions

def __init__ (self, schema, algMetadata=None, kwds)
 
def run (self, sources, exposure, posExp=None, negExp=None, kwds)
 Run dipole measurement and classification. More...
 

Public Attributes

 dipoleFitter
 

Static Public Attributes

 ConfigClass = DipoleFitTaskConfig
 

Static Private Attributes

string _DefaultName = "ip_diffim_DipoleFit"
 

Detailed Description

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.

Definition at line 134 of file dipoleFitTask.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 145 of file dipoleFitTask.py.

Member Function Documentation

◆ run()

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

Run dipole measurement and classification.

Parameters
sourcesdiaSources that will be measured using dipole measurement
exposureDifference exposure on which the diaSources were detected; exposure = posExp - negExp
posExp"Positive" exposure, typically a science exposure, or None if unavailable
negExp"Negative" exposure, typically a template exposure, or None if unavailable
**kwdsSent to SingleFrameMeasurementTask
Note
When posExp is None, will compute posImage = exposure + negExp. Likewise, when negExp is None, will compute negImage = posExp - exposure. If both posExp and negExp are None, will attempt to fit the dipole to just the exposure with no constraint.

Definition at line 155 of file dipoleFitTask.py.

Member Data Documentation

◆ _DefaultName

string lsst.ip.diffim.dipoleFitTask.DipoleFitTask._DefaultName = "ip_diffim_DipoleFit"
staticprivate

Definition at line 143 of file dipoleFitTask.py.

◆ ConfigClass

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

Definition at line 142 of file dipoleFitTask.py.

◆ dipoleFitter

lsst.ip.diffim.dipoleFitTask.DipoleFitTask.dipoleFitter

Definition at line 151 of file dipoleFitTask.py.


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