lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig Class Reference

Inheritance diagram for lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig:

Public Member Functions
def	setDefaults (self)

Static Public Attributes
	referenceCCD
	checkAllCcds
	instFluxField
	minPerBand
	matchRadius
	isolationRadius
	densityCutNside
	densityCutMaxPerPixel
	randomSeed
	matchNside
	coarseNside
	physicalFilterMap
	requiredBands
	primaryBands
	visitDataRefName
	ccdDataRefName
	doApplyWcsJacobian
	doModelErrorsWithBackground
	psfCandidateName
	doSubtractLocalBackground
	localBackgroundFluxField
	sourceSelector
	apertureInnerInstFluxField
	apertureOuterInstFluxField
	doReferenceMatches
	fgcmLoadReferenceCatalog
	nVisitsPerCheckpoint

Detailed Description

Config for FgcmBuildStarsTask

Definition at line 46 of file fgcmBuildStars.py.

Member Function Documentation

setDefaults()

def lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsConfig.setDefaults

(

self

)

Reimplemented from lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.

Definition at line 63 of file fgcmBuildStars.py.

    def setDefaults(self):
        super().setDefaults()
 
        sourceSelector = self.sourceSelector["science"]
 
        # The names here correspond to raw src catalogs, which differ
        # from the post-transformed sourceTable_visit catalogs.
        # Therefore, field and flag names cannot be easily
        # derived from the base config class.
        fluxFlagName = self.instFluxField[0: -len('instFlux')] + 'flag'
        sourceSelector.flags.bad = ['base_PixelFlags_flag_edge',
                                    'base_PixelFlags_flag_interpolatedCenter',
                                    'base_PixelFlags_flag_saturatedCenter',
                                    'base_PixelFlags_flag_crCenter',
                                    'base_PixelFlags_flag_bad',
                                    'base_PixelFlags_flag_interpolated',
                                    'base_PixelFlags_flag_saturated',
                                    'slot_Centroid_flag',
                                    fluxFlagName]
 
        if self.doSubtractLocalBackground:
            localBackgroundFlagName = self.localBackgroundFluxField[0: -len('instFlux')] + 'flag'
            sourceSelector.flags.bad.append(localBackgroundFlagName)
 
        sourceSelector.signalToNoise.fluxField = self.instFluxField
        sourceSelector.signalToNoise.errField = self.instFluxField + 'Err'
 
 

Member Data Documentation

apertureInnerInstFluxField

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.apertureInnerInstFluxField

staticinherited

Initial value:

=  pexConfig.Field(
        doc=("Full name of instFlux field that contains inner aperture "
             "flux for aperture correction proxy"),
        dtype=str,
        default='base_CircularApertureFlux_12_0_instFlux'
    )

Definition at line 162 of file fgcmBuildStarsBase.py.

apertureOuterInstFluxField

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.apertureOuterInstFluxField

staticinherited

Initial value:

=  pexConfig.Field(
        doc=("Full name of instFlux field that contains outer aperture "
             "flux for aperture correction proxy"),
        dtype=str,
        default='base_CircularApertureFlux_17_0_instFlux'
    )

Definition at line 168 of file fgcmBuildStarsBase.py.

ccdDataRefName

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.ccdDataRefName

staticinherited

Initial value:

=  pexConfig.Field(
        doc="dataRef name for the 'ccd' field, usually 'ccd' or 'detector'.",
        dtype=str,
        default="ccd"
    )

Definition at line 127 of file fgcmBuildStarsBase.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 54 of file fgcmBuildStars.py.

coarseNside

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.coarseNside

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Healpix coarse Nside for partitioning matches",
        dtype=int,
        default=8,
    )

Definition at line 96 of file fgcmBuildStarsBase.py.

densityCutMaxPerPixel

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.densityCutMaxPerPixel

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Density cut number of stars per pixel",
        dtype=int,
        default=1000,
    )

Definition at line 80 of file fgcmBuildStarsBase.py.

densityCutNside

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.densityCutNside

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Density cut healpix nside",
        dtype=int,
        default=128,
    )

Definition at line 75 of file fgcmBuildStarsBase.py.

doApplyWcsJacobian

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.doApplyWcsJacobian

staticinherited

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 132 of file fgcmBuildStarsBase.py.

doModelErrorsWithBackground

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.doModelErrorsWithBackground

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Model flux errors with background term?",
        dtype=bool,
        default=True
    )

Definition at line 137 of file fgcmBuildStarsBase.py.

doReferenceMatches

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.doReferenceMatches

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Match reference catalog as additional constraint on calibration",
        dtype=bool,
        default=True,
    )

Definition at line 174 of file fgcmBuildStarsBase.py.

doSubtractLocalBackground

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.doSubtractLocalBackground

staticinherited

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 147 of file fgcmBuildStarsBase.py.

fgcmLoadReferenceCatalog

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.fgcmLoadReferenceCatalog

staticinherited

Initial value:

=  pexConfig.ConfigurableField(
        target=FgcmLoadReferenceCatalogTask,
        doc="FGCM reference object loader",
    )

Definition at line 179 of file fgcmBuildStarsBase.py.

instFluxField

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.instFluxField

staticinherited

Initial value:

=  pexConfig.Field(
        doc=("Faull name of the source instFlux field to use, including 'instFlux'. "
             "The associated flag will be implicitly included in badFlags"),
        dtype=str,
        default='slot_CalibFlux_instFlux',
    )

Definition at line 54 of file fgcmBuildStarsBase.py.

isolationRadius

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.isolationRadius

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Isolation radius (arcseconds)",
        dtype=float,
        default=2.0,
    )

Definition at line 70 of file fgcmBuildStarsBase.py.

localBackgroundFluxField

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.localBackgroundFluxField

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Full name of the local background instFlux field to use.",
        dtype=str,
        default='base_LocalBackground_instFlux'
    )

Definition at line 153 of file fgcmBuildStarsBase.py.

matchNside

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.matchNside

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Healpix Nside for matching",
        dtype=int,
        default=4096,
    )

Definition at line 91 of file fgcmBuildStarsBase.py.

matchRadius

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.matchRadius

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Match radius (arcseconds)",
        dtype=float,
        default=1.0,
    )

Definition at line 65 of file fgcmBuildStarsBase.py.

minPerBand

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.minPerBand

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Minimum observations per band",
        dtype=int,
        default=2,
    )

Definition at line 60 of file fgcmBuildStarsBase.py.

nVisitsPerCheckpoint

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.nVisitsPerCheckpoint

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Number of visits read between checkpoints",
        dtype=int,
        default=500,
    )

Definition at line 183 of file fgcmBuildStarsBase.py.

physicalFilterMap

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.physicalFilterMap

staticinherited

Initial value:

=  pexConfig.DictField(
        doc="Mapping from 'physicalFilter' to band.",
        keytype=str,
        itemtype=str,
        default={},
    )

Definition at line 104 of file fgcmBuildStarsBase.py.

primaryBands

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.primaryBands

staticinherited

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 115 of file fgcmBuildStarsBase.py.

psfCandidateName

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.psfCandidateName

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Name of field with psf candidate flag for propagation",
        dtype=str,
        default="calib_psf_candidate"
    )

Definition at line 142 of file fgcmBuildStarsBase.py.

randomSeed

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.randomSeed

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Random seed for high density down-sampling.",
        dtype=int,
        default=None,
        optional=True,
    )

Definition at line 85 of file fgcmBuildStarsBase.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 49 of file fgcmBuildStars.py.

requiredBands

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.requiredBands

staticinherited

Initial value:

=  pexConfig.ListField(
        doc="Bands required for each star",
        dtype=str,
        default=(),
    )

Definition at line 110 of file fgcmBuildStarsBase.py.

sourceSelector

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.sourceSelector

staticinherited

Initial value:

=  sourceSelectorRegistry.makeField(
        doc="How to select sources",
        default="science"
    )

Definition at line 158 of file fgcmBuildStarsBase.py.

visitDataRefName

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.visitDataRefName

staticinherited

Initial value:

=  pexConfig.Field(
        doc="dataRef name for the 'visit' field, usually 'visit'.",
        dtype=str,
        default="visit"
    )

Definition at line 122 of file fgcmBuildStarsBase.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/fgcmcal/22.0.1-15-g6a90155+515f58c32b/python/lsst/fgcmcal/fgcmBuildStars.py