FgcmOutputProductsTask#

class lsst.fgcmcal.FgcmOutputProductsTask(**kwargs)#

Bases: PipelineTask

Output products from FGCM global calibration.

Methods Summary

generateTractOutputProducts(handleDict, ...)

Generate the output products for a given tract, as specified in the config.

run(handleDict, physicalFilterMap)

Run the output products task.

runQuantum(butlerQC, inputRefs, outputRefs)

Do butler IO and transform to provide in memory objects for tasks run method.

Methods Documentation

generateTractOutputProducts(handleDict, tract, visitCat, zptCat, atmCat, stdCat, fgcmBuildStarsConfig)#

Generate the output products for a given tract, as specified in the config.

This method is here to have an alternate entry-point for FgcmCalibrateTract.

Parameters#

handleDictdict

All handles are lsst.daf.butler.DeferredDatasetHandle handle dictionary with keys:

"camera"

Camera object (lsst.afw.cameraGeom.Camera)

"fgcmLookUpTable"

handle for the FGCM look-up table.

tractint

Tract number

visitCatlsst.afw.table.BaseCatalog

FGCM visitCat from FgcmBuildStarsTask

zptCatlsst.afw.table.BaseCatalog

FGCM zeropoint catalog from FgcmFitCycleTask

atmCatlsst.afw.table.BaseCatalog

FGCM atmosphere parameter catalog from FgcmFitCycleTask

stdCatlsst.afw.table.SimpleCatalog

FGCM standard star catalog from FgcmFitCycleTask

fgcmBuildStarsConfiglsst.fgcmcal.FgcmBuildStarsConfig

Configuration object from FgcmBuildStarsTask

Returns#

retStructlsst.pipe.base.Struct

Output structure with keys:

offsetsnp.ndarray

Final reference offsets, per band.

atmospheresgenerator [(int, lsst.afw.image.TransmissionCurve)]

Generator that returns (visit, transmissionCurve) tuples.

photoCalibCatalogsgenerator [(int, lsst.afw.table.ExposureCatalog)]

Generator that returns (visit, exposureCatalog) tuples.

run(handleDict, physicalFilterMap)#

Run the output products task.

Parameters#

handleDictdict

All handles are lsst.daf.butler.DeferredDatasetHandle handle dictionary with keys:

"camera"

Camera object (lsst.afw.cameraGeom.Camera)

"fgcmLookUpTable"

handle for the FGCM look-up table.

"fgcmVisitCatalog"

handle for visit summary catalog.

"fgcmStandardStars"

handle for the output standard star catalog.

"fgcmZeropoints"

handle for the zeropoint data catalog.

"fgcmAtmosphereParameters"

handle for the atmosphere parameter catalog.

"fgcmBuildStarsTableConfig"

Config for lsst.fgcmcal.fgcmBuildStarsTableTask.

"skymap"

Skymap for sharding standard stars (optional).

physicalFilterMapdict

Dictionary of mappings from physical filter to FGCM band.

Returns#

retStructlsst.pipe.base.Struct

Output structure with keys:

offsetsnp.ndarray

Final reference offsets, per band.

atmospheresgenerator [(int, lsst.afw.image.TransmissionCurve)]

Generator that returns (visit, transmissionCurve) tuples.

photoCalibCatalogsgenerator [(int, lsst.afw.table.ExposureCatalog)]

Generator that returns (visit, exposureCatalog) tuples.

runQuantum(butlerQC, inputRefs, outputRefs)#

Do butler IO and transform to provide in memory objects for tasks run method.

Parameters#

butlerQCQuantumContext

A butler which is specialized to operate in the context of a lsst.daf.butler.Quantum.

inputRefsInputQuantizedConnection

Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined input/prerequisite connections.

outputRefsOutputQuantizedConnection

Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined output connections.