lsst.ip.diffim g9c4eec70e9+fd16635e23
Loading...
Searching...
No Matches
Public Member Functions | List of all members
lsst.ip.diffim.dipoleMeasurement.DipoleAnalysis Class Reference
Inheritance diagram for lsst.ip.diffim.dipoleMeasurement.DipoleAnalysis:

Public Member Functions

 __init__ (self)
 
 __call__ (self, source)
 
 getSn (self, source)
 
 getCentroid (self, source)
 
 getOrientation (self, source)
 
 displayDipoles (self, exposure, sources)
 

Detailed Description

Functor class that provides (S/N, position, orientation) of measured dipoles

Definition at line 168 of file dipoleMeasurement.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.ip.diffim.dipoleMeasurement.DipoleAnalysis.__init__ ( self)

Definition at line 171 of file dipoleMeasurement.py.

Member Function Documentation

◆ __call__()

lsst.ip.diffim.dipoleMeasurement.DipoleAnalysis.__call__ ( self,
source )
Parse information returned from dipole measurement

Parameters
----------
source : `lsst.afw.table.SourceRecord`
    The source that will be examined

Definition at line 174 of file dipoleMeasurement.py.

◆ displayDipoles()

lsst.ip.diffim.dipoleMeasurement.DipoleAnalysis.displayDipoles ( self,
exposure,
sources )
Display debugging information on the detected dipoles

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Image the dipoles were measured on
sources : `lsst.afw.table.SourceCatalog`
    The set of diaSources that were measured

Definition at line 240 of file dipoleMeasurement.py.

◆ getCentroid()

lsst.ip.diffim.dipoleMeasurement.DipoleAnalysis.getCentroid ( self,
source )
Get the centroid of the dipole; average of positive and negative lobe

Parameters
----------
source : `lsst.afw.table.SourceRecord`
    The source that will be examined

Definition at line 202 of file dipoleMeasurement.py.

◆ getOrientation()

lsst.ip.diffim.dipoleMeasurement.DipoleAnalysis.getOrientation ( self,
source )
Calculate the orientation of dipole; vector from negative to positive lobe

Parameters
----------
source : `lsst.afw.table.SourceRecord`
    The source that will be examined

Definition at line 221 of file dipoleMeasurement.py.

◆ getSn()

lsst.ip.diffim.dipoleMeasurement.DipoleAnalysis.getSn ( self,
source )
Get the total signal-to-noise of the dipole; total S/N is from positive and negative lobe

Parameters
----------
source : `lsst.afw.table.SourceRecord`
    The source that will be examined

Definition at line 183 of file dipoleMeasurement.py.


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