lsst.ip.diffim  13.0-26-g703d095+10
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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__
 Constructor. More...
 
def __call__
 Parse information returned from dipole measurement. More...
 
def getSn
 Get the total signal-to-noise of the dipole; total S/N is from positive and negative lobe. More...
 
def getCentroid
 Get the centroid of the dipole; average of positive and negative lobe. More...
 
def getOrientation
 Calculate the orientation of dipole; vector from negative to positive lobe. More...
 
def displayDipoles
 Display debugging information on the detected dipoles. More...
 

Detailed Description

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

Definition at line 338 of file dipoleMeasurement.py.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 341 of file dipoleMeasurement.py.

Member Function Documentation

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 345 of file dipoleMeasurement.py.

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 399 of file dipoleMeasurement.py.

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 367 of file dipoleMeasurement.py.

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 383 of file dipoleMeasurement.py.

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 351 of file dipoleMeasurement.py.


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