lsst.pipe.tasks.extended_psf.extended_psf_stack.ExtendedPsfStackConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.extended_psf.extended_psf_stack.ExtendedPsfStackConfig:

Static Public Attributes
	bad_mask_planes
	psf_masked_flux_frac_threshold
	min_focal_plane_radius
	max_focal_plane_radius
	stack_type
	stack_num_sigma_clip
	stack_num_iter
	use_median_variance
	fit_iterations
	bg_order
	extended_psf_candidates
	extended_psf

Detailed Description

Configuration parameters for ExtendedPsfStackTask.

Definition at line 68 of file extended_psf_stack.py.

Member Data Documentation

bad_mask_planes

lsst.pipe.tasks.extended_psf.extended_psf_stack.ExtendedPsfStackConfig.bad_mask_planes

static

Initial value:

=  ListField[str](
        doc="Mask planes that identify excluded (masked) pixels.",
        default=[
            "BAD",
            "COSMIC_RAY",
            "CROSSTALK",
            "DETECTION_EDGE",
            "NO_DATA",
            "SATURATED",
            "SUSPECT",
            "UNMASKED_NAN",
            NEIGHBOR_MASK_PLANE,
        ],
    )

Definition at line 75 of file extended_psf_stack.py.

bg_order

lsst.pipe.tasks.extended_psf.extended_psf_stack.ExtendedPsfStackConfig.bg_order

static

Initial value:

=  Field[int](
        doc="Order of polynomial to fit for background in candidate cutouts.",
        default=2,
    )

Definition at line 127 of file extended_psf_stack.py.

extended_psf

lsst.pipe.tasks.extended_psf.extended_psf_stack.ExtendedPsfStackConnections.extended_psf

staticinherited

Initial value:

=  Output(
        name="extended_psf",
        storageClass="ExtendedPsfImage",
        doc="Extended PSF model built from stacking candidate cutouts.",
        dimensions=("visit", "detector"),
    )

Definition at line 60 of file extended_psf_stack.py.

extended_psf_candidates

lsst.pipe.tasks.extended_psf.extended_psf_stack.ExtendedPsfStackConnections.extended_psf_candidates

staticinherited

Initial value:

=  Input(
        name="extended_psf_candidates",
        storageClass="ExtendedPsfCandidates",
        doc="Set of preprocessed cutouts, each centered on a single star.",
        dimensions=("visit", "detector"),
    )

Definition at line 54 of file extended_psf_stack.py.

fit_iterations

lsst.pipe.tasks.extended_psf.extended_psf_stack.ExtendedPsfStackConfig.fit_iterations

static

Initial value:

=  Field[int](
        doc="Number of iterations over pedestal-gradient and scaling fit.",
        default=5,
    )

Definition at line 123 of file extended_psf_stack.py.

max_focal_plane_radius

lsst.pipe.tasks.extended_psf.extended_psf_stack.ExtendedPsfStackConfig.max_focal_plane_radius

static

Initial value:

=  Field[float](
        doc="Maximum distance to the center of the focal plane, in mm. "
        "Candidates with larger focal plane radius will be omitted.",
        default=np.inf,
    )

Definition at line 98 of file extended_psf_stack.py.

min_focal_plane_radius

lsst.pipe.tasks.extended_psf.extended_psf_stack.ExtendedPsfStackConfig.min_focal_plane_radius

static

Initial value:

=  Field[float](
        doc="Minimum distance to the center of the focal plane, in mm. "
        "Candidates with smaller focal plane radius will be omitted.",
        default=0.0,
    )

Definition at line 93 of file extended_psf_stack.py.

psf_masked_flux_frac_threshold

lsst.pipe.tasks.extended_psf.extended_psf_stack.ExtendedPsfStackConfig.psf_masked_flux_frac_threshold

static

Initial value:

=  Field[float](
        doc="Maximum allowed fraction of masked PSF flux for fitting to occur.",
        default=0.97,
    )

Definition at line 89 of file extended_psf_stack.py.

stack_num_iter

lsst.pipe.tasks.extended_psf.extended_psf_stack.ExtendedPsfStackConfig.stack_num_iter

static

Initial value:

=  Field[int](
        doc="Number of iterations to use for clipping when stacking.",
        default=5,
    )

Definition at line 113 of file extended_psf_stack.py.

stack_num_sigma_clip

lsst.pipe.tasks.extended_psf.extended_psf_stack.ExtendedPsfStackConfig.stack_num_sigma_clip

static

Initial value:

=  Field[float](
        doc="Number of sigma to use for clipping when stacking.",
        default=3.0,
    )

Definition at line 109 of file extended_psf_stack.py.

stack_type

lsst.pipe.tasks.extended_psf.extended_psf_stack.ExtendedPsfStackConfig.stack_type

static

Initial value:

=  Field[str](
        default="MEANCLIP",
        doc="Statistic name to use for stacking (from `~lsst.afw.math.Property`)",
    )

Definition at line 105 of file extended_psf_stack.py.

use_median_variance

lsst.pipe.tasks.extended_psf.extended_psf_stack.ExtendedPsfStackConfig.use_median_variance

static

Initial value:

=  Field[bool](
        doc="Use the median of the variance plane for fitting.",
        default=False,
    )

Definition at line 119 of file extended_psf_stack.py.

---

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

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