lsst.fgcmcal
21.0.0-16-g26cb9d6+0e62046db4
|
Functions | |
def | makeConfigDict (config, log, camera, maxIter, resetFitParameters, outputZeropoints, lutFilterNames, tract=None) |
def | translateFgcmLut (lutCat, physicalFilterMap) |
def | translateVisitCatalog (visitCat) |
def | computeCcdOffsets (camera, defaultOrientation) |
def | computeReferencePixelScale (camera) |
def | computeApproxPixelAreaFields (camera) |
def | makeZptSchema (superStarChebyshevSize, zptChebyshevSize) |
def | makeZptCat (zptSchema, zpStruct) |
def | makeAtmSchema () |
def | makeAtmCat (atmSchema, atmStruct) |
def | makeStdSchema (nBands) |
def | makeStdCat (stdSchema, stdStruct, goodBands) |
def | computeApertureRadiusFromDataRef (dataRef, fluxField) |
def | computeApertureRadiusFromName (fluxField) |
def | extractReferenceMags (refStars, bands, filterMap) |
def | lookupStaticCalibrations (datasetType, registry, quantumDataId, collections) |
Variables | |
string | FGCM_EXP_FIELD = 'VISIT' |
string | FGCM_CCD_FIELD = 'DETECTOR' |
def lsst.fgcmcal.utilities.computeApertureRadiusFromDataRef | ( | dataRef, | |
fluxField | |||
) |
Compute the radius associated with a CircularApertureFlux field or associated slot. Parameters ---------- dataRef : `lsst.daf.persistence.ButlerDataRef` or `lsst.daf.butler.DeferredDatasetHandle` fluxField : `str` CircularApertureFlux or associated slot. Returns ------- apertureRadius : `float` Radius of the aperture field, in pixels. Raises ------ RuntimeError: Raised if flux field is not a CircularApertureFlux, ApFlux, or associated slot.
Definition at line 807 of file utilities.py.
def 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 or ApFlux.
Definition at line 852 of file utilities.py.
def 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 494 of file utilities.py.
def lsst.fgcmcal.utilities.computeCcdOffsets | ( | camera, | |
defaultOrientation | |||
) |
Compute the CCD offsets in ra/dec and x/y space Parameters ---------- camera: `lsst.afw.cameraGeom.Camera` defaultOrientation: `float` Default camera orientation (degrees) Returns ------- ccdOffsets: `numpy.ndarray` Numpy array with ccd offset information for input to FGCM. Angular units are degrees, and x/y units are pixels.
Definition at line 398 of file utilities.py.
def 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 466 of file utilities.py.
def lsst.fgcmcal.utilities.extractReferenceMags | ( | refStars, | |
bands, | |||
filterMap | |||
) |
Extract reference magnitudes from refStars for given bands and associated filterMap. Parameters ---------- refStars : `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 882 of file utilities.py.
def lsst.fgcmcal.utilities.lookupStaticCalibrations | ( | datasetType, | |
registry, | |||
quantumDataId, | |||
collections | |||
) |
Definition at line 939 of file utilities.py.
def 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 704 of file utilities.py.
def lsst.fgcmcal.utilities.makeAtmSchema | ( | ) |
Make the atmosphere schema Returns ------- atmSchema: `lsst.afw.table.Schema`
Definition at line 680 of file utilities.py.
def 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 48 of file utilities.py.
def 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 769 of file utilities.py.
def 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 737 of file utilities.py.
def 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 625 of file utilities.py.
def 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 539 of file utilities.py.
def 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 217 of file utilities.py.
def 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 347 of file utilities.py.
string lsst.fgcmcal.utilities.FGCM_CCD_FIELD = 'DETECTOR' |
Definition at line 45 of file utilities.py.
string lsst.fgcmcal.utilities.FGCM_EXP_FIELD = 'VISIT' |
Definition at line 44 of file utilities.py.