lsst.fgcmcal gc49b57b85e+7226047d04
Loading...
Searching...
No Matches
lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsConfig Class Reference
Inheritance diagram for lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsConfig:
lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsConnections

Public Member Functions

 setDefaults (self)
 
 getSpatialBoundsConnections (self)
 

Static Public Attributes

 referenceCCD
 
 reserve_selection
 
 instFluxField
 
 minPerBand
 
 matchRadius
 
 isolationRadius
 
 densityCutNside
 
 densityCutMaxPerPixel
 
 randomSeed
 
 matchNside
 
 coarseNside
 
 physicalFilterMap
 
 requiredBands
 
 primaryBands
 
 doApplyWcsJacobian
 
 doModelErrorsWithBackground
 
 psfCandidateName
 
 doSubtractLocalBackground
 
 localBackgroundFluxField
 
 sourceSelector
 
 apertureInnerInstFluxField
 
 apertureOuterInstFluxField
 
 doReferenceMatches
 
 fgcmLoadReferenceCatalog
 
 nVisitsPerCheckpoint
 
 camera
 
 fgcm_lookup_table
 
 ref_cat
 
 isolated_star_cats
 
 isolated_star_sources
 
 visit_summaries
 
 fgcm_visit_catalog
 
 fgcm_star_observations
 
 fgcm_star_ids
 
 fgcm_reference_stars
 

Detailed Description

Config for FgcmBuildFromIsolatedStarsTask.

Definition at line 143 of file fgcmBuildFromIsolatedStars.py.

Member Function Documentation

◆ getSpatialBoundsConnections()

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsConnections.getSpatialBoundsConnections ( self)
inherited

Definition at line 139 of file fgcmBuildFromIsolatedStars.py.

◆ setDefaults()

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsConfig.setDefaults ( self)

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

◆ camera

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsConnections.camera
staticinherited
Initial value:
= connectionTypes.PrerequisiteInput(
doc="Camera instrument",
name="camera",
storageClass="Camera",
dimensions=("instrument",),
isCalibration=True,
)

Definition at line 56 of file fgcmBuildFromIsolatedStars.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 90 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 74 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 69 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 113 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 118 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 155 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 128 of file fgcmBuildStarsBase.py.

◆ fgcm_lookup_table

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsConnections.fgcm_lookup_table
staticinherited
Initial value:
= connectionTypes.PrerequisiteInput(
doc=("Atmosphere + instrument look-up-table for FGCM throughput and "
"chromatic corrections."),
name="fgcmLookUpTable",
storageClass="Catalog",
dimensions=("instrument",),
deferLoad=True,
)

Definition at line 63 of file fgcmBuildFromIsolatedStars.py.

◆ fgcm_reference_stars

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsConnections.fgcm_reference_stars
staticinherited
Initial value:
= connectionTypes.Output(
doc="Catalog of fgcm-matched reference stars.",
name="fgcm_reference_stars",
storageClass="ArrowAstropy",
dimensions=("instrument",),
)

Definition at line 125 of file fgcmBuildFromIsolatedStars.py.

◆ fgcm_star_ids

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsConnections.fgcm_star_ids
staticinherited
Initial value:
= connectionTypes.Output(
doc="Catalog of fgcm calibration star IDs.",
name="fgcm_star_ids",
storageClass="ArrowAstropy",
dimensions=("instrument",),
)

Definition at line 119 of file fgcmBuildFromIsolatedStars.py.

◆ fgcm_star_observations

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsConnections.fgcm_star_observations
staticinherited
Initial value:
= connectionTypes.Output(
doc="Catalog of star observations for fgcm.",
name="fgcm_star_observations",
storageClass="ArrowAstropy",
dimensions=("instrument",),
)

Definition at line 113 of file fgcmBuildFromIsolatedStars.py.

◆ fgcm_visit_catalog

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsConnections.fgcm_visit_catalog
staticinherited
Initial value:
= connectionTypes.Output(
doc="Catalog of visit information for fgcm.",
name="fgcmVisitCatalog",
storageClass="Catalog",
dimensions=("instrument",),
)

Definition at line 107 of file fgcmBuildFromIsolatedStars.py.

◆ fgcmLoadReferenceCatalog

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

Definition at line 160 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 48 of file fgcmBuildStarsBase.py.

◆ isolated_star_cats

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsConnections.isolated_star_cats
staticinherited
Initial value:
= pipeBase.connectionTypes.Input(
doc=("Catalog of isolated stars with average positions, number of associated "
"sources, and indexes to the isolated_star_sources catalogs."),
name="isolated_star_presource_associations",
storageClass="ArrowAstropy",
dimensions=("instrument", "tract", "skymap"),
deferLoad=True,
multiple=True,
)

Definition at line 79 of file fgcmBuildFromIsolatedStars.py.

◆ isolated_star_sources

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsConnections.isolated_star_sources
staticinherited
Initial value:
= pipeBase.connectionTypes.Input(
doc=("Catalog of isolated star sources with sourceIds, and indexes to the "
"isolated_star_cats catalogs."),
name="isolated_star_presources",
storageClass="ArrowAstropy",
dimensions=("instrument", "tract", "skymap"),
deferLoad=True,
multiple=True,
)

Definition at line 88 of file fgcmBuildFromIsolatedStars.py.

◆ isolationRadius

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

Definition at line 64 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 134 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 85 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 59 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 54 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 164 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 95 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 106 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 123 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=123456,
optional=True,
)

Definition at line 79 of file fgcmBuildStarsBase.py.

◆ ref_cat

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsConnections.ref_cat
staticinherited
Initial value:
= connectionTypes.PrerequisiteInput(
doc="Reference catalog to use for photometric calibration.",
name="cal_ref_cat",
storageClass="SimpleCatalog",
dimensions=("skypix",),
deferLoad=True,
multiple=True,
)

Definition at line 71 of file fgcmBuildFromIsolatedStars.py.

◆ referenceCCD

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsConfig.referenceCCD
static
Initial value:
= pexConfig.Field(
doc="Reference detector for checking PSF and background.",
dtype=int,
default=40,
)

Definition at line 146 of file fgcmBuildFromIsolatedStars.py.

◆ requiredBands

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

Definition at line 101 of file fgcmBuildStarsBase.py.

◆ reserve_selection

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsConfig.reserve_selection
static
Initial value:
= pexConfig.ConfigurableField(
target=ReserveIsolatedStarsTask,
doc="Task to select reserved stars.",
)

Definition at line 151 of file fgcmBuildFromIsolatedStars.py.

◆ sourceSelector

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

Definition at line 139 of file fgcmBuildStarsBase.py.

◆ visit_summaries

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsConnections.visit_summaries
staticinherited
Initial value:
= connectionTypes.Input(
doc=("Per-visit consolidated exposure metadata. These catalogs use "
"detector id for the id and must be sorted for fast lookups of a "
"detector."),
name="visitSummary",
storageClass="ExposureCatalog",
dimensions=("instrument", "visit"),
deferLoad=True,
multiple=True,
)

Definition at line 97 of file fgcmBuildFromIsolatedStars.py.


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