Config for FgcmBuildStarsTask
Definition at line 57 of file fgcmBuildStars.py.
◆ setDefaults()
def lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.setDefaults |
( |
|
self | ) |
|
◆ apertureInnerInstFluxField
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.apertureInnerInstFluxField |
|
static |
Initial value:= pexConfig.Field(
doc="Field that contains inner aperture for aperture correction proxy",
dtype=str,
default='base_CircularApertureFlux_12_0_instFlux'
)
Definition at line 181 of file fgcmBuildStars.py.
◆ apertureOuterInstFluxField
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.apertureOuterInstFluxField |
|
static |
Initial value:= pexConfig.Field(
doc="Field that contains outer aperture for aperture correction proxy",
dtype=str,
default='base_CircularApertureFlux_17_0_instFlux'
)
Definition at line 186 of file fgcmBuildStars.py.
◆ applyJacobian
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.applyJacobian |
|
static |
Initial value:= pexConfig.Field(
doc="Apply Jacobian correction?",
dtype=bool,
deprecated=("This field is no longer used, and has been deprecated by DM-20163. "
"It will be removed after v20."),
default=False
)
Definition at line 142 of file fgcmBuildStars.py.
◆ ccdDataRefName
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.ccdDataRefName |
|
static |
Initial value:= pexConfig.Field(
doc="dataRef name for the 'ccd' field",
dtype=str,
default="ccd"
)
Definition at line 137 of file fgcmBuildStars.py.
◆ checkAllCcds
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.checkAllCcds |
|
static |
Initial value:= pexConfig.Field(
doc=("Check repo for all CCDs for each visit specified. To be used when the "
"full set of ids (visit/ccd) are not specified on the command line. For "
"Gen2, specifying one ccd and setting checkAllCcds=True is significantly "
"faster than the alternatives."),
dtype=bool,
default=True,
)
Definition at line 124 of file fgcmBuildStars.py.
◆ coarseNside
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.coarseNside |
|
static |
Initial value:= pexConfig.Field(
doc="Healpix coarse Nside for partitioning matches",
dtype=int,
default=8,
)
Definition at line 96 of file fgcmBuildStars.py.
◆ densityCutMaxPerPixel
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.densityCutMaxPerPixel |
|
static |
Initial value:= pexConfig.Field(
doc="Density cut number of stars per pixel",
dtype=int,
default=1000,
)
Definition at line 86 of file fgcmBuildStars.py.
◆ densityCutNside
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.densityCutNside |
|
static |
Initial value:= pexConfig.Field(
doc="Density cut healpix nside",
dtype=int,
default=128,
)
Definition at line 81 of file fgcmBuildStars.py.
◆ doApplyWcsJacobian
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.doApplyWcsJacobian |
|
static |
Initial value:= pexConfig.Field(
doc="Apply the jacobian of the WCS to the star observations prior to fit?",
dtype=bool,
default=True
)
Definition at line 156 of file fgcmBuildStars.py.
◆ doReferenceMatches
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.doReferenceMatches |
|
static |
Initial value:= pexConfig.Field(
doc="Match reference catalog as additional constraint on calibration",
dtype=bool,
default=True,
)
Definition at line 191 of file fgcmBuildStars.py.
◆ doSubtractLocalBackground
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.doSubtractLocalBackground |
|
static |
Initial value:= pexConfig.Field(
doc=("Subtract the local background before performing calibration? "
"This is only supported for circular aperture calibration fluxes."),
dtype=bool,
default=False
)
Definition at line 166 of file fgcmBuildStars.py.
◆ fgcmLoadReferenceCatalog
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.fgcmLoadReferenceCatalog |
|
static |
Initial value:= pexConfig.ConfigurableField(
target=FgcmLoadReferenceCatalogTask,
doc="FGCM reference object loader",
)
Definition at line 196 of file fgcmBuildStars.py.
◆ filterMap
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.filterMap |
|
static |
Initial value:= pexConfig.DictField(
doc="Mapping from 'filterName' to band.",
keytype=str,
itemtype=str,
default={},
)
Definition at line 101 of file fgcmBuildStars.py.
◆ instFluxField
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.instFluxField |
|
static |
Initial value:= pexConfig.Field(
doc=("Name of the source instFlux field to use. The associated flag field "
"('<name>_flag') will be implicitly included in badFlags"),
dtype=str,
default='slot_CalibFlux_instFlux',
)
Definition at line 60 of file fgcmBuildStars.py.
◆ isolationRadius
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.isolationRadius |
|
static |
Initial value:= pexConfig.Field(
doc="Isolation radius (arcseconds)",
dtype=float,
default=2.0,
)
Definition at line 76 of file fgcmBuildStars.py.
◆ jacobianName
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.jacobianName |
|
static |
Initial value:= pexConfig.Field(
doc="Name of field with jacobian correction",
dtype=str,
deprecated=("This field is no longer used, and has been deprecated by DM-20163. "
"It will be removed after v20."),
default="base_Jacobian_value"
)
Definition at line 149 of file fgcmBuildStars.py.
◆ localBackgroundFluxField
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.localBackgroundFluxField |
|
static |
Initial value:= pexConfig.Field(
doc="Name of the local background instFlux field to use.",
dtype=str,
default='base_LocalBackground_instFlux'
)
Definition at line 172 of file fgcmBuildStars.py.
◆ matchNside
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.matchNside |
|
static |
Initial value:= pexConfig.Field(
doc="Healpix Nside for matching",
dtype=int,
default=4096,
)
Definition at line 91 of file fgcmBuildStars.py.
◆ matchRadius
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.matchRadius |
|
static |
Initial value:= pexConfig.Field(
doc="Match radius (arcseconds)",
dtype=float,
default=1.0,
)
Definition at line 71 of file fgcmBuildStars.py.
◆ minPerBand
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.minPerBand |
|
static |
Initial value:= pexConfig.Field(
doc="Minimum observations per band",
dtype=int,
default=2,
)
Definition at line 66 of file fgcmBuildStars.py.
◆ nVisitsPerCheckpoint
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.nVisitsPerCheckpoint |
|
static |
Initial value:= pexConfig.Field(
doc="Number of visits read between checkpoints",
dtype=int,
default=500,
)
Definition at line 200 of file fgcmBuildStars.py.
◆ primaryBands
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.primaryBands |
|
static |
Initial value:= pexConfig.ListField(
doc=("Bands for 'primary' star matches. "
"A star must be observed in one of these bands to be considered "
"as a calibration star."),
dtype=str,
default=None
)
Definition at line 112 of file fgcmBuildStars.py.
◆ psfCandidateName
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.psfCandidateName |
|
static |
Initial value:= pexConfig.Field(
doc="Name of field with psf candidate flag for propagation",
dtype=str,
default="calib_psf_candidate"
)
Definition at line 161 of file fgcmBuildStars.py.
◆ referenceCCD
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.referenceCCD |
|
static |
Initial value:= pexConfig.Field(
doc="Reference CCD for scanning visits",
dtype=int,
default=13,
)
Definition at line 119 of file fgcmBuildStars.py.
◆ requiredBands
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.requiredBands |
|
static |
Initial value:= pexConfig.ListField(
doc="Bands required for each star",
dtype=str,
default=(),
)
Definition at line 107 of file fgcmBuildStars.py.
◆ sourceSelector
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.sourceSelector |
|
static |
Initial value:= sourceSelectorRegistry.makeField(
doc="How to select sources",
default="science"
)
Definition at line 177 of file fgcmBuildStars.py.
◆ visitDataRefName
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.visitDataRefName |
|
static |
Initial value:= pexConfig.Field(
doc="dataRef name for the 'visit' field",
dtype=str,
default="visit"
)
Definition at line 132 of file fgcmBuildStars.py.
The documentation for this class was generated from the following file: