FgcmOutputProductsTask¶
FgcmOutputProductsTask uses the output from FgcmFitCycleTask to generate a full suite of output products (photometric calibration files, fgcm_photoCalib; atmosphere transmissions, transmission_atmosphere_fgcm; and standard star calibrated reference catalogs ref_cat) for use in downstream processing.
This is the fourth and final task in a typical fgcmcal processing chain. The first is FgcmMakeLutTask, the second is FgcmBuildStarsTableTask or FgcmBuildStarsTask, and the third is FgcmFitCycleTask.
FgcmOutputProductsTask is available as a command-line task, fgcmOutputProducts.py.
Processing summary¶
FgcmOutputProductsTask reads in outputs from FgcmFitCycleTask, with the cycleNumber specified in the config file, translates these tables to formats used by coaddition and other downstream processing.
fgcmOutputProducts.py command-line interface¶
Note that no --id arguments are used by fgcmOutputProducts.py.
fgcmOutputProducts.py REPOPATH [@file [@file2 ...]] [--output OUTPUTREPO | --rerun RERUN] [--config cycleNumber=finalCycleNumber] [other options]
Key arguments:
REPOPATH- The input Butler repository’s URI or file path.
Key options:
--config cycleNumber=finalCycleNumer:- The
cycleNumberused for theisFinalCyclerun of FgcmFitCycleTask
See also
See Command-line task argument reference for details and additional options.
Python API summary¶
from lsst.fgcmcal.fgcmOutputProducts import FgcmOutputProductsTask
-
class
FgcmOutputProductsTask Output products from FGCM global calibration
...
-
attribute
config Access configuration fields and retargetable subtasks.
-
method
run Run the output products task
...
-
method
runDataRef Make FGCM output products for use in the stack
...
See also
See the FgcmOutputProductsTask API reference for complete details.
Butler datasets¶
When run as the fgcmOutputProducts.py command-line task, or directly through the runDataRef method, FgcmOutputProductsTask obtains datasets from the input Butler data repository and persists outputs to the output Butler data repository.
Note that configurations for FgcmOutputProductsTask, and its subtasks, affect what datasets are persisted and what their content is.
Input datasets¶
fgcmStandardStars- Catalog of standard stars from fit.
fgcmZeropoints- Catalog of zero-point information.
fgcmAtmosphereParameters- Catalog of atmosphere parameters.
fgcmBuildStars_configorfgcmBuildStarsTable_config- Configuration of task used to build stars for the
fgcmcalrun. Only one should be available depending on the specific task used. fgcmFitCycle_config- Configuration of FgcmFitCycleTask used for the final fit cycle.
Output datasets¶
fgcm_stars- Reference catalog of standard stars.
fgcm_photoCalib- One
fgcm_photoCalibphotometric calibration file is output for each visit / ccd. transmission_atmosphere_fgcm- One atmospheric transmission curve is output for each visit.
The reference catalog (fgcm_stars) is an lsst.afw.table.SimpleCatalog that can be used as a reference catalog, including band_flux and band_fluxErr measurements per band (in nJy), as well as additional information including band_nGood (the number of photometric observations per band), band_nTotal (the total number of observations per band), and band_nPsfCandidate (the number of observations per band that were flagged as PSF candidates).
Retargetable subtasks¶
photoCal¶
- Default
lsst.pipe.tasks.photoCal.PhotoCalTask- Field type
ConfigurableField
refObjLoader¶
- Default
lsst.meas.algorithms.loadIndexedReferenceObjects.LoadIndexedReferenceObjectsTask- Field type
ConfigurableField
Configuration fields¶
connections¶
- Data type
lsst.pipe.base.config.Connections- Field type
ConfigField
datasetConfig¶
- Data type
lsst.meas.algorithms.ingestIndexReferenceTask.DatasetConfig- Field type
ConfigField