lsst.fgcmcal¶
The lsst.fgcmcal module runs the Forward Global Calibration Method (FGCM) to perform global photometric survey calibration for LSST. Please see Burke, Rykoff, et al. 2018 for the paper describing the method. This lsst.fgcmcal package wraps the third-party package fgcm.
Using lsst.fgcmcal¶
Please see the cookbook for a runthrough on how to use lsst.fgcmcal.
There are four tasks to be run in a typical global fgcmcal processing chain. They are:
- Make a look-up table: FgcmMakeLutTask
- Build the star lists: FgcmBuildStarsTask
- Run the fitter: FgcmFitCycleTask
- Output the final products: FgcmOutputProductsTask
Alternatively, fgcmcal can be run on a single tract (with multi-band coverage), although the results will not be as robust as a full global calibration. This can be run with FgcmCalibrateTractTask, which will run all of the tasks above except for the making of the look-up table.
Contributing¶
lsst.fgcmcal is developed at https://github.com/lsst/fgcmcal. You can find Jira issues for this module under the fgcmcal component.
Command-line tasks¶
- FgcmBuildStarsTask
- Build stars for the FGCM global calibration
- FgcmCalibrateTractTask
- Calibrate a single tract using fgcmcal
- FgcmFitCycleTask
- Run Single fit cycle for FGCM global calibration
- FgcmMakeLutTask
- Make Look-Up Table for FGCM.
- FgcmOutputProductsTask
- Output products from FGCM global calibration.
Configurations¶
- FgcmBuildStarsConfig
- Config for FgcmBuildStarsTask
- FgcmCalibrateTractConfig
- Config for FgcmCalibrateTract
- FgcmFitCycleConfig
- Config for FgcmFitCycle
- FgcmLoadReferenceCatalogConfig
- Config for FgcmLoadReferenceCatalogTask
- FgcmMakeLutConfig
- Config for FgcmMakeLutTask
- FgcmOutputProductsConfig
- Config for FgcmOutputProductsTask
- Sedboundaryterm
- SED boundary term for a pair of bands.
- SedboundarytermDict
- A mapping of Sedboundaryterm name to Sedterm.
- Sedterm
- SED term for a single band.
- SedtermDict
- A mapping of bands to Sedterms.
Python API reference¶
lsst.fgcmcal Package¶
Classes¶
FgcmBuildStarsConfig |
Config for FgcmBuildStarsTask |
FgcmBuildStarsRunner(TaskClass, parsedCmd[, …]) |
Subclass of TaskRunner for fgcmBuildStarsTask |
FgcmBuildStarsTask([butler]) |
Build stars for the FGCM global calibration |
FgcmCalibrateTractConfig |
Config for FgcmCalibrateTract |
FgcmCalibrateTractRunner(TaskClass, parsedCmd) |
Subclass of TaskRunner for FgcmCalibrateTractTask |
FgcmCalibrateTractTask([butler]) |
Calibrate a single tract using fgcmcal |
FgcmFitCycleConfig |
Config for FgcmFitCycle |
FgcmFitCycleRunner(TaskClass, parsedCmd[, …]) |
Subclass of TaskRunner for fgcmFitCycleTask |
FgcmFitCycleTask([butler]) |
Run Single fit cycle for FGCM global calibration |
FgcmLoadReferenceCatalogConfig |
Config for FgcmLoadReferenceCatalogTask |
FgcmLoadReferenceCatalogTask(butler, *args, …) |
Load multi-band reference objects from a reference catalog. |
FgcmMakeLutConfig |
Config for FgcmMakeLutTask |
FgcmMakeLutParametersConfig |
Config for parameters if atmosphereTableName not available |
FgcmMakeLutRunner(TaskClass, parsedCmd[, …]) |
Subclass of TaskRunner for fgcmMakeLutTask |
FgcmMakeLutTask([butler]) |
Make Look-Up Table for FGCM. |
FgcmOutputProductsConfig |
Config for FgcmOutputProductsTask |
FgcmOutputProductsRunner(TaskClass, parsedCmd) |
Subclass of TaskRunner for fgcmOutputProductsTask |
FgcmOutputProductsTask([butler]) |
Output products from FGCM global calibration. |
Sedboundaryterm |
SED boundary term for a pair of bands. |
SedboundarytermDict |
A mapping of Sedboundaryterm name to Sedterm. |
Sedterm |
SED term for a single band. |
SedtermDict |
A mapping of bands to Sedterms. |