lsst.pipe.tasks.extended_psf.StackBrightStarsConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.extended_psf.StackBrightStarsConfig:

Static Public Attributes
	subregion_size
	stacking_statistic
	num_sigma_clip
	num_iter
	bad_mask_planes
	do_mag_cut
	mag_limit
	minValidAnnulusFraction

Detailed Description

Configuration parameters for StackBrightStarsTask.

Definition at line 321 of file extended_psf.py.

Member Data Documentation

bad_mask_planes

lsst.pipe.tasks.extended_psf.StackBrightStarsConfig.bad_mask_planes

static

Initial value:

=  ListField[str](
        doc="Mask planes that define pixels to be excluded from the stacking of the bright star stamps.",
        default=("BAD", "CR", "CROSSTALK", "EDGE", "NO_DATA", "SAT", "SUSPECT", "UNMASKEDNAN"),
    )

Definition at line 345 of file extended_psf.py.

do_mag_cut

lsst.pipe.tasks.extended_psf.StackBrightStarsConfig.do_mag_cut

static

Initial value:

=  Field[bool](
        doc="Apply magnitude cut before stacking?",
        default=False,
    )

Definition at line 349 of file extended_psf.py.

mag_limit

lsst.pipe.tasks.extended_psf.StackBrightStarsConfig.mag_limit

static

Initial value:

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

Definition at line 353 of file extended_psf.py.

minValidAnnulusFraction

lsst.pipe.tasks.extended_psf.StackBrightStarsConfig.minValidAnnulusFraction

static

Initial value:

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

Definition at line 357 of file extended_psf.py.

num_iter

lsst.pipe.tasks.extended_psf.StackBrightStarsConfig.num_iter

static

Initial value:

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

Definition at line 341 of file extended_psf.py.

num_sigma_clip

lsst.pipe.tasks.extended_psf.StackBrightStarsConfig.num_sigma_clip

static

Initial value:

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

Definition at line 337 of file extended_psf.py.

stacking_statistic

lsst.pipe.tasks.extended_psf.StackBrightStarsConfig.stacking_statistic

static

Initial value:

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

Definition at line 328 of file extended_psf.py.

subregion_size

lsst.pipe.tasks.extended_psf.StackBrightStarsConfig.subregion_size

static

Initial value:

=  ListField[int](
        doc="Size, in pixels, of the subregions over which the stacking will be " "iteratively performed.",
        default=(100, 100),
    )

Definition at line 324 of file extended_psf.py.

---

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

• python/lsst/pipe/tasks/extended_psf.py