lsst.ip.diffim  16.0-9-g1de645c+7
Public Member Functions | List of all members
lsst.ip.diffim.dipoleMeasurement.DipoleAnalysis Class Reference

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

Inheritance diagram for lsst.ip.diffim.dipoleMeasurement.DipoleAnalysis:

Public Member Functions

def __init__ (self)
 Constructor. More...
 
def __call__ (self, source)
 Parse information returned from dipole measurement. More...
 
def getSn (self, source)
 Get the total signal-to-noise of the dipole; total S/N is from positive and negative lobe. More...
 
def getCentroid (self, source)
 Get the centroid of the dipole; average of positive and negative lobe. More...
 
def getOrientation (self, source)
 Calculate the orientation of dipole; vector from negative to positive lobe. More...
 
def displayDipoles (self, exposure, sources)
 Display debugging information on the detected dipoles. More...
 

Detailed Description

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

Definition at line 335 of file dipoleMeasurement.py.

Constructor & Destructor Documentation

◆ __init__()

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

Constructor.

Definition at line 338 of file dipoleMeasurement.py.

Member Function Documentation

◆ __call__()

def lsst.ip.diffim.dipoleMeasurement.DipoleAnalysis.__call__ (   self,
  source 
)

Parse information returned from dipole measurement.

Parameters
sourceThe source that will be examined

Definition at line 342 of file dipoleMeasurement.py.

◆ displayDipoles()

def lsst.ip.diffim.dipoleMeasurement.DipoleAnalysis.displayDipoles (   self,
  exposure,
  sources 
)

Display debugging information on the detected dipoles.

Parameters
exposureImage the dipoles were measured on
sourcesThe set of diaSources that were measured

Definition at line 396 of file dipoleMeasurement.py.

◆ getCentroid()

def lsst.ip.diffim.dipoleMeasurement.DipoleAnalysis.getCentroid (   self,
  source 
)

Get the centroid of the dipole; average of positive and negative lobe.

Parameters
sourceThe source that will be examined

Definition at line 364 of file dipoleMeasurement.py.

◆ getOrientation()

def lsst.ip.diffim.dipoleMeasurement.DipoleAnalysis.getOrientation (   self,
  source 
)

Calculate the orientation of dipole; vector from negative to positive lobe.

Parameters
sourceThe source that will be examined

Definition at line 380 of file dipoleMeasurement.py.

◆ getSn()

def 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
sourceThe source that will be examined

Definition at line 348 of file dipoleMeasurement.py.


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