lsst.fgcmcal g7c13e6d1d1+c43e95cf46
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase Class Reference
Inheritance diagram for lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase:
lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsConfig lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConfig

Public Member Functions

def setDefaults (self)
 

Static Public Attributes

pexConfig instFluxField
 
pexConfig minPerBand
 
pexConfig matchRadius
 
pexConfig isolationRadius
 
pexConfig densityCutNside
 
pexConfig densityCutMaxPerPixel
 
pexConfig randomSeed
 
pexConfig matchNside
 
pexConfig coarseNside
 
pexConfig physicalFilterMap
 
pexConfig requiredBands
 
pexConfig primaryBands
 
pexConfig doApplyWcsJacobian
 
pexConfig doModelErrorsWithBackground
 
pexConfig psfCandidateName
 
pexConfig doSubtractLocalBackground
 
pexConfig localBackgroundFluxField
 
sourceSelectorRegistry sourceSelector
 
pexConfig apertureInnerInstFluxField
 
pexConfig apertureOuterInstFluxField
 
pexConfig doReferenceMatches
 
pexConfig fgcmLoadReferenceCatalog
 
pexConfig nVisitsPerCheckpoint
 

Detailed Description

Base config for FgcmBuildStars tasks

Definition at line 44 of file fgcmBuildStarsBase.py.

Member Function Documentation

◆ setDefaults()

def lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.setDefaults (   self)

Member Data Documentation

◆ apertureInnerInstFluxField

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.apertureInnerInstFluxField
static
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 142 of file fgcmBuildStarsBase.py.

◆ apertureOuterInstFluxField

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.apertureOuterInstFluxField
static
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 148 of file fgcmBuildStarsBase.py.

◆ coarseNside

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.coarseNside
static
Initial value:
= pexConfig.Field(
doc="Healpix coarse Nside for partitioning matches",
dtype=int,
default=8,
)

Definition at line 89 of file fgcmBuildStarsBase.py.

◆ densityCutMaxPerPixel

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.densityCutMaxPerPixel
static
Initial value:
= pexConfig.Field(
doc="Density cut number of stars per pixel",
dtype=int,
default=1000,
)

Definition at line 73 of file fgcmBuildStarsBase.py.

◆ densityCutNside

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.densityCutNside
static
Initial value:
= pexConfig.Field(
doc="Density cut healpix nside",
dtype=int,
default=128,
)

Definition at line 68 of file fgcmBuildStarsBase.py.

◆ doApplyWcsJacobian

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.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 112 of file fgcmBuildStarsBase.py.

◆ doModelErrorsWithBackground

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.doModelErrorsWithBackground
static
Initial value:
= pexConfig.Field(
doc="Model flux errors with background term?",
dtype=bool,
default=True
)

Definition at line 117 of file fgcmBuildStarsBase.py.

◆ doReferenceMatches

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.doReferenceMatches
static
Initial value:
= pexConfig.Field(
doc="Match reference catalog as additional constraint on calibration",
dtype=bool,
default=True,
)

Definition at line 154 of file fgcmBuildStarsBase.py.

◆ doSubtractLocalBackground

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.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 127 of file fgcmBuildStarsBase.py.

◆ fgcmLoadReferenceCatalog

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.fgcmLoadReferenceCatalog
static
Initial value:
= pexConfig.ConfigurableField(
target=FgcmLoadReferenceCatalogTask,
doc="FGCM reference object loader",
)

Definition at line 159 of file fgcmBuildStarsBase.py.

◆ instFluxField

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.instFluxField
static
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 47 of file fgcmBuildStarsBase.py.

◆ isolationRadius

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.isolationRadius
static
Initial value:
= pexConfig.Field(
doc="Isolation radius (arcseconds)",
dtype=float,
default=2.0,
)

Definition at line 63 of file fgcmBuildStarsBase.py.

◆ localBackgroundFluxField

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.localBackgroundFluxField
static
Initial value:
= pexConfig.Field(
doc="Full name of the local background instFlux field to use.",
dtype=str,
default='base_LocalBackground_instFlux'
)

Definition at line 133 of file fgcmBuildStarsBase.py.

◆ matchNside

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.matchNside
static
Initial value:
= pexConfig.Field(
doc="Healpix Nside for matching",
dtype=int,
default=4096,
)

Definition at line 84 of file fgcmBuildStarsBase.py.

◆ matchRadius

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.matchRadius
static
Initial value:
= pexConfig.Field(
doc="Match radius (arcseconds)",
dtype=float,
default=1.0,
)

Definition at line 58 of file fgcmBuildStarsBase.py.

◆ minPerBand

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.minPerBand
static
Initial value:
= pexConfig.Field(
doc="Minimum observations per band",
dtype=int,
default=2,
)

Definition at line 53 of file fgcmBuildStarsBase.py.

◆ nVisitsPerCheckpoint

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.nVisitsPerCheckpoint
static
Initial value:
= pexConfig.Field(
doc="Number of visits read between checkpoints",
dtype=int,
default=500,
)

Definition at line 163 of file fgcmBuildStarsBase.py.

◆ physicalFilterMap

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.physicalFilterMap
static
Initial value:
= pexConfig.DictField(
doc="Mapping from 'physicalFilter' to band.",
keytype=str,
itemtype=str,
default={},
)

Definition at line 94 of file fgcmBuildStarsBase.py.

◆ primaryBands

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.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 105 of file fgcmBuildStarsBase.py.

◆ psfCandidateName

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.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 122 of file fgcmBuildStarsBase.py.

◆ randomSeed

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.randomSeed
static
Initial value:
= pexConfig.Field(
doc="Random seed for high density down-sampling.",
dtype=int,
default=None,
optional=True,
)

Definition at line 78 of file fgcmBuildStarsBase.py.

◆ requiredBands

pexConfig lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.requiredBands
static
Initial value:
= pexConfig.ListField(
doc="Bands required for each star",
dtype=str,
default=(),
)

Definition at line 100 of file fgcmBuildStarsBase.py.

◆ sourceSelector

sourceSelectorRegistry lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.sourceSelector
static
Initial value:
= sourceSelectorRegistry.makeField(
doc="How to select sources",
default="science"
)

Definition at line 138 of file fgcmBuildStarsBase.py.


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