FgcmOutputProductsTask

FgcmOutputProductsTask uses the output from FgcmFitCycleTask to generate a full suite of output products (photometric calibration files and atmosphere transmissions) 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 lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsTask, and the third is FgcmFitCycleTask.

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.

Python API summary

from lsst.fgcmcal.fgcmOutputProducts import FgcmOutputProductsTask
classFgcmOutputProductsTask(**kwargs)

Output products from FGCM global calibration...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(handleDict, physicalFilterMap)

Run the output products task...

See also

See the FgcmOutputProductsTask API reference for complete details.

Retargetable subtasks

photoCal

Default
lsst.pipe.tasks.photoCal.PhotoCalTask
Field type
ConfigurableField
task to perform ‘absolute’ calibration

Configuration fields

connections

Data type
lsst.pipe.base.config.Connections
Field type
ConfigField
Configurations describing the connections of the PipelineTask to datatypes

cycleNumber

Default
0
Field type
int Field
Final fit cycle from FGCM fit Deprecated: This config is no longer used, and will be removed after v25. Please set config.connections.cycleNumber directly instead.

doApplyMeanChromaticCorrection

Default
True
Field type
bool Field
Apply the mean chromatic correction to the zeropoints?

doAtmosphereOutput

Default
True
Field type
bool Field
Output atmospheres in transmission_atmosphere_fgcm format

doComposeWcsJacobian

Default
True
Field type
bool Field
Compose Jacobian of WCS with fgcm calibration for output photoCalib?

doReferenceCalibration

Default
False
Field type
bool Field
Transfer ‘absolute’ calibration from reference catalog? This afterburner step is unnecessary if reference stars were used in the full fit in FgcmFitCycleTask.

doZeropointOutput

Default
True
Field type
bool Field
Output zeropoints in fgcm_photoCalib format

physicalFilterMap

Default
{}
Field type
DictField
Key type
str
Value type
str
Mapping from ‘physicalFilter’ to band.

referenceMinMatch

Default
50
Field type
int Field
Minimum number of stars matched to reference catalog to be used in statistics

referencePixelizationMinStars

Default
200
Field type
int Field
Minimum number of stars per healpix pixel to select for comparisonto the specified reference catalog

referencePixelizationNPixels

Default
100
Field type
int Field
Number of healpix pixels to sample to do comparison. Doing too many will take a long time and not yield any more precise results because the final number is the median offset (per band) from the set of pixels.

referencePixelizationNside

Default
64
Field type
int Field
Healpix nside to pixelize catalog to compare to reference catalog

saveLogOutput

Default
True
Field type
bool Field
Flag to enable/disable saving of log output for a task, enabled by default.

saveMetadata

Default
True
Field type
bool Field
Flag to enable/disable metadata saving for a task, enabled by default.