DM-22469: Add fgcmcal documentation tree. #32
Conversation
erykoff
force-pushed
the
tickets/DM-22469
branch
from
b98b76f
to
bbbcedf
Compare
|
|
||
| The ``fgcmcal`` code runs on calexp source catalogs from visits constrained by the ``--id`` parameter on the command line. Best results are obtained when ``fgcmcal`` is run with full visits. | ||
|
|
||
| In Gen2, due to limitations of the Gen2 Butler, optimal performance is obtained by specifying a single "reference" ccd on the command line (e.g. ``ccd=13``) and setting the config variable ``checkAllCcds = True`` (which is the default). The alternative is to specify all the desired CCDs and set ``checkAllCcds = False``, e.g., ``ccd=0..8^10..103``. However, this is slower than the first option, and the improvement in speed in the first option is greater the more visits are specified. If instead you want to process all the visits in a rerun selected by filter, field, or some other dataid field, then by using a reference ccd and setting ``checkAllCcds = True`` you can speed things up by a factor of approximately 100 relative to the alternative (naming CCDs specifically). |
There was a problem hiding this comment.
About the Gen2 trick of specifying a single ccd, does it lead to missing the visits of which the specified CCD are missing despite calexp/src of other CCDs exist? If so, it might be worth noting.
| --------------- | ||
|
|
||
| ``ref_cat`` | ||
| Reference catalog of standard stars. |
There was a problem hiding this comment.
ref_cat is quite a grab bag of data that don't follow the "typical" butler dataset management... It might be helpful to have more descriptions what this ref_cat is.
| Reference catalog of standard stars. | ||
| ``fgcm_photoCalib`` | ||
| One ``fgcm_photoCalib`` photometric calibration file is output for each visit / ccd. | ||
| ``transmission_atmosphere_fgcm`` |
There was a problem hiding this comment.
transmission_atmosphere_fgcm or transmission_atmosphere_fgcm_tract?
| Processing summary | ||
| ================== | ||
|
|
||
| ``FgcmFitCycleTask`` reads in the star observations and the look-up table, performs an atmosphere and instrument fit, and outputs fit parameters as well as a comprehensive list of QA plots. If the config option ``isFinalCycle`` is set to ``True`` then additional datafiles are output that are used by :doc:`lsst.fgcmcal.fgcmOutputProducts.FgcmOutputProductsTask`. |
There was a problem hiding this comment.
Might be nice to have more descriptions about how one decides and changes this to be the final cycle. Referring to the cookbook would help already.
|
|
||
| .. _lsst.fgcmcal.fgcmFitCycle.FgcmFitCycleTask-butler-outputs: | ||
|
|
||
| Output datasets |
There was a problem hiding this comment.
I feel the non-butler outputs (new configs and the QA plots) are important for this task but are missing here (reasonably).
Would it be too messy to have a session of "non-butler outputs"? Or perhaps expanding the intro to stress that?
erykoff
force-pushed
the
tickets/DM-22469
branch
2 times, most recently
from
1967dbc
to
9721a06
Compare
Add task and config documentation and fix numpy doc-strings that were causing problems in the automatic parsing.
erykoff
force-pushed
the
tickets/DM-22469
branch
from
9721a06
to
fe6101e
Compare
Add task and config documentation and fix numpy doc-strings that were causing
problems in the automatic parsing.