lsst.ip.diffim  22.0.1-21-g5bd0cb7e+4ed22470fa
Public Member Functions | Public Attributes | List of all members
lsst.ip.diffim.utils.DipoleTestImage Class Reference
Inheritance diagram for lsst.ip.diffim.utils.DipoleTestImage:

Public Member Functions

def __init__ (self, w=101, h=101, xcenPos=[27.], ycenPos=[25.], xcenNeg=[23.], ycenNeg=[25.], psfSigma=2., flux=[30000.], fluxNeg=None, noise=10., gradientParams=None)
 
def fitDipoleSource (self, source, **kwds)
 
def 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
 

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 924 of file utils.py.

Constructor & Destructor Documentation

◆ __init__()

def 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 932 of file utils.py.

Member Function Documentation

◆ detectDipoleSources()

def 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 1005 of file utils.py.

◆ fitDipoleSource()

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

Definition at line 1000 of file utils.py.

Member Data Documentation

◆ flux

lsst.ip.diffim.utils.DipoleTestImage.flux

Definition at line 941 of file utils.py.

◆ fluxNeg

lsst.ip.diffim.utils.DipoleTestImage.fluxNeg

Definition at line 942 of file utils.py.

◆ gradientParams

lsst.ip.diffim.utils.DipoleTestImage.gradientParams

Definition at line 946 of file utils.py.

◆ h

lsst.ip.diffim.utils.DipoleTestImage.h

Definition at line 935 of file utils.py.

◆ noise

lsst.ip.diffim.utils.DipoleTestImage.noise

Definition at line 945 of file utils.py.

◆ psfSigma

lsst.ip.diffim.utils.DipoleTestImage.psfSigma

Definition at line 940 of file utils.py.

◆ w

lsst.ip.diffim.utils.DipoleTestImage.w

Definition at line 934 of file utils.py.

◆ xcenNeg

lsst.ip.diffim.utils.DipoleTestImage.xcenNeg

Definition at line 938 of file utils.py.

◆ xcenPos

lsst.ip.diffim.utils.DipoleTestImage.xcenPos

Definition at line 936 of file utils.py.

◆ ycenNeg

lsst.ip.diffim.utils.DipoleTestImage.ycenNeg

Definition at line 939 of file utils.py.

◆ ycenPos

lsst.ip.diffim.utils.DipoleTestImage.ycenPos

Definition at line 937 of file utils.py.


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