lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask Class Reference

Inheritance diagram for lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask:

Public Member Functions
def	__init__ (self, butler=None, **kwargs)
def	runDataRef (self, butler)
def	generateTractOutputProducts (self, butler, tract, visitCat, zptCat, atmCat, stdCat, fgcmBuildStarsConfig, fgcmFitCycleConfig)

Public Attributes
	indexer
	visitDataRefName
	ccdDataRefName
	filterMap
	configBands
	bands

Static Public Attributes
	ConfigClass = FgcmOutputProductsConfig
	RunnerClass = FgcmOutputProductsRunner

Detailed Description

Output products from FGCM global calibration.

Definition at line 242 of file fgcmOutputProducts.py.

Constructor & Destructor Documentation

__init__()

def lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.__init__	(		self,
			butler = None,
		**	kwargs
	)

Instantiate an fgcmOutputProductsTask.

Parameters
----------
butler : `lsst.daf.persistence.Butler`

Definition at line 251 of file fgcmOutputProducts.py.

    def __init__(self, butler=None, **kwargs):
        """
        Instantiate an fgcmOutputProductsTask.
 
        Parameters
        ----------
        butler : `lsst.daf.persistence.Butler`
        """
 
        pipeBase.CmdLineTask.__init__(self, **kwargs)
 
        if self.config.doReferenceCalibration:
            # We need the ref obj loader to get the flux field
            self.makeSubtask("refObjLoader", butler=butler)
 
        if self.config.doRefcatOutput:
            self.indexer = IndexerRegistry[self.config.datasetConfig.indexer.name](
                self.config.datasetConfig.indexer.active)
 

Member Function Documentation

generateTractOutputProducts()

def lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.generateTractOutputProducts	(		self,
			butler,
			tract,
			visitCat,
			zptCat,
			atmCat,
			stdCat,
			fgcmBuildStarsConfig,
			fgcmFitCycleConfig
	)

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
----------
butler: `lsst.daf.persistence.Butler`
tract: `int`
   Tract number
visitCat: `lsst.afw.table.BaseCatalog`
   FGCM visitCat from `FgcmBuildStarsTask`
zptCat: `lsst.afw.table.BaseCatalog`
   FGCM zeropoint catalog from `FgcmFitCycleTask`
atmCat: `lsst.afw.table.BaseCatalog`
   FGCM atmosphere parameter catalog from `FgcmFitCycleTask`
stdCat: `lsst.afw.table.SimpleCatalog`
   FGCM standard star catalog from `FgcmFitCycleTask`
fgcmBuildStarsConfig: `lsst.fgcmcal.FgcmBuildStarsConfig`
   Configuration object from `FgcmBuildStarsTask`
fgcmFitCycleConfig: `lsst.fgcmcal.FgcmFitCycleConfig`
   Configuration object from `FgcmFitCycleTask`

Definition at line 399 of file fgcmOutputProducts.py.

    def generateTractOutputProducts(self, butler, tract,
                                    visitCat, zptCat, atmCat, stdCat,
                                    fgcmBuildStarsConfig, fgcmFitCycleConfig):
        """
        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
        ----------
        butler: `lsst.daf.persistence.Butler`
        tract: `int`
           Tract number
        visitCat: `lsst.afw.table.BaseCatalog`
           FGCM visitCat from `FgcmBuildStarsTask`
        zptCat: `lsst.afw.table.BaseCatalog`
           FGCM zeropoint catalog from `FgcmFitCycleTask`
        atmCat: `lsst.afw.table.BaseCatalog`
           FGCM atmosphere parameter catalog from `FgcmFitCycleTask`
        stdCat: `lsst.afw.table.SimpleCatalog`
           FGCM standard star catalog from `FgcmFitCycleTask`
        fgcmBuildStarsConfig: `lsst.fgcmcal.FgcmBuildStarsConfig`
           Configuration object from `FgcmBuildStarsTask`
        fgcmFitCycleConfig: `lsst.fgcmcal.FgcmFitCycleConfig`
           Configuration object from `FgcmFitCycleTask`
        """
 
        self.configBands = fgcmFitCycleConfig.bands
        self.visitDataRefName = fgcmBuildStarsConfig.visitDataRefName
        self.ccdDataRefName = fgcmBuildStarsConfig.ccdDataRefName
        self.filterMap = fgcmBuildStarsConfig.filterMap
 
        if stdCat is not None:
            md = stdCat.getMetadata()
            self.bands = md.getArray('BANDS')
        else:
            self.bands = self.configBands
 
        if self.config.doReferenceCalibration and fgcmFitCycleConfig.doReferenceCalibration:
            self.log.warn("doReferenceCalibration is set, and is possibly redundant with "
                          "fitCycleConfig.doReferenceCalibration")
 
        if self.config.doComposeWcsJacobian and not fgcmBuildStarsConfig.doApplyWcsJacobian:
            raise RuntimeError("Cannot compose the WCS jacobian if it hasn't been applied "
                               "in fgcmBuildStarsTask.")
 
        if not self.config.doComposeWcsJacobian and fgcmBuildStarsConfig.doApplyWcsJacobian:
            self.log.warn("Jacobian was applied in build-stars but doComposeWcsJacobian is not set.")
 
        if self.config.doReferenceCalibration:
            offsets = self._computeReferenceOffsets(butler, stdCat)
        else:
            offsets = np.zeros(len(self.bands))
 
        if self.config.doRefcatOutput:
            # Create a special config that has the tract number in it
            datasetConfig = copy.copy(self.config.datasetConfig)
            datasetConfig.ref_dataset_name = '%s_%d' % (self.config.datasetConfig.ref_dataset_name,
                                                        tract)
            self._outputStandardStars(butler, stdCat, offsets, datasetConfig)
 
        if self.config.doZeropointOutput:
            self._outputZeropoints(butler, zptCat, visitCat, offsets, tract=tract)
 
        if self.config.doAtmosphereOutput:
            self._outputAtmospheres(butler, atmCat, tract=tract)
 
        return pipeBase.Struct(offsets=offsets)
 

runDataRef()

def lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.runDataRef	(		self,
			butler
	)

Make FGCM output products for use in the stack

Parameters
----------
butler:  `lsst.daf.persistence.Butler`
cycleNumber: `int`
   Final fit cycle number, override config.

Returns
-------
offsets: `lsst.pipe.base.Struct`
   A structure with array of zeropoint offsets

Raises
------
RuntimeError:
   Raised if any one of the following is true:

   - butler cannot find "fgcmBuildStars_config" or
     "fgcmBuildStarsTable_config".
   - butler cannot find "fgcmFitCycle_config".
   - "fgcmFitCycle_config" does not refer to
     `self.config.cycleNumber`.
   - butler cannot find "fgcmAtmosphereParameters" and
     `self.config.doAtmosphereOutput` is `True`.
   - butler cannot find "fgcmStandardStars" and
     `self.config.doReferenceCalibration` is `True` or
     `self.config.doRefcatOutput` is `True`.
   - butler cannot find "fgcmZeropoints" and
     `self.config.doZeropointOutput` is `True`.

Definition at line 275 of file fgcmOutputProducts.py.

    def runDataRef(self, butler):
        """
        Make FGCM output products for use in the stack
 
        Parameters
        ----------
        butler:  `lsst.daf.persistence.Butler`
        cycleNumber: `int`
           Final fit cycle number, override config.
 
        Returns
        -------
        offsets: `lsst.pipe.base.Struct`
           A structure with array of zeropoint offsets
 
        Raises
        ------
        RuntimeError:
           Raised if any one of the following is true:
 
           - butler cannot find "fgcmBuildStars_config" or
             "fgcmBuildStarsTable_config".
           - butler cannot find "fgcmFitCycle_config".
           - "fgcmFitCycle_config" does not refer to
             `self.config.cycleNumber`.
           - butler cannot find "fgcmAtmosphereParameters" and
             `self.config.doAtmosphereOutput` is `True`.
           - butler cannot find "fgcmStandardStars" and
             `self.config.doReferenceCalibration` is `True` or
             `self.config.doRefcatOutput` is `True`.
           - butler cannot find "fgcmZeropoints" and
             `self.config.doZeropointOutput` is `True`.
        """
 
        # Check to make sure that the fgcmBuildStars config exists, to retrieve
        # the visit and ccd dataset tags
        if not butler.datasetExists('fgcmBuildStarsTable_config') and \
                not butler.datasetExists('fgcmBuildStars_config'):
            raise RuntimeError("Cannot find fgcmBuildStarsTable_config or fgcmBuildStars_config, "
                               "which is prereq for fgcmOutputProducts")
 
        if butler.datasetExists('fgcmBuildStarsTable_config'):
            fgcmBuildStarsConfig = butler.get('fgcmBuildStarsTable_config')
        else:
            fgcmBuildStarsConfig = butler.get('fgcmBuildStars_config')
        self.visitDataRefName = fgcmBuildStarsConfig.visitDataRefName
        self.ccdDataRefName = fgcmBuildStarsConfig.ccdDataRefName
        self.filterMap = fgcmBuildStarsConfig.filterMap
 
        if self.config.doComposeWcsJacobian and not fgcmBuildStarsConfig.doApplyWcsJacobian:
            raise RuntimeError("Cannot compose the WCS jacobian if it hasn't been applied "
                               "in fgcmBuildStarsTask.")
 
        if not self.config.doComposeWcsJacobian and fgcmBuildStarsConfig.doApplyWcsJacobian:
            self.log.warn("Jacobian was applied in build-stars but doComposeWcsJacobian is not set.")
 
        # Make sure that the fit config exists, to retrieve bands and other info
        if not butler.datasetExists('fgcmFitCycle_config', fgcmcycle=self.config.cycleNumber):
            raise RuntimeError("Cannot find fgcmFitCycle_config from cycle %d " % (self.config.cycleNumber) +
                               "which is required for fgcmOutputProducts.")
 
        fitCycleConfig = butler.get('fgcmFitCycle_config', fgcmcycle=self.config.cycleNumber)
        self.configBands = fitCycleConfig.bands
 
        if self.config.doReferenceCalibration and fitCycleConfig.doReferenceCalibration:
            self.log.warn("doReferenceCalibration is set, and is possibly redundant with "
                          "fitCycleConfig.doReferenceCalibration")
 
        # And make sure that the atmosphere was output properly
        if (self.config.doAtmosphereOutput and
                not butler.datasetExists('fgcmAtmosphereParameters', fgcmcycle=self.config.cycleNumber)):
            raise RuntimeError("Atmosphere parameters are missing for cycle %d." %
                               (self.config.cycleNumber))
 
        if ((self.config.doReferenceCalibration or self.config.doRefcatOutput) and
                (not butler.datasetExists('fgcmStandardStars',
                                          fgcmcycle=self.config.cycleNumber))):
            raise RuntimeError("Standard stars are missing for cycle %d." %
                               (self.config.cycleNumber))
 
        if (self.config.doZeropointOutput and
                (not butler.datasetExists('fgcmZeropoints', fgcmcycle=self.config.cycleNumber))):
            raise RuntimeError("Zeropoints are missing for cycle %d." %
                               (self.config.cycleNumber))
 
        # And make sure this is the last cycle
        if butler.datasetExists('fgcmFitCycle_config', fgcmcycle=self.config.cycleNumber + 1):
            raise RuntimeError("The task fgcmOutputProducts should only be run"
                               "on the final fit cycle products")
 
        if self.config.doReferenceCalibration or self.config.doRefcatOutput:
            stdCat = butler.get('fgcmStandardStars', fgcmcycle=self.config.cycleNumber)
            md = stdCat.getMetadata()
            self.bands = md.getArray('BANDS')
        else:
            stdCat = None
            self.bands = self.configBands
 
        if self.config.doReferenceCalibration:
            offsets = self._computeReferenceOffsets(butler, stdCat)
        else:
            offsets = np.zeros(len(self.bands))
 
        # Output the standard stars in stack format
        if self.config.doRefcatOutput:
            self._outputStandardStars(butler, stdCat, offsets, self.config.datasetConfig)
 
        del stdCat
 
        # Output the gray zeropoints
        if self.config.doZeropointOutput:
            zptCat = butler.get('fgcmZeropoints', fgcmcycle=self.config.cycleNumber)
            visitCat = butler.get('fgcmVisitCatalog')
 
            self._outputZeropoints(butler, zptCat, visitCat, offsets)
 
        # Output the atmospheres
        if self.config.doAtmosphereOutput:
            atmCat = butler.get('fgcmAtmosphereParameters', fgcmcycle=self.config.cycleNumber)
            self._outputAtmospheres(butler, atmCat)
 
        # We return the zp offsets
        return pipeBase.Struct(offsets=offsets)
 

Member Data Documentation

bands

lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.bands

Definition at line 368 of file fgcmOutputProducts.py.

ccdDataRefName

lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.ccdDataRefName

Definition at line 321 of file fgcmOutputProducts.py.

configBands

lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.configBands

Definition at line 337 of file fgcmOutputProducts.py.

ConfigClass

lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.ConfigClass = FgcmOutputProductsConfig

static

Definition at line 247 of file fgcmOutputProducts.py.

filterMap

lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.filterMap

Definition at line 322 of file fgcmOutputProducts.py.

indexer

lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.indexer

Definition at line 267 of file fgcmOutputProducts.py.

RunnerClass

lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.RunnerClass = FgcmOutputProductsRunner

static

Definition at line 248 of file fgcmOutputProducts.py.

visitDataRefName

lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask.visitDataRefName

Definition at line 320 of file fgcmOutputProducts.py.

---

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

• /j/snowflake/release/lsstsw/stack/0.1.5/Linux64/fgcmcal/21.0.0-4-g8a80011+f67daf2f53/python/lsst/fgcmcal/fgcmOutputProducts.py