lsst.ip.diffim.dipoleMeasurement.DipoleAnalysis Class Reference

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

Public Member Functions
def	__init__ (self)
def	__call__ (self, source)
def	getSn (self, source)
def	getCentroid (self, source)
def	getOrientation (self, source)
def	displayDipoles (self, exposure, sources)

Detailed Description

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

Definition at line 377 of file dipoleMeasurement.py.

Constructor & Destructor Documentation

__init__()

def lsst.ip.diffim.dipoleMeasurement.DipoleAnalysis.__init__

(

self

)

Definition at line 380 of file dipoleMeasurement.py.

Member Function Documentation

__call__()

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

displayDipoles()

def 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 449 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
----------
source : `lsst.afw.table.SourceRecord`
    The source that will be examined

Definition at line 411 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
----------
source : `lsst.afw.table.SourceRecord`
    The source that will be examined

Definition at line 430 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
----------
source : `lsst.afw.table.SourceRecord`
    The source that will be examined

Definition at line 392 of file dipoleMeasurement.py.

---

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

• python/lsst/ip/diffim/dipoleMeasurement.py