lsst.pipe.tasks.extended_psf.extended_psf_subtract.ExtendedPsfSubtractConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.extended_psf.extended_psf_subtract.ExtendedPsfSubtractConfig:
Detailed Description
Configuration parameters for ExtendedPsfSubtractTask.
Definition at line 126 of file extended_psf_subtract.py.
Member Data Documentation
◆ bad_mask_planes
|
static |
Initial value:
= ListField[str](
doc="Mask planes excluded during amplitude fitting.",
default=[
"BAD",
"COSMIC_RAY",
"CROSSTALK",
"DETECTION_EDGE",
"NO_DATA",
"SATURATED",
"SUSPECT",
"UNMASKED_NAN",
],
)
Definition at line 178 of file extended_psf_subtract.py.
◆ bg_order
|
static |
Initial value:
= Field[int](
doc=(
"Order of polynomial to fit for local background around each star. "
"Set to 0 for a constant pedestal, 1 for a planar background, and higher values "
"for additional flexibility."
),
default=1,
)
Definition at line 204 of file extended_psf_subtract.py.
◆ do_rerun_background_subtraction
|
static |
Initial value:
= Field[bool](
doc="Re-estimate and subtract background after extended-PSF subtraction.",
default=True,
)
Definition at line 221 of file extended_psf_subtract.py.
◆ do_restore_background
|
static |
Initial value:
= Field[bool](
doc=(
"Restore the supplied preliminary_visit_image_background onto the working image before "
"star fitting/subtraction."
),
default=True,
)
Definition at line 214 of file extended_psf_subtract.py.
◆ exclude_arcsec_radius
|
static |
Initial value:
= Field[float](
doc=(
"No subtraction fit will be done for stars that have a neighboring star in the "
"exclude_mag_range within exclude_arcsec_radius arcseconds."
),
default=5,
)
Definition at line 137 of file extended_psf_subtract.py.
◆ exclude_mag_range
|
static |
Initial value:
= ListField[float](
doc="Magnitude range used when searching for neighboring contaminants.",
default=[0, 20],
)
Definition at line 144 of file extended_psf_subtract.py.
◆ extended_psf
|
staticinherited |
Initial value:
= Input(
name="extended_psf",
storageClass="ExtendedPsfImage",
doc="Extended PSF model image.",
dimensions=("visit", "detector"),
)
Definition at line 96 of file extended_psf_subtract.py.
◆ load_reference_objects_config
|
static |
Initial value:
= ConfigField[LoadReferenceObjectsConfig](
doc="Reference object loader for astrometric lookup.",
)
Definition at line 231 of file extended_psf_subtract.py.
◆ mag_range
|
static |
Initial value:
= ListField[float](
doc="Magnitude range in Gaia G for subtraction stars.",
default=[10, 18],
)
Definition at line 133 of file extended_psf_subtract.py.
◆ max_focal_plane_radius
|
static |
Initial value:
= Field[float](
doc="Maximum focal-plane radius in mm for subtraction stars.",
default=np.inf,
)
Definition at line 152 of file extended_psf_subtract.py.
◆ max_stars_per_detector
|
static |
Initial value:
= Field[int](
doc=(
"Maximum number of stars to subtract per detector; 0 means no cap. "
"If this limit is reached, the selected stars are truncated to the brightest "
"objects first (lowest magnitude values)."
),
default=0,
)
Definition at line 156 of file extended_psf_subtract.py.
◆ min_fit_pixels
|
static |
Initial value:
= Field[int](
doc="Minimum number of usable pixels required to fit a star.",
default=20,
)
Definition at line 200 of file extended_psf_subtract.py.
◆ min_focal_plane_radius
|
static |
Initial value:
= Field[float](
doc="Minimum focal-plane radius in mm for subtraction stars.",
default=0.0,
)
Definition at line 148 of file extended_psf_subtract.py.
◆ min_model_value
|
static |
Initial value:
= Field[float](
doc=(
"Minimum warped-model pixel value allowed in the per-star amplitude fit. "
"Only pixels with model > min_model_value are used when solving for PSF scale, "
"after mask and variance filtering. Increasing this emphasizes the bright core and "
"suppresses noisy wings; decreasing it includes more wing pixels in the fit."
),
default=0.0,
)
Definition at line 191 of file extended_psf_subtract.py.
◆ preliminary_visit_image
|
staticinherited |
Initial value:
= Input(
name="preliminary_visit_image",
storageClass="ExposureF",
doc="Input background-subtracted image.",
dimensions=("visit", "detector"),
)
Definition at line 80 of file extended_psf_subtract.py.
◆ preliminary_visit_image_background
|
staticinherited |
Initial value:
= Input(
name="preliminary_visit_image_background",
storageClass="Background",
doc=(
"Supplied input background model associated with preliminary_visit_image. "
"When do_restore_background is True, it is added back before fitting/subtracting the "
"extended PSF."
),
dimensions=("visit", "detector"),
)
Definition at line 86 of file extended_psf_subtract.py.
◆ preliminary_visit_image_extended_psf_subtracted
|
staticinherited |
Initial value:
= Output(
name="preliminary_visit_image_extended_psf_subtracted",
storageClass="ExposureF",
doc=(
"Preliminary-visit image with fitted extended-PSF subtracted. "
"Background may optionally be subtracted, depending on configuration."
),
dimensions=("visit", "detector"),
)
Definition at line 102 of file extended_psf_subtract.py.
◆ preliminary_visit_image_extended_psf_subtracted_background
|
staticinherited |
Initial value:
= Output(
name="preliminary_visit_image_extended_psf_subtracted_background",
storageClass="Background",
doc="Background model re-estimated after extended-PSF subtraction.",
dimensions=("visit", "detector"),
)
Definition at line 111 of file extended_psf_subtract.py.
◆ ref_cat
|
staticinherited |
Initial value:
= PrerequisiteInput(
name="the_monster_20250219",
storageClass="SimpleCatalog",
doc="Reference catalog that contains star positions.",
dimensions=("skypix",),
multiple=True,
deferLoad=True,
)
Definition at line 72 of file extended_psf_subtract.py.
◆ ref_cat_filter_name
|
static |
Initial value:
= Field[str](
doc="Name of the filter in the reference catalog to use for star selection.",
default="phot_g_mean",
)
Definition at line 234 of file extended_psf_subtract.py.
◆ subtract_background
|
static |
Initial value:
= ConfigurableField(
target=SubtractBackgroundTask,
doc="Subtask used to re-estimate background after extended-PSF subtraction.",
)
Definition at line 225 of file extended_psf_subtract.py.
◆ warping_kernel_name
|
static |
Initial value:
= ChoiceField[str](
doc="Warping kernel for model image warping.",
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 166 of file extended_psf_subtract.py.
The documentation for this class was generated from the following file:
- python/lsst/pipe/tasks/extended_psf/extended_psf_subtract.py
Generated on Sat Jul 18 2026 02:13:19 for lsst.pipe.tasks by
1.13.2