lsst.pipe.tasks  20.0.0-46-gd70f10e1+f17cbaf3d1
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.makeCoaddTempExp.MakeCoaddTempExpTask Class Reference

Warp and optionally PSF-Match calexps onto an a common projection. More...

Inheritance diagram for lsst.pipe.tasks.makeCoaddTempExp.MakeCoaddTempExpTask:
lsst.pipe.tasks.coaddBase.CoaddBaseTask

Public Member Functions

def __init__ (self, reuse=False, **kwargs)
 
def runDataRef (self, patchRef, selectDataList=[])
 Produce <coaddName>Coadd_<warpType>Warp images by warping and optionally PSF-matching. More...
 
def run (self, calExpList, ccdIdList, skyInfo, visitId=0, dataIdList=None)
 
def getCalibratedExposure (self, dataRef, bgSubtracted)
 
def getWarpTypeList (self)
 
def applySkyCorr (self, dataRef, calexp)
 
def selectExposures (self, patchRef, skyInfo=None, selectDataList=[])
 Select exposures to coadd. More...
 
def getSkyInfo (self, patchRef)
 Use getSkyinfo to return the skyMap, tract and patch information, wcs and the outer bbox of the patch. More...
 
def getCoaddDatasetName (self, warpType="direct")
 
def getTempExpDatasetName (self, warpType="direct")
 
def getBadPixelMask (self)
 Convenience method to provide the bitmask from the mask plane names. More...
 

Public Attributes

 reuse
 
 calexpType
 

Static Public Attributes

 ConfigClass
 
 RunnerClass
 

Detailed Description

Warp and optionally PSF-Match calexps onto an a common projection.

Contents

Description

Warp and optionally PSF-Match calexps onto a common projection, by performing the following operations:

The result is a directWarp (and/or optionally a psfMatchedWarp).

Task Initialization

This task has one special keyword argument: passing reuse=True will cause the task to skip the creation of warps that are already present in the output repositories.

Invoking the Task

This task is primarily designed to be run from the command line.

The main method is runDataRef, which takes a single butler data reference for the patch(es) to process.

Create a Warp from inputs

We iterate over the multiple calexps in a single exposure to construct
the warp (previously called a coaddTempExp) of that exposure to the
supplied tract/patch.

Pixels that receive no pixels are set to NAN; this is not correct
(violates LSST algorithms group policy), but will be fixed up by
interpolating after the coaddition.

@param calexpRefList: List of data references for calexps that (may)
    overlap the patch of interest
@param skyInfo: Struct from CoaddBaseTask.getSkyInfo() with geometric
    information about the patch
@param visitId: integer identifier for visit, for the table that will
    produce the CoaddPsf
@return a pipeBase Struct containing:
  - exposures: a dictionary containing the warps requested:
"direct": direct warp if config.makeDirect
"psfMatched": PSF-matched warp if config.makePsfMatched

WarpType identifies the types of convolutions applied to Warps (previously CoaddTempExps). Only two types are available: direct (for regular Warps/Coadds) and psfMatched (for Warps/Coadds with homogenized PSFs). We expect to add a third type, likelihood, for generating likelihood Coadds with Warps that have been correlated with their own PSF.

Configuration parameters

See MakeCoaddTempExpConfig and parameters inherited from CoaddBaseConfig

Guide to PSF-Matching Configs

To make psfMatchedWarps, select config.makePsfMatched=True. The subtask ModelPsfMatchTask is responsible for the PSF-Matching, and its config is accessed via config.warpAndPsfMatch.psfMatch. The optimal configuration depends on aspects of dataset: the pixel scale, average PSF FWHM and dimensions of the PSF kernel. These configs include the requested model PSF, the matching kernel size, padding of the science PSF thumbnail and spatial sampling frequency of the PSF.

Config Guidelines: The user must specify the size of the model PSF to which to match by setting config.modelPsf.defaultFwhm in units of pixels. The appropriate values depends on science case. In general, for a set of input images, this config should equal the FWHM of the visit with the worst seeing. The smallest it should be set to is the median FWHM. The defaults of the other config options offer a reasonable starting point. The following list presents the most common problems that arise from a misconfigured ModelPsfMatchTask and corresponding solutions. All assume the default Alard-Lupton kernel, with configs accessed via config.warpAndPsfMatch.psfMatch.kernel['AL']. Each item in the list is formatted as: Problem: Explanation. Solution

Troublshooting PSF-Matching Configuration:

Debug variables

MakeCoaddTempExpTask has no debug output, but its subtasks do.

A complete example of using MakeCoaddTempExpTask

This example uses the package ci_hsc to show how MakeCoaddTempExp fits into the larger Data Release Processing. Set up by running:

setup ci_hsc
cd $CI_HSC_DIR
# if not built already:
python $(which scons)  # this will take a while

The following assumes that processCcd.py and makeSkyMap.py have previously been run (e.g. by building ci_hsc above) to generate a repository of calexps and an output respository with the desired SkyMap. The command,

makeCoaddTempExp.py $CI_HSC_DIR/DATA --rerun ci_hsc \
 --id patch=5,4 tract=0 filter=HSC-I \
 --selectId visit=903988 ccd=16 --selectId visit=903988 ccd=17 \
 --selectId visit=903988 ccd=23 --selectId visit=903988 ccd=24 \
 --config doApplyExternalPhotoCalib=False doApplyExternalSkyWcs=False \
 makePsfMatched=True modelPsf.defaultFwhm=11

writes a direct and PSF-Matched Warp to

Note
PSF-Matching in this particular dataset would benefit from adding --configfile ./matchingConfig.py to the command line arguments where matchingConfig.py is defined by:
echo "
config.warpAndPsfMatch.psfMatch.kernel['AL'].kernelSize=27
config.warpAndPsfMatch.psfMatch.kernel['AL'].alardSigGauss=[1.5, 3.0, 6.0]" > matchingConfig.py

Add the option --help to see more options.

Definition at line 116 of file makeCoaddTempExp.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.makeCoaddTempExp.MakeCoaddTempExpTask.__init__ (   self,
  reuse = False,
**  kwargs 
)

Definition at line 274 of file makeCoaddTempExp.py.

Member Function Documentation

◆ applySkyCorr()

def lsst.pipe.tasks.makeCoaddTempExp.MakeCoaddTempExpTask.applySkyCorr (   self,
  dataRef,
  calexp 
)
Apply correction to the sky background level

Sky corrections can be generated with the 'skyCorrection.py'
executable in pipe_drivers. Because the sky model used by that
code extends over the entire focal plane, this can produce
better sky subtraction.

The calexp is updated in-place.

Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
    Data reference for calexp.
calexp : `lsst.afw.image.Exposure` or `lsst.afw.image.MaskedImage`
    Calibrated exposure.

Definition at line 550 of file makeCoaddTempExp.py.

◆ getBadPixelMask()

def lsst.pipe.tasks.coaddBase.CoaddBaseTask.getBadPixelMask (   self)
inherited

Convenience method to provide the bitmask from the mask plane names.

Definition at line 229 of file coaddBase.py.

◆ getCalibratedExposure()

def lsst.pipe.tasks.makeCoaddTempExp.MakeCoaddTempExpTask.getCalibratedExposure (   self,
  dataRef,
  bgSubtracted 
)
Return one calibrated Exposure, possibly with an updated SkyWcs.

@param[in] dataRef        a sensor-level data reference
@param[in] bgSubtracted   return calexp with background subtracted? If False get the
                  calexp's background background model and add it to the calexp.
@return calibrated exposure

@raises MissingExposureError If data for the exposure is not available.

If config.doApplyExternalPhotoCalib is `True`, the photometric calibration
(`photoCalib`) is taken from `config.externalPhotoCalibName` via the
`name_photoCalib` dataset.  Otherwise, the photometric calibration is
retrieved from the processed exposure.  When
`config.doApplyExternalSkyWcs` is `True`, the astrometric calibration
is taken from `config.externalSkyWcsName` with the `name_wcs` dataset.
Otherwise, the astrometric calibration is taken from the processed
exposure.

Definition at line 481 of file makeCoaddTempExp.py.

◆ getCoaddDatasetName()

def lsst.pipe.tasks.coaddBase.CoaddBaseTask.getCoaddDatasetName (   self,
  warpType = "direct" 
)
inherited
Return coadd name for given warpType and task config

Parameters
----------
warpType : string
    Either 'direct' or 'psfMatched'

Returns
-------
CoaddDatasetName : `string`

Definition at line 180 of file coaddBase.py.

◆ getSkyInfo()

def lsst.pipe.tasks.coaddBase.CoaddBaseTask.getSkyInfo (   self,
  patchRef 
)
inherited

Use getSkyinfo to return the skyMap, tract and patch information, wcs and the outer bbox of the patch.

Parameters
[in]patchRefdata reference for sky map. Must include keys "tract" and "patch"
Returns
pipe_base Struct containing:
  • skyMap: sky map
  • tractInfo: information for chosen tract of sky map
  • patchInfo: information about chosen patch of tract
  • wcs: WCS of tract
  • bbox: outer bbox of patch, as an geom Box2I

Definition at line 164 of file coaddBase.py.

◆ getTempExpDatasetName()

def lsst.pipe.tasks.coaddBase.CoaddBaseTask.getTempExpDatasetName (   self,
  warpType = "direct" 
)
inherited
Return warp name for given warpType and task config

Parameters
----------
warpType : string
    Either 'direct' or 'psfMatched'

Returns
-------
WarpDatasetName : `string`

Definition at line 194 of file coaddBase.py.

◆ getWarpTypeList()

def lsst.pipe.tasks.makeCoaddTempExp.MakeCoaddTempExpTask.getWarpTypeList (   self)
Return list of requested warp types per the config.

Definition at line 540 of file makeCoaddTempExp.py.

◆ run()

def lsst.pipe.tasks.makeCoaddTempExp.MakeCoaddTempExpTask.run (   self,
  calExpList,
  ccdIdList,
  skyInfo,
  visitId = 0,
  dataIdList = None 
)
Create a Warp from inputs

We iterate over the multiple calexps in a single exposure to construct
the warp (previously called a coaddTempExp) of that exposure to the
supplied tract/patch.

Pixels that receive no pixels are set to NAN; this is not correct
(violates LSST algorithms group policy), but will be fixed up by
interpolating after the coaddition.

@param calexpRefList: List of data references for calexps that (may)
    overlap the patch of interest
@param skyInfo: Struct from CoaddBaseTask.getSkyInfo() with geometric
    information about the patch
@param visitId: integer identifier for visit, for the table that will
    produce the CoaddPsf
@return a pipeBase Struct containing:
  - exposures: a dictionary containing the warps requested:
"direct": direct warp if config.makeDirect
"psfMatched": PSF-matched warp if config.makePsfMatched

Definition at line 384 of file makeCoaddTempExp.py.

◆ runDataRef()

def lsst.pipe.tasks.makeCoaddTempExp.MakeCoaddTempExpTask.runDataRef (   self,
  patchRef,
  selectDataList = [] 
)

Produce <coaddName>Coadd_<warpType>Warp images by warping and optionally PSF-matching.

Parameters
[in]patchRefdata reference for sky map patch. Must include keys "tract", "patch", plus the camera-specific filter key (e.g. "filter" or "band")
Returns
: dataRefList: a list of data references for the new <coaddName>Coadd_directWarps if direct or both warp types are requested and <coaddName>Coadd_psfMatchedWarps if only psfMatched warps are requested.
Warning
: this task assumes that all exposures in a warp (coaddTempExp) have the same filter.
: this task sets the PhotoCalib of the coaddTempExp to the PhotoCalib of the first calexp with any good pixels in the patch. For a mosaic camera the resulting PhotoCalib should be ignored (assembleCoadd should determine zeropoint scaling without referring to it).

Definition at line 284 of file makeCoaddTempExp.py.

◆ selectExposures()

def lsst.pipe.tasks.coaddBase.CoaddBaseTask.selectExposures (   self,
  patchRef,
  skyInfo = None,
  selectDataList = [] 
)
inherited

Select exposures to coadd.

Get the corners of the bbox supplied in skyInfo using geom::Box2D and convert the pixel positions of the bbox corners to sky coordinates using skyInfo.wcs.pixelToSky. Use the WcsSelectImagesTask to select exposures that lie inside the patch indicated by the dataRef.

Parameters
[in]patchRefdata reference for sky map patch. Must include keys "tract", "patch", plus the camera-specific filter key (e.g. "filter" or "band")
[in]skyInfogeometry for the patch; output from getSkyInfo
Returns
a list of science exposures to coadd, as butler data references

Definition at line 144 of file coaddBase.py.

Member Data Documentation

◆ calexpType

lsst.pipe.tasks.makeCoaddTempExp.MakeCoaddTempExpTask.calexpType

Definition at line 279 of file makeCoaddTempExp.py.

◆ ConfigClass

lsst.pipe.tasks.makeCoaddTempExp.MakeCoaddTempExpTask.ConfigClass
static

Definition at line 271 of file makeCoaddTempExp.py.

◆ reuse

lsst.pipe.tasks.makeCoaddTempExp.MakeCoaddTempExpTask.reuse

Definition at line 276 of file makeCoaddTempExp.py.

◆ RunnerClass

lsst.pipe.tasks.coaddBase.CoaddBaseTask.RunnerClass
staticinherited

Definition at line 137 of file coaddBase.py.


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