|
def | fgcmMakeAllStarObservations (self, groupedDataRefs, visitCat, sourceSchema, camera, calibFluxApertureRadius=None, visitCatDataRef=None, starObsDataRef=None, inStarObsCat=None) |
|
def | runDataRef (self, butler, dataRefs) |
|
def | fgcmMakeVisitCatalog (self, camera, groupedDataRefs, bkgDataRefDict=None, visitCatDataRef=None, inVisitCat=None) |
|
def | fgcmMatchStars (self, visitCat, obsCat, lutDataRef=None) |
|
Build stars for the FGCM global calibration, using src catalogs.
Definition at line 91 of file fgcmBuildStars.py.
◆ fgcmMakeAllStarObservations()
def lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsTask.fgcmMakeAllStarObservations |
( |
|
self, |
|
|
|
groupedDataRefs, |
|
|
|
visitCat, |
|
|
|
sourceSchema, |
|
|
|
camera, |
|
|
|
calibFluxApertureRadius = None , |
|
|
|
visitCatDataRef = None , |
|
|
|
starObsDataRef = None , |
|
|
|
inStarObsCat = None |
|
) |
| |
Compile all good star observations from visits in visitCat. Checkpoint files
will be stored if both visitCatDataRef and starObsDataRef are not None.
Parameters
----------
groupedDataRefs : `dict` of `list`s
Lists of `~lsst.daf.persistence.ButlerDataRef` or
`~lsst.daf.butler.DeferredDatasetHandle`, grouped by visit.
visitCat : `~afw.table.BaseCatalog`
Catalog with visit data for FGCM
sourceSchema : `~lsst.afw.table.Schema`
Schema for the input src catalogs.
camera : `~lsst.afw.cameraGeom.Camera`
calibFluxApertureRadius : `float`, optional
Aperture radius for calibration flux.
visitCatDataRef : `~lsst.daf.persistence.ButlerDataRef`, optional
Dataref to write visitCat for checkpoints
starObsDataRef : `~lsst.daf.persistence.ButlerDataRef`, optional
Dataref to write the star observation catalog for checkpoints.
inStarObsCat : `~afw.table.BaseCatalog`
Input observation catalog. If this is incomplete, observations
will be appended from when it was cut off.
Returns
-------
fgcmStarObservations : `afw.table.BaseCatalog`
Full catalog of good observations.
Raises
------
RuntimeError: Raised if doSubtractLocalBackground is True and
calibFluxApertureRadius is not set.
Reimplemented from lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.
Definition at line 180 of file fgcmBuildStars.py.
◆ fgcmMakeVisitCatalog()
def lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.fgcmMakeVisitCatalog |
( |
|
self, |
|
|
|
camera, |
|
|
|
groupedDataRefs, |
|
|
|
bkgDataRefDict = None , |
|
|
|
visitCatDataRef = None , |
|
|
|
inVisitCat = None |
|
) |
| |
|
inherited |
Make a visit catalog with all the keys from each visit
Parameters
----------
camera: `lsst.afw.cameraGeom.Camera`
Camera from the butler
groupedDataRefs: `dict`
Dictionary with visit keys, and `list`s of
`lsst.daf.persistence.ButlerDataRef`
bkgDataRefDict: `dict`, optional
Dictionary of gen3 dataRefHandles for background info.
visitCatDataRef: `lsst.daf.persistence.ButlerDataRef`, optional
Dataref to write visitCat for checkpoints
inVisitCat: `afw.table.BaseCatalog`, optional
Input (possibly incomplete) visit catalog
Returns
-------
visitCat: `afw.table.BaseCatalog`
Definition at line 460 of file fgcmBuildStarsBase.py.
◆ fgcmMatchStars()
def lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.fgcmMatchStars |
( |
|
self, |
|
|
|
visitCat, |
|
|
|
obsCat, |
|
|
|
lutDataRef = None |
|
) |
| |
|
inherited |
Use FGCM code to match observations into unique stars.
Parameters
----------
visitCat: `afw.table.BaseCatalog`
Catalog with visit data for fgcm
obsCat: `afw.table.BaseCatalog`
Full catalog of star observations for fgcm
lutDataRef: `lsst.daf.persistence.ButlerDataRef` or
`lsst.daf.butler.DeferredDatasetHandle`, optional
Data reference to fgcm look-up table (used if matching reference stars).
Returns
-------
fgcmStarIdCat: `afw.table.BaseCatalog`
Catalog of unique star identifiers and index keys
fgcmStarIndicesCat: `afwTable.BaseCatalog`
Catalog of unique star indices
fgcmRefCat: `afw.table.BaseCatalog`
Catalog of matched reference stars.
Will be None if `config.doReferenceMatches` is False.
Definition at line 687 of file fgcmBuildStarsBase.py.
◆ runDataRef()
def lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.runDataRef |
( |
|
self, |
|
|
|
butler, |
|
|
|
dataRefs |
|
) |
| |
|
inherited |
Cross-match and make star list for FGCM Input
Parameters
----------
butler: `lsst.daf.persistence.Butler`
dataRefs: `list` of `lsst.daf.persistence.ButlerDataRef`
Source data references for the input visits.
Raises
------
RuntimeErrror: Raised if `config.doReferenceMatches` is set and
an fgcmLookUpTable is not available, or if computeFluxApertureRadius()
fails if the calibFlux is not a CircularAperture flux.
Definition at line 296 of file fgcmBuildStarsBase.py.
◆ ConfigClass
◆ RunnerClass
The documentation for this class was generated from the following file: