lsst.fgcmcal gb8350603e9+867a44b1a3
|
Functions | |
makeConfigDict (config, log, camera, maxIter, resetFitParameters, outputZeropoints, lutFilterNames, tract=None) | |
translateFgcmLut (lutCat, physicalFilterMap) | |
translateVisitCatalog (visitCat) | |
computeReferencePixelScale (camera) | |
computeApproxPixelAreaFields (camera) | |
makeZptSchema (superStarChebyshevSize, zptChebyshevSize) | |
makeZptCat (zptSchema, zpStruct) | |
makeAtmSchema () | |
makeAtmCat (atmSchema, atmStruct) | |
makeStdSchema (nBands) | |
makeStdCat (stdSchema, stdStruct, goodBands) | |
computeApertureRadiusFromName (fluxField) | |
extractReferenceMags (refStars, bands, filterMap) | |
lookupStaticCalibrations (datasetType, registry, quantumDataId, collections) | |
Variables | |
str | FGCM_EXP_FIELD = 'VISIT' |
str | FGCM_CCD_FIELD = 'DETECTOR' |
float | FGCM_ILLEGAL_VALUE = -9999.0 |
Utility functions for fgcmcal. This file contains utility functions that are used by more than one task, and do not need to be part of a task.
lsst.fgcmcal.utilities.computeApertureRadiusFromName | ( | fluxField | ) |
Compute the radius associated with a CircularApertureFlux or ApFlux field. Parameters ---------- fluxField : `str` CircularApertureFlux or ApFlux Returns ------- apertureRadius : `float` Radius of the aperture field, in pixels. Raises ------ RuntimeError: Raised if flux field is not a CircularApertureFlux, ApFlux, or apFlux.
Definition at line 774 of file utilities.py.
lsst.fgcmcal.utilities.computeApproxPixelAreaFields | ( | camera | ) |
Compute the approximate pixel area bounded fields from the camera geometry. Parameters ---------- camera: `lsst.afw.cameraGeom.Camera` Returns ------- approxPixelAreaFields: `dict` Dictionary of approximate area fields, keyed with detector ID
Definition at line 456 of file utilities.py.
lsst.fgcmcal.utilities.computeReferencePixelScale | ( | camera | ) |
Compute the median pixel scale in the camera Returns ------- pixelScale: `float` Average pixel scale (arcsecond) over the camera
Definition at line 428 of file utilities.py.
lsst.fgcmcal.utilities.extractReferenceMags | ( | refStars, | |
bands, | |||
filterMap ) |
Extract reference magnitudes from refStars for given bands and associated filterMap. Parameters ---------- refStars : `astropy.table.Table` or `lsst.afw.table.BaseCatalog` FGCM reference star catalog. bands : `list` List of bands for calibration. filterMap: `dict` FGCM mapping of filter to band. Returns ------- refMag : `np.ndarray` nstar x nband array of reference magnitudes. refMagErr : `np.ndarray` nstar x nband array of reference magnitude errors.
Definition at line 804 of file utilities.py.
lsst.fgcmcal.utilities.lookupStaticCalibrations | ( | datasetType, | |
registry, | |||
quantumDataId, | |||
collections ) |
Definition at line 863 of file utilities.py.
lsst.fgcmcal.utilities.makeAtmCat | ( | atmSchema, | |
atmStruct ) |
Make the atmosphere catalog for persistence Parameters ---------- atmSchema: `lsst.afw.table.Schema` Atmosphere catalog schema atmStruct: `numpy.ndarray` Atmosphere structure from fgcm Returns ------- atmCat: `lsst.afw.table.BaseCatalog` Atmosphere catalog for persistence
Definition at line 666 of file utilities.py.
lsst.fgcmcal.utilities.makeAtmSchema | ( | ) |
Make the atmosphere schema Returns ------- atmSchema: `lsst.afw.table.Schema`
Definition at line 642 of file utilities.py.
lsst.fgcmcal.utilities.makeConfigDict | ( | config, | |
log, | |||
camera, | |||
maxIter, | |||
resetFitParameters, | |||
outputZeropoints, | |||
lutFilterNames, | |||
tract = None ) |
Make the FGCM fit cycle configuration dict Parameters ---------- config: `lsst.fgcmcal.FgcmFitCycleConfig` Configuration object log: `lsst.log.Log` LSST log object camera: `lsst.afw.cameraGeom.Camera` Camera from the butler maxIter: `int` Maximum number of iterations resetFitParameters: `bool` Reset fit parameters before fitting? outputZeropoints: `bool` Compute zeropoints for output? lutFilterNames : array-like, `str` Array of physical filter names in the LUT. tract: `int`, optional Tract number for extending the output file name for debugging. Default is None. Returns ------- configDict: `dict` Configuration dictionary for fgcm
Definition at line 47 of file utilities.py.
lsst.fgcmcal.utilities.makeStdCat | ( | stdSchema, | |
stdStruct, | |||
goodBands ) |
Make the standard star catalog for persistence Parameters ---------- stdSchema: `lsst.afw.table.Schema` Standard star catalog schema stdStruct: `numpy.ndarray` Standard star structure in FGCM format goodBands: `list` List of good band names used in stdStruct Returns ------- stdCat: `lsst.afw.table.BaseCatalog` Standard star catalog for persistence
Definition at line 734 of file utilities.py.
lsst.fgcmcal.utilities.makeStdSchema | ( | nBands | ) |
Make the standard star schema Parameters ---------- nBands: `int` Number of bands in standard star catalog Returns ------- stdSchema: `lsst.afw.table.Schema`
Definition at line 699 of file utilities.py.
lsst.fgcmcal.utilities.makeZptCat | ( | zptSchema, | |
zpStruct ) |
Make the zeropoint catalog for persistence Parameters ---------- zptSchema: `lsst.afw.table.Schema` Zeropoint catalog schema zpStruct: `numpy.ndarray` Zeropoint structure from fgcm Returns ------- zptCat: `afwTable.BaseCatalog` Zeropoint catalog for persistence
Definition at line 587 of file utilities.py.
lsst.fgcmcal.utilities.makeZptSchema | ( | superStarChebyshevSize, | |
zptChebyshevSize ) |
Make the zeropoint schema Parameters ---------- superStarChebyshevSize: `int` Length of the superstar chebyshev array zptChebyshevSize: `int` Length of the zeropoint chebyshev array Returns ------- zptSchema: `lsst.afw.table.schema`
Definition at line 501 of file utilities.py.
lsst.fgcmcal.utilities.translateFgcmLut | ( | lutCat, | |
physicalFilterMap ) |
Translate the FGCM look-up-table into an fgcm-compatible object Parameters ---------- lutCat: `lsst.afw.table.BaseCatalog` Catalog describing the FGCM look-up table physicalFilterMap: `dict` Physical filter to band mapping Returns ------- fgcmLut: `lsst.fgcm.FgcmLut` Lookup table for FGCM lutIndexVals: `numpy.ndarray` Numpy array with LUT index information for FGCM lutStd: `numpy.ndarray` Numpy array with LUT standard throughput values for FGCM Notes ----- After running this code, it is wise to `del lutCat` to clear the memory.
Definition at line 247 of file utilities.py.
lsst.fgcmcal.utilities.translateVisitCatalog | ( | visitCat | ) |
Translate the FGCM visit catalog to an fgcm-compatible object Parameters ---------- visitCat: `lsst.afw.table.BaseCatalog` FGCM visitCat from `lsst.fgcmcal.FgcmBuildStarsTask` Returns ------- fgcmExpInfo: `numpy.ndarray` Numpy array for visit information for FGCM Notes ----- After running this code, it is wise to `del visitCat` to clear the memory.
Definition at line 377 of file utilities.py.
str lsst.fgcmcal.utilities.FGCM_CCD_FIELD = 'DETECTOR' |
Definition at line 43 of file utilities.py.
str lsst.fgcmcal.utilities.FGCM_EXP_FIELD = 'VISIT' |
Definition at line 42 of file utilities.py.
float lsst.fgcmcal.utilities.FGCM_ILLEGAL_VALUE = -9999.0 |
Definition at line 44 of file utilities.py.