lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig:

Static Public Attributes
	magLimit
	stampSize
	modelStampBuffer
	doRemoveDetected
	doApplyTransform
	warpingKernelName
	annularFluxRadii
	annularFluxStatistic
	numSigmaClip
	numIter
	badMaskPlanes
	minValidAnnulusFraction
	doApplySkyCorr
	discardNanFluxStars
	refObjLoader

Detailed Description

Configuration parameters for ProcessBrightStarsTask.

Definition at line 85 of file processBrightStars.py.

Member Data Documentation

annularFluxRadii

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.annularFluxRadii

static

Initial value:

=  ListField[int](
        doc="Inner and outer radii of the annulus used to compute AnnularFlux for normalization, in pixels.",
        default=(70, 80),
    )

Definition at line 122 of file processBrightStars.py.

annularFluxStatistic

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.annularFluxStatistic

static

Initial value:

=  ChoiceField[str](
        doc="Type of statistic to use to compute annular flux.",
        default="MEANCLIP",
        allowed={
            "MEAN": "mean",
            "MEDIAN": "median",
            "MEANCLIP": "clipped mean",
        },
    )

Definition at line 126 of file processBrightStars.py.

badMaskPlanes

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.badMaskPlanes

static

Initial value:

=  ListField[str](
        doc="Mask planes that identify pixels to not include in the computation of the annular flux.",
        default=("BAD", "CR", "CROSSTALK", "EDGE", "NO_DATA", "SAT", "SUSPECT", "UNMASKEDNAN"),
    )

Definition at line 143 of file processBrightStars.py.

discardNanFluxStars

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.discardNanFluxStars

static

Initial value:

=  Field[bool](
        doc="Should stars with NaN annular flux be discarded?",
        default=False,
    )

Definition at line 156 of file processBrightStars.py.

doApplySkyCorr

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.doApplySkyCorr

static

Initial value:

=  Field[bool](
        doc="Apply full focal plane sky correction before extracting stars?",
        default=True,
    )

Definition at line 152 of file processBrightStars.py.

doApplyTransform

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.doApplyTransform

static

Initial value:

=  Field[bool](
        doc="Apply transform to bright star stamps to correct for optical distortions?",
        default=True,
    )

Definition at line 108 of file processBrightStars.py.

doRemoveDetected

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.doRemoveDetected

static

Initial value:

=  Field[bool](
        doc="Whether secondary DETECTION footprints (i.e., footprints of objects other than the central "
        "primary object) should be changed to BAD.",
        default=True,
    )

Definition at line 103 of file processBrightStars.py.

magLimit

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.magLimit

static

Initial value:

=  Field[float](
        doc="Magnitude limit, in Gaia G; all stars brighter than this value will be processed.",
        default=18,
    )

Definition at line 88 of file processBrightStars.py.

minValidAnnulusFraction

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.minValidAnnulusFraction

static

Initial value:

=  Field[float](
        doc="Minumum number of valid pixels that must fall within the annulus for the bright star to be "
        "saved for subsequent generation of a PSF.",
        default=0.0,
    )

Definition at line 147 of file processBrightStars.py.

modelStampBuffer

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.modelStampBuffer

static

Initial value:

=  Field[float](
        doc=(
            "'Buffer' factor to be applied to determine the size of the stamp the processed stars will be "
            "saved in. This will also be the size of the extended PSF model."
        ),
        default=1.1,
    )

Definition at line 96 of file processBrightStars.py.

numIter

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.numIter

static

Initial value:

=  Field[int](
        doc="Number of iterations of outlier rejection; ignored if annularFluxStatistic != 'MEANCLIP'.",
        default=3,
    )

Definition at line 139 of file processBrightStars.py.

numSigmaClip

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.numSigmaClip

static

Initial value:

=  Field[float](
        doc="Sigma for outlier rejection; ignored if annularFluxStatistic != 'MEANCLIP'.",
        default=4,
    )

Definition at line 135 of file processBrightStars.py.

refObjLoader

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.refObjLoader

static

Initial value:

=  ConfigField[LoadReferenceObjectsConfig](
        doc="Reference object loader for astrometric calibration.",
    )

Definition at line 160 of file processBrightStars.py.

stampSize

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.stampSize

static

Initial value:

=  ListField[int](
        doc="Size of the stamps to be extracted, in pixels.",
        default=(250, 250),
    )

Definition at line 92 of file processBrightStars.py.

warpingKernelName

lsst.pipe.tasks.processBrightStars.ProcessBrightStarsConfig.warpingKernelName

static

Initial value:

=  ChoiceField[str](
        doc="Warping kernel.",
        default="lanczos5",
        allowed={
            "bilinear": "bilinear interpolation",
            "lanczos3": "Lanczos kernel of order 3",
            "lanczos4": "Lanczos kernel of order 4",
            "lanczos5": "Lanczos kernel of order 5",
        },
    )

Definition at line 112 of file processBrightStars.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/gc07e1c2157+b2dbe6b631/python/lsst/pipe/tasks/processBrightStars.py