lsst.ip.diffim g180d380827+5d634bbe79
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
lsst.ip.diffim.utils.DipoleTestImage Class Reference

Public Member Functions

 __init__ (self, w=101, h=101, xcenPos=[27.], ycenPos=[25.], xcenNeg=[23.], ycenNeg=[25.], psfSigma=2., flux=[30000.], fluxNeg=None, noise=10., gradientParams=None)
 
 fitDipoleSource (self, source, **kwds)
 
 detectDipoleSources (self, doMerge=True, diffim=None, detectSigma=5.5, grow=3, minBinSize=32)
 

Public Attributes

 w
 
 h
 
 xcenPos
 
 ycenPos
 
 xcenNeg
 
 ycenNeg
 
 psfSigma
 
 flux
 
 fluxNeg
 
 noise
 
 gradientParams
 
 diffim
 
 posImage
 
 posCatalog
 
 negImage
 

Protected Member Functions

 _makeDipoleImage (self)
 
 _makeStarImage (self, xc=[15.3], yc=[18.6], flux=[2500], schema=None, randomSeed=None)
 

Detailed Description

Utility class for dipole measurement testing.

Generate an image with simulated dipoles and noise; store the original
"pre-subtraction" images and catalogs as well.
Used to generate test data for DMTN-007 (http://dmtn-007.lsst.io).

Definition at line 709 of file utils.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.ip.diffim.utils.DipoleTestImage.__init__ ( self,
w = 101,
h = 101,
xcenPos = [27.],
ycenPos = [25.],
xcenNeg = [23.],
ycenNeg = [25.],
psfSigma = 2.,
flux = [30000.],
fluxNeg = None,
noise = 10.,
gradientParams = None )

Definition at line 717 of file utils.py.

Member Function Documentation

◆ _makeDipoleImage()

lsst.ip.diffim.utils.DipoleTestImage._makeDipoleImage ( self)
protected
Generate an exposure and catalog with the given dipole source(s).

Definition at line 734 of file utils.py.

◆ _makeStarImage()

lsst.ip.diffim.utils.DipoleTestImage._makeStarImage ( self,
xc = [15.3],
yc = [18.6],
flux = [2500],
schema = None,
randomSeed = None )
protected
Generate an exposure and catalog with the given stellar source(s).

Definition at line 751 of file utils.py.

◆ detectDipoleSources()

lsst.ip.diffim.utils.DipoleTestImage.detectDipoleSources ( self,
doMerge = True,
diffim = None,
detectSigma = 5.5,
grow = 3,
minBinSize = 32 )
Utility function for detecting dipoles.

Detect pos/neg sources in the diffim, then merge them. A
bigger "grow" parameter leads to a larger footprint which
helps with dipole measurement for faint dipoles.

Parameters
----------
doMerge : `bool`
   Whether to merge the positive and negagive detections into a single
   source table.
diffim : `lsst.afw.image.exposure.exposure.ExposureF`
   Difference image on which to perform detection.
detectSigma : `float`
   Threshold for object detection.
grow : `int`
   Number of pixels to grow the footprints before merging.
minBinSize : `int`
   Minimum bin size for the background (re)estimation (only applies if
   the default leads to min(nBinX, nBinY) < fit order so the default
   config parameter needs to be decreased, but not to a value smaller
   than ``minBinSize``, in which case the fitting algorithm will take
   over and decrease the fit order appropriately.)

Returns
-------
sources : `lsst.afw.table.SourceCatalog`
   If doMerge=True, the merged source catalog is returned OR
detectTask : `lsst.meas.algorithms.SourceDetectionTask`
schema : `lsst.afw.table.Schema`
   If doMerge=False, the source detection task and its schema are
   returned.

Definition at line 781 of file utils.py.

◆ fitDipoleSource()

lsst.ip.diffim.utils.DipoleTestImage.fitDipoleSource ( self,
source,
** kwds )

Definition at line 776 of file utils.py.

Member Data Documentation

◆ diffim

lsst.ip.diffim.utils.DipoleTestImage.diffim

Definition at line 748 of file utils.py.

◆ flux

lsst.ip.diffim.utils.DipoleTestImage.flux

Definition at line 726 of file utils.py.

◆ fluxNeg

lsst.ip.diffim.utils.DipoleTestImage.fluxNeg

Definition at line 727 of file utils.py.

◆ gradientParams

lsst.ip.diffim.utils.DipoleTestImage.gradientParams

Definition at line 731 of file utils.py.

◆ h

lsst.ip.diffim.utils.DipoleTestImage.h

Definition at line 720 of file utils.py.

◆ negImage

lsst.ip.diffim.utils.DipoleTestImage.negImage

Definition at line 748 of file utils.py.

◆ noise

lsst.ip.diffim.utils.DipoleTestImage.noise

Definition at line 730 of file utils.py.

◆ posCatalog

lsst.ip.diffim.utils.DipoleTestImage.posCatalog

Definition at line 748 of file utils.py.

◆ posImage

lsst.ip.diffim.utils.DipoleTestImage.posImage

Definition at line 748 of file utils.py.

◆ psfSigma

lsst.ip.diffim.utils.DipoleTestImage.psfSigma

Definition at line 725 of file utils.py.

◆ w

lsst.ip.diffim.utils.DipoleTestImage.w

Definition at line 719 of file utils.py.

◆ xcenNeg

lsst.ip.diffim.utils.DipoleTestImage.xcenNeg

Definition at line 723 of file utils.py.

◆ xcenPos

lsst.ip.diffim.utils.DipoleTestImage.xcenPos

Definition at line 721 of file utils.py.

◆ ycenNeg

lsst.ip.diffim.utils.DipoleTestImage.ycenNeg

Definition at line 724 of file utils.py.

◆ ycenPos

lsst.ip.diffim.utils.DipoleTestImage.ycenPos

Definition at line 722 of file utils.py.


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