lsst.meas.astrom.astrometry.AstrometryConfig Class Reference

Inheritance diagram for lsst.meas.astrom.astrometry.AstrometryConfig:

Public Member Functions
def	setDefaults (self)

Public Attributes
	sourceFluxType

Static Public Attributes
	wcsFitter
	forceKnownWcs
	maxIter
	minMatchDistanceArcSec
	maxMeanDistanceArcsec
	doMagnitudeOutlierRejection
	magnitudeOutlierRejectionNSigma
	matcher
	matchDistanceSigma
	sourceSelector
	referenceSelector

Detailed Description

Config for AstrometryTask.

Definition at line 37 of file astrometry.py.

Member Function Documentation

setDefaults()

def lsst.meas.astrom.astrometry.AstrometryConfig.setDefaults

(

self

)

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

Definition at line 88 of file astrometry.py.

    def setDefaults(self):
        # Override the default source selector for astrometry tasks
        self.sourceFluxType = "Ap"
 
        self.sourceSelector.name = "matcher"
        self.sourceSelector["matcher"].sourceFluxType = self.sourceFluxType
 
        # Note that if the matcher is MatchOptimisticBTask, then the
        # default should be self.sourceSelector['matcher'].excludePixelFlags = False
        # However, there is no way to do this automatically.
 
 

Member Data Documentation

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=False,
    )

Definition at line 74 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 44 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 80 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 45 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 41 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 50 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 rerference "
            "objects post-fit.  A mean distance greater than this threshold raises a TaskError "
            "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.  "
            "Appropriate value will be dataset and workflow dependent.",
        dtype=float,
        default=0.5,
        min=0,
    )

Definition at line 64 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 57 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 57 of file ref_match.py.

sourceFluxType

lsst.meas.astrom.astrometry.AstrometryConfig.sourceFluxType

Definition at line 90 of file astrometry.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 53 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 40 of file astrometry.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_astrom/22.0.1-12-g44dc1dc+2a20fdde0d/python/lsst/meas/astrom/astrometry.py