lsst.meas.astrom gaea863341c+e98cf60e7d
Loading...
Searching...
No Matches
lsst.meas.astrom.astrometry.AstrometryConfig Class Reference
Inheritance diagram for lsst.meas.astrom.astrometry.AstrometryConfig:
lsst.meas.astrom.ref_match.RefMatchConfig

Public Member Functions

 setDefaults (self)
 
 validate (self)
 

Static Public Attributes

 wcsFitter
 
 forceKnownWcs
 
 maxIter
 
 minMatchDistanceArcSec
 
 maxMeanDistanceArcsec
 
 doMagnitudeOutlierRejection
 
 magnitudeOutlierRejectionNSigma
 
 fiducialZeroPoint
 
 doFiducialZeroPointCull
 
 cullMagBuffer
 
 maxRefToSourceRatio
 
 filterMap
 
 refColorDeltaDefaults
 
 doFitSipApproximation
 
 fitSipApproximation
 
 matcher
 
 matchDistanceSigma
 
 sourceSelector
 
 referenceSelector
 
 sourceFluxType
 

Detailed Description

Config for AstrometryTask.

Definition at line 38 of file astrometry.py.

Member Function Documentation

◆ setDefaults()

lsst.meas.astrom.astrometry.AstrometryConfig.setDefaults ( self)

Reimplemented from lsst.meas.astrom.ref_match.RefMatchConfig.

Definition at line 141 of file astrometry.py.

◆ validate()

lsst.meas.astrom.astrometry.AstrometryConfig.validate ( self)

Definition at line 149 of file astrometry.py.

Member Data Documentation

◆ cullMagBuffer

lsst.meas.astrom.astrometry.AstrometryConfig.cullMagBuffer
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Generous buffer on the fiducial zero point culling to account for observing "
"condition variations and uncertainty of the fiducial values.",
default=0.3,
optional=True,
)

Definition at line 103 of file astrometry.py.

◆ doFiducialZeroPointCull

lsst.meas.astrom.astrometry.AstrometryConfig.doFiducialZeroPointCull
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="If True, use the obs_package-defined fiducial zeropoint values to compute the "
"expected zeropoint for the current exposure. This is for use in culling reference "
"objects down to the approximate magnitude range of the detection source catalog "
"used for astrometric calibration.",
default=False,
)

Definition at line 95 of file astrometry.py.

◆ doFitSipApproximation

lsst.meas.astrom.astrometry.AstrometryConfig.doFitSipApproximation
static
Initial value:
= pexConfig.Field(
"Whether to fit a TAN-SIP approximation to the true WCS for use in FITS headers.",
dtype=bool,
default=True,
)

Definition at line 131 of file astrometry.py.

◆ doMagnitudeOutlierRejection

lsst.meas.astrom.astrometry.AstrometryConfig.doMagnitudeOutlierRejection
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc=("If True then a rough zeropoint will be computed from matched sources "
"and outliers will be rejected in the iterations."),
default=True,
)

Definition at line 75 of file astrometry.py.

◆ fiducialZeroPoint

lsst.meas.astrom.astrometry.AstrometryConfig.fiducialZeroPoint
static
Initial value:
= pexConfig.DictField(
keytype=str,
itemtype=float,
doc="Fiducial zeropoint values, keyed by band.",
default=None,
optional=True,
)

Definition at line 88 of file astrometry.py.

◆ filterMap

lsst.meas.astrom.astrometry.AstrometryConfig.filterMap
static
Initial value:
= pexConfig.DictField(
doc="Mapping from physical filter label to reference filter name.",
keytype=str,
itemtype=str,
default={},
)

Definition at line 117 of file astrometry.py.

◆ fitSipApproximation

lsst.meas.astrom.astrometry.AstrometryConfig.fitSipApproximation
static
Initial value:
= pexConfig.ConfigurableField(
"Configuration for fitting a TAN-SIP approximation to the true WCS for use in FITS headers.",
target=FitSipApproximationTask,
)

Definition at line 136 of file astrometry.py.

◆ forceKnownWcs

lsst.meas.astrom.astrometry.AstrometryConfig.forceKnownWcs
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="If True then load reference objects and match sources but do not fit a WCS; "
"this simply controls whether 'run' calls 'solve' or 'loadAndMatch'",
default=False,
)

Definition at line 45 of file astrometry.py.

◆ magnitudeOutlierRejectionNSigma

lsst.meas.astrom.astrometry.AstrometryConfig.magnitudeOutlierRejectionNSigma
static
Initial value:
= pexConfig.Field(
dtype=float,
doc=("Number of sigma (measured from the distribution) in magnitude "
"for a potential reference/source match to be rejected during "
"iteration."),
default=3.0,
)

Definition at line 81 of file astrometry.py.

◆ matchDistanceSigma

lsst.meas.astrom.ref_match.RefMatchConfig.matchDistanceSigma
staticinherited
Initial value:
= pexConfig.RangeField(
doc="the maximum match distance is set to "
" mean_match_distance + matchDistanceSigma*std_dev_match_distance; "
"ignored if not fitting a WCS",
dtype=float,
default=2,
min=0,
)

Definition at line 41 of file ref_match.py.

◆ matcher

lsst.meas.astrom.ref_match.RefMatchConfig.matcher
staticinherited
Initial value:
= pexConfig.ConfigurableField(
target=MatchPessimisticBTask,
doc="reference object/source matcher",
)

Definition at line 37 of file ref_match.py.

◆ maxIter

lsst.meas.astrom.astrometry.AstrometryConfig.maxIter
static
Initial value:
= pexConfig.RangeField(
doc="maximum number of iterations of match sources and fit WCS"
"ignored if not fitting a WCS",
dtype=int,
default=3,
min=1,
)

Definition at line 51 of file astrometry.py.

◆ maxMeanDistanceArcsec

lsst.meas.astrom.astrometry.AstrometryConfig.maxMeanDistanceArcsec
static
Initial value:
= pexConfig.RangeField(
doc="Maximum mean on-sky distance (in arcsec) between matched source and reference "
"objects post-fit. A mean distance greater than this threshold raises BadAstrometryFit "
"and the WCS fit is considered a failure. The default is set to the maximum tolerated "
"by the external global calibration (e.g. jointcal) step for conceivable recovery; "
"the appropriate value will be dataset and workflow dependent.",
dtype=float,
default=0.5,
min=0,
)

Definition at line 65 of file astrometry.py.

◆ maxRefToSourceRatio

lsst.meas.astrom.astrometry.AstrometryConfig.maxRefToSourceRatio
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Maximum ratio of loaded reference objects to detected sources in play. If exceded "
"the source catalog will be trimmed to the minimum (i.e. brightest) mag of the "
"reference catalog.",
default=20.0,
)

Definition at line 110 of file astrometry.py.

◆ minMatchDistanceArcSec

lsst.meas.astrom.astrometry.AstrometryConfig.minMatchDistanceArcSec
static
Initial value:
= pexConfig.RangeField(
doc="the match distance below which further iteration is pointless (arcsec); "
"ignored if not fitting a WCS",
dtype=float,
default=0.001,
min=0,
)

Definition at line 58 of file astrometry.py.

◆ refColorDeltaDefaults

lsst.meas.astrom.astrometry.AstrometryConfig.refColorDeltaDefaults
static
Initial value:
= pexConfig.DictField(
doc="Fallback values for color differences between the reference band and the "
"physical filter of the observation (note that these values apply to LSSTCam "
"filters and may not be appropriate for others).",
keytype=str,
itemtype=float,
default={"u": -1.5, "g": -0.6, "r": 0.0, "i": 0.5, "z": 0.6, "y": 0.8},
)

Definition at line 123 of file astrometry.py.

◆ referenceSelector

lsst.meas.astrom.ref_match.RefMatchConfig.referenceSelector
staticinherited
Initial value:
= pexConfig.ConfigurableField(
target=ReferenceSourceSelectorTask,
doc="How to select reference objects for cross-matching."
)

Definition at line 53 of file ref_match.py.

◆ sourceFluxType

lsst.meas.astrom.ref_match.RefMatchConfig.sourceFluxType
staticinherited
Initial value:
= pexConfig.Field(
dtype=str,
doc="Source flux type to use in source selection.",
default='Psf'
)

Definition at line 57 of file ref_match.py.

◆ sourceSelector

lsst.meas.astrom.ref_match.RefMatchConfig.sourceSelector
staticinherited
Initial value:
= sourceSelectorRegistry.makeField(
doc="How to select sources for cross-matching.",
default="science",
)

Definition at line 49 of file ref_match.py.

◆ wcsFitter

lsst.meas.astrom.astrometry.AstrometryConfig.wcsFitter
static
Initial value:
= pexConfig.ConfigurableField(
target=FitTanSipWcsTask,
doc="WCS fitter",
)

Definition at line 41 of file astrometry.py.


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