FgcmBuildStarsConfigBase#

class lsst.fgcmcal.FgcmBuildStarsConfigBase(*args, **kw)#

Bases: Config

Base config for FgcmBuildStars tasks

Attributes Summary

`apertureInnerInstFluxField`	Full name of instFlux field that contains inner aperture flux for aperture correction proxy (`str`, default `'base_CircularApertureFlux_12_0_instFlux'`)
`apertureOuterInstFluxField`	Full name of instFlux field that contains outer aperture flux for aperture correction proxy (`str`, default `'base_CircularApertureFlux_17_0_instFlux'`)
`coarseNside`	Healpix coarse Nside for partitioning matches (`int`, default `8`)
`densityCutMaxPerPixel`	Density cut number of stars per pixel (`int`, default `1000`)
`densityCutNside`	Density cut healpix nside (`int`, default `128`)
`doApplyWcsJacobian`	Apply the jacobian of the WCS to the star observations prior to fit? (`bool`, default `True`)
`doModelErrorsWithBackground`	Model flux errors with background term? (`bool`, default `True`)
`doReferenceMatches`	Match reference catalog as additional constraint on calibration (`bool`, default `True`)
`doSubtractLocalBackground`	Subtract the local background before performing calibration? This is only supported for circular aperture calibration fluxes.
`fgcmLoadReferenceCatalog`	FGCM reference object loader (`ConfigurableInstance`, default `<class 'lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogConfig'>`)
`instFluxField`	Faull name of the source instFlux field to use, including 'instFlux'.
`isolationRadius`	Isolation radius (arcseconds) (`float`, default `2.0`)
`localBackgroundFluxField`	Full name of the local background instFlux field to use.
`matchNside`	Healpix Nside for matching (`int`, default `4096`)
`matchRadius`	Match radius (arcseconds) (`float`, default `1.0`)
`minPerBand`	Minimum observations per band (`int`, default `2`)
`nVisitsPerCheckpoint`	Number of visits read between checkpoints (`int`, default `500`)
`physicalFilterMap`	Mapping from 'physicalFilter' to band.
`primaryBands`	Bands for 'primary' star matches.
`psfCandidateName`	Name of field with psf candidate flag for propagation (`str`, default `'calib_psf_candidate'`)
`randomSeed`	Random seed for high density down-sampling.
`requiredBands`	Bands required for each star (`List`, default `()`)
`sourceSelector`	How to select sources (`RegistryInstanceDict`, default `'science'`)

Methods Summary

setDefaults()

Subclass hook for computing defaults.

Attributes Documentation

apertureInnerInstFluxField#: Full name of instFlux field that contains inner aperture flux for aperture correction proxy (str, default 'base_CircularApertureFlux_12_0_instFlux')

apertureOuterInstFluxField#: Full name of instFlux field that contains outer aperture flux for aperture correction proxy (str, default 'base_CircularApertureFlux_17_0_instFlux')

coarseNside#: Healpix coarse Nside for partitioning matches (int, default 8)

densityCutMaxPerPixel#: Density cut number of stars per pixel (int, default 1000)

densityCutNside#: Density cut healpix nside (int, default 128)

doApplyWcsJacobian#: Apply the jacobian of the WCS to the star observations prior to fit? (bool, default True)

doModelErrorsWithBackground#: Model flux errors with background term? (bool, default True)

doReferenceMatches#: Match reference catalog as additional constraint on calibration (bool, default True)

doSubtractLocalBackground#: Subtract the local background before performing calibration? This is only supported for circular aperture calibration fluxes. (bool, default False)

fgcmLoadReferenceCatalog#: FGCM reference object loader (ConfigurableInstance, default <class 'lsst.fgcmcal.fgcmLoadReferenceCatalog.FgcmLoadReferenceCatalogConfig'>)

instFluxField#: Faull name of the source instFlux field to use, including ‘instFlux’. The associated flag will be implicitly included in badFlags (str, default 'slot_CalibFlux_instFlux')

isolationRadius#: Isolation radius (arcseconds) (float, default 2.0)

localBackgroundFluxField#: Full name of the local background instFlux field to use. (str, default 'base_LocalBackground_instFlux')

matchNside#: Healpix Nside for matching (int, default 4096)

matchRadius#: Match radius (arcseconds) (float, default 1.0)

minPerBand#: Minimum observations per band (int, default 2)

nVisitsPerCheckpoint#: Number of visits read between checkpoints (int, default 500)

physicalFilterMap#: Mapping from ‘physicalFilter’ to band. (Dict, default {})

primaryBands#: Bands for ‘primary’ star matches. A star must be observed in one of these bands to be considered as a calibration star. (List)

psfCandidateName#: Name of field with psf candidate flag for propagation (str, default 'calib_psf_candidate')

randomSeed#: Random seed for high density down-sampling. (int, default None)

requiredBands#: Bands required for each star (List, default ())

sourceSelector#: How to select sources (RegistryInstanceDict, default 'science')

Methods Documentation

setDefaults()#: Subclass hook for computing defaults.

Notes#

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

FgcmBuildStarsConfigBase#

Notes#