lsst.pipe.tasks.mocks.mockCoadd.MockCoaddTask Class Reference

Inheritance diagram for lsst.pipe.tasks.mocks.mockCoadd.MockCoaddTask:

Public Member Functions
def	__init__ (self, **kwds)
def	buildSkyMap (self, butler)
def	buildTruthCatalog (self, butler=None, skyMap=None, tract=0)
def	buildObservationCatalog (self, butler=None, skyMap=None, tract=0, camera=None)
def	buildInputImages (self, butler, obsCatalog=None, truthCatalog=None, tract=0)
def	buildAllInputs (self, butler)
def	makeCoaddTask (self, cls, assemblePsfMatched=False)
def	iterPatchRefs (self, butler, tractInfo)
def	buildCoadd (self, butler, skyMap=None, tract=0)
def	buildMockCoadd (self, butler, truthCatalog=None, skyMap=None, tract=0)

Public Attributes
	schema
	objectIdKey
	exposureIdKey
	centroidInBBoxKey
	partialOverlapKey

Static Public Attributes
	ConfigClass = MockCoaddConfig

Detailed Description

MockCoaddTask is a driver task for creating mock coadds.  As opposed to more realistic
simulations, MockCoadd generates and uses extremely simple "toy" data that can be used to more
rigorously test the behavior of high-level task code because the expected results are
more easily predicted.  In particular, calexps are generated directly from the truth catalog,
and contain only zero-noise stars that are created using the same Psf, PhotoCalib, and Wcs that will
be attached to the mock calexp.

In addition to creating the mock calexps and truth catalogs, MockCoadd also contains driver
code to run the MakeSkyMap, MakeCoaddTempExp, and AssembleCoadd tasks on the mock calexps,
and code to directly create a mock coadd image using CoaddPsf, which can be compared to the
output of the regular coadd tasks to check that the coadd code and CoaddPsf are consistent.

Note that aside from MakeSkyMapTask, the coadd tasks are *not* subtasks of MockCoaddTasks,
and their configs are not part of MockCoaddConfig; these are created locally within
MockCoaddTask methods when needed, as not all coadd task config options are appropriate
for the mock data generated by MockCoadd.

Definition at line 91 of file mockCoadd.py.

Constructor & Destructor Documentation

__init__()

def lsst.pipe.tasks.mocks.mockCoadd.MockCoaddTask.__init__	(		self,
		**	kwds
	)

Construct a MockCoaddTask and the subtasks used for generating skymaps, objects,
and observations (i.e. calexp parameters).

Definition at line 114 of file mockCoadd.py.

    def __init__(self, **kwds):
        """Construct a MockCoaddTask and the subtasks used for generating skymaps, objects,
        and observations (i.e. calexp parameters).
        """
        lsst.pipe.base.CmdLineTask.__init__(self, **kwds)
        self.makeSubtask("makeSkyMap")
        self.makeSubtask("mockObject")
        self.makeSubtask("mockObservation")
        self.schema = lsst.afw.table.SimpleTable.makeMinimalSchema()
        self.objectIdKey = self.schema.addField("objectId", type="L", doc="foreign key to truth catalog")
        self.exposureIdKey = self.schema.addField("exposureId", type="L",
                                                  doc="foreign key to observation catalog")
        self.centroidInBBoxKey = self.schema.addField(
            "centroidInBBox", type="Flag",
            doc="set if this source's center position is inside the generated image's bbox"
        )
        self.partialOverlapKey = self.schema.addField(
            "partialOverlap", type="Flag",
            doc="set if this source was not completely inside the generated image"
        )
 

Member Function Documentation

buildAllInputs()

def lsst.pipe.tasks.mocks.mockCoadd.MockCoaddTask.buildAllInputs	(		self,
			butler
	)

Convenience function that calls buildSkyMap, buildObservationCatalog, buildTruthCatalog,
and buildInputImages.

Definition at line 217 of file mockCoadd.py.

    def buildAllInputs(self, butler):
        """Convenience function that calls buildSkyMap, buildObservationCatalog, buildTruthCatalog,
        and buildInputImages.
        """
        skyMap = self.buildSkyMap(butler)
        observations = self.buildObservationCatalog(butler, skyMap=skyMap)
        truth = self.buildTruthCatalog(butler, skyMap=skyMap)
        self.buildInputImages(butler, obsCatalog=observations, truthCatalog=truth)
 

buildCoadd()

def lsst.pipe.tasks.mocks.mockCoadd.MockCoaddTask.buildCoadd	(		self,
			butler,
			skyMap = None,
			tract = 0
	)

Run the coadd tasks (MakeCoaddTempExp and AssembleCoadd) on the mock data.

Must be run after buildInputImages.
Makes both direct and PSF-matched coadds

Definition at line 270 of file mockCoadd.py.

    def buildCoadd(self, butler, skyMap=None, tract=0):
        """Run the coadd tasks (MakeCoaddTempExp and AssembleCoadd) on the mock data.
 
        Must be run after buildInputImages.
        Makes both direct and PSF-matched coadds
        """
        if skyMap is None:
            skyMap = butler.get(self.config.coaddName + "Coadd_skyMap")
        tractInfo = skyMap[tract]
        makeCoaddTempExpTask = self.makeCoaddTask(MakeCoaddTempExpTask)
        directCoaddTaskList = []
        for coaddTask in [SafeClipAssembleCoaddTask, CompareWarpAssembleCoaddTask, AssembleCoaddTask]:
            directCoaddTaskList.append(self.makeCoaddTask(coaddTask))
        assemblePsfMatchedCoaddTask = self.makeCoaddTask(AssembleCoaddTask, assemblePsfMatched=True)
        for patchRef in self.iterPatchRefs(butler, tractInfo):
            makeCoaddTempExpTask.runDataRef(patchRef)
        for patchRef in self.iterPatchRefs(butler, tractInfo):
            for directCoaddTask in directCoaddTaskList:
                directCoaddTask.runDataRef(patchRef)
            assemblePsfMatchedCoaddTask.runDataRef(patchRef)
 

buildInputImages()

def lsst.pipe.tasks.mocks.mockCoadd.MockCoaddTask.buildInputImages	(		self,
			butler,
			obsCatalog = None,
			truthCatalog = None,
			tract = 0
	)

Use the truth catalog and observation catalog to create and save (if butler is not None)
mock calexps and an ExposureCatalog ('simsrc') that contains information about which objects
appear partially or fully in each exposure.

Must be run after buildTruthCatalog and buildObservationCatalog.

Definition at line 173 of file mockCoadd.py.

    def buildInputImages(self, butler, obsCatalog=None, truthCatalog=None, tract=0):
        """Use the truth catalog and observation catalog to create and save (if butler is not None)
        mock calexps and an ExposureCatalog ('simsrc') that contains information about which objects
        appear partially or fully in each exposure.
 
        Must be run after buildTruthCatalog and buildObservationCatalog.
        """
        if obsCatalog is None:
            obsCatalog = butler.get("observations", tract=tract)
        if truthCatalog is None:
            truthCatalog = butler.get("truth", tract=tract)
        ccdKey = obsCatalog.getSchema().find("ccd").key
        visitKey = obsCatalog.getSchema().find("visit").key
        simSrcCatalog = lsst.afw.table.SimpleCatalog(self.schema)
        for obsRecord in obsCatalog:
            ccd = obsRecord.getI(ccdKey)
            visit = obsRecord.getI(visitKey)
            self.log.info("Generating image for visit={visit}, ccd={ccd}".format(ccd=ccd, visit=visit))
            exposure = lsst.afw.image.ExposureF(obsRecord.getBBox())
            # Apply a tiny offset to the images, so that they have non-zero background.
            # If the image background is identically zero, the calculated variance will be NaN.
            exposure.maskedImage.image.array += 1e-8
            exposure.setPhotoCalib(obsRecord.getPhotoCalib())
            exposure.setWcs(obsRecord.getWcs())
            exposure.setPsf(obsRecord.getPsf())
            exposure.getInfo().setApCorrMap(obsRecord.getApCorrMap())
            exposure.getInfo().setTransmissionCurve(obsRecord.getTransmissionCurve())
            for truthRecord in truthCatalog:
                status = self.mockObject.drawSource(truthRecord, exposure, buffer=self.config.edgeBuffer)
                if status:
                    simSrcRecord = simSrcCatalog.addNew()
                    simSrcRecord.setCoord(truthRecord.getCoord())
                    simSrcRecord.setL(self.objectIdKey, truthRecord.getId())
                    simSrcRecord.setL(self.exposureIdKey, obsRecord.getId())
                    simSrcRecord.setFlag(self.centroidInBBoxKey, obsRecord.contains(truthRecord.getCoord()))
                    simSrcRecord.setFlag(self.partialOverlapKey, status == 1)
                    self.log.info("  added object {id}".format(id=truthRecord.getId()))
            exposure.getMaskedImage().getVariance().set(1.0)
            if butler is not None:
                butler.put(exposure, "calexp", ccd=ccd, visit=visit)
        if butler is not None:
            butler.put(simSrcCatalog, "simsrc", tract=tract)
        return simSrcCatalog
 

buildMockCoadd()

def lsst.pipe.tasks.mocks.mockCoadd.MockCoaddTask.buildMockCoadd	(		self,
			butler,
			truthCatalog = None,
			skyMap = None,
			tract = 0
	)

Directly create a simulation of the coadd, using the CoaddPsf (and ModelPsf)
of the direct (and psfMatched) coadd exposure and the truth catalog.

Must be run after buildCoadd.

Definition at line 291 of file mockCoadd.py.

    def buildMockCoadd(self, butler, truthCatalog=None, skyMap=None, tract=0):
        """Directly create a simulation of the coadd, using the CoaddPsf (and ModelPsf)
        of the direct (and psfMatched) coadd exposure and the truth catalog.
 
        Must be run after buildCoadd.
        """
        if truthCatalog is None:
            truthCatalog = butler.get("truth", tract=tract)
        if skyMap is None:
            skyMap = butler.get(self.config.coaddName + "Coadd_skyMap")
        tractInfo = skyMap[tract]
        for patchRef in self.iterPatchRefs(butler, tractInfo):
            for dataProduct in ["Coadd", "CoaddPsfMatched"]:
                exposure = patchRef.get(self.config.coaddName + dataProduct)
                exposure.getMaskedImage().getImage().set(0.0)
                coaddPsf = lsst.meas.algorithms.CoaddPsf(
                    exposure.getInfo().getCoaddInputs().ccds, exposure.getWcs()
                )
                exposure.setPsf(coaddPsf)
                for truthRecord in truthCatalog:
                    self.mockObject.drawSource(truthRecord, exposure, buffer=0)
                patchRef.put(exposure, self.config.coaddName + dataProduct + "_mock")
 
 

buildObservationCatalog()

def lsst.pipe.tasks.mocks.mockCoadd.MockCoaddTask.buildObservationCatalog	(		self,
			butler = None,
			skyMap = None,
			tract = 0,
			camera = None
	)

Create and save (if butler is not None) an ExposureCatalog of simulated observations,
containing the Psfs, Wcss, PhotoCalibs, etc. of the calexps to be simulated.

Must be run after buildSkyMap.

Most of the work is delegated to the mockObservation subtask.

Definition at line 153 of file mockCoadd.py.

    def buildObservationCatalog(self, butler=None, skyMap=None, tract=0, camera=None):
        """Create and save (if butler is not None) an ExposureCatalog of simulated observations,
        containing the Psfs, Wcss, PhotoCalibs, etc. of the calexps to be simulated.
 
        Must be run after buildSkyMap.
 
        Most of the work is delegated to the mockObservation subtask.
        """
        if skyMap is None:
            skyMap = butler.get(self.config.coaddName + "Coadd_skyMap")
        if camera is None:
            camera = butler.get("camera")
        catalog = self.mockObservation.run(butler=butler,
                                           n=self.config.nObservations, camera=camera,
                                           tractInfo=skyMap[tract])
        catalog.sort()
        if butler is not None:
            butler.put(catalog, "observations", tract=tract)
        return catalog
 

buildSkyMap()

def lsst.pipe.tasks.mocks.mockCoadd.MockCoaddTask.buildSkyMap	(		self,
			butler
	)

Build the skymap for the mock dataset.

Definition at line 135 of file mockCoadd.py.

    def buildSkyMap(self, butler):
        """Build the skymap for the mock dataset."""
        return self.makeSkyMap.runDataRef(butler.dataRef(self.config.coaddName + "Coadd_skyMap")).skyMap
 

buildTruthCatalog()

def lsst.pipe.tasks.mocks.mockCoadd.MockCoaddTask.buildTruthCatalog	(		self,
			butler = None,
			skyMap = None,
			tract = 0
	)

Create and save (if butler is not None) a truth catalog containing all the mock objects.

Must be run after buildSkyMap.

Most of the work is delegated to the mockObject subtask.

Definition at line 139 of file mockCoadd.py.

    def buildTruthCatalog(self, butler=None, skyMap=None, tract=0):
        """Create and save (if butler is not None) a truth catalog containing all the mock objects.
 
        Must be run after buildSkyMap.
 
        Most of the work is delegated to the mockObject subtask.
        """
        if skyMap is None:
            skyMap = butler.get(self.config.coaddName + "Coadd_skyMap")
        catalog = self.mockObject.run(tractInfo=skyMap[tract])
        if butler is not None:
            butler.put(catalog, "truth", tract=tract)
        return catalog
 

iterPatchRefs()

def lsst.pipe.tasks.mocks.mockCoadd.MockCoaddTask.iterPatchRefs	(		self,
			butler,
			tractInfo
	)

Generator that iterates over the patches in a tract, yielding dataRefs.

Definition at line 259 of file mockCoadd.py.

    def iterPatchRefs(self, butler, tractInfo):
        """Generator that iterates over the patches in a tract, yielding dataRefs.
        """
        nPatchX, nPatchY = tractInfo.getNumPatches()
        for iPatchX in range(nPatchX):
            for iPatchY in range(nPatchY):
                patchRef = butler.dataRef(self.config.coaddName + "Coadd",
                                          tract=tractInfo.getId(), patch="%d,%d" % (iPatchX, iPatchY),
                                          filter='r')
                yield patchRef
 

makeCoaddTask()

def lsst.pipe.tasks.mocks.mockCoadd.MockCoaddTask.makeCoaddTask	(		self,
			cls,
			assemblePsfMatched = False
	)

Helper function to create a Coadd task with configuration appropriate for the simulations.

MockCoaddTask does not include MakeCoaddTempExpTask or AssembleCoaddTask as subtasks, because
we want explicit control over their configs, rather than leaving this up to the user.
However, we have to install our own SelectImages task for both of these, so it made sense
to have a single method that would create one of these two tasks, set the config values we
want, and install the custom SelectImagesTask.

Definition at line 226 of file mockCoadd.py.

    def makeCoaddTask(self, cls, assemblePsfMatched=False):
        """Helper function to create a Coadd task with configuration appropriate for the simulations.
 
        MockCoaddTask does not include MakeCoaddTempExpTask or AssembleCoaddTask as subtasks, because
        we want explicit control over their configs, rather than leaving this up to the user.
        However, we have to install our own SelectImages task for both of these, so it made sense
        to have a single method that would create one of these two tasks, set the config values we
        want, and install the custom SelectImagesTask.
        """
        config = cls.ConfigClass()
        config.coaddName = self.config.coaddName
        config.select.retarget(MockSelectImagesTask)
        if cls == MakeCoaddTempExpTask:
            config.bgSubtracted = True
            config.makeDirect = True
            config.makePsfMatched = True
            config.modelPsf.defaultFwhm = 9
            config.modelPsf.addWing = False
            config.warpAndPsfMatch.psfMatch.kernel['AL'].scaleByFwhm = False
            config.warpAndPsfMatch.psfMatch.kernel['AL'].kernelSize = 25
            config.warpAndPsfMatch.psfMatch.kernel['AL'].sizeCellX = 64
            config.warpAndPsfMatch.psfMatch.kernel['AL'].sizeCellY = 64
 
        elif cls in [AssembleCoaddTask, SafeClipAssembleCoaddTask, CompareWarpAssembleCoaddTask]:
            if assemblePsfMatched:
                config.warpType = 'psfMatched'
            if cls != AssembleCoaddTask:
                config.doWrite = False
            if cls == CompareWarpAssembleCoaddTask:
                config.assembleStaticSkyModel.select.retarget(MockSelectImagesTask)
            config.doAttachTransmissionCurve = True
        return cls(config=config)
 

Member Data Documentation

centroidInBBoxKey

lsst.pipe.tasks.mocks.mockCoadd.MockCoaddTask.centroidInBBoxKey

Definition at line 126 of file mockCoadd.py.

ConfigClass

lsst.pipe.tasks.mocks.mockCoadd.MockCoaddTask.ConfigClass = MockCoaddConfig

static

Definition at line 110 of file mockCoadd.py.

exposureIdKey

lsst.pipe.tasks.mocks.mockCoadd.MockCoaddTask.exposureIdKey

Definition at line 124 of file mockCoadd.py.

objectIdKey

lsst.pipe.tasks.mocks.mockCoadd.MockCoaddTask.objectIdKey

Definition at line 123 of file mockCoadd.py.

partialOverlapKey

lsst.pipe.tasks.mocks.mockCoadd.MockCoaddTask.partialOverlapKey

Definition at line 130 of file mockCoadd.py.

schema

lsst.pipe.tasks.mocks.mockCoadd.MockCoaddTask.schema

Definition at line 122 of file mockCoadd.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_tasks/21.0.0-172-gfb10e10a+18fedfabac/python/lsst/pipe/tasks/mocks/mockCoadd.py