lsst.pipe.tasks.brightStarSubtraction.brightStarCutout.BrightStarCutoutConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.brightStarSubtraction.brightStarCutout.BrightStarCutoutConfig:
Detailed Description
Configuration parameters for BrightStarCutoutTask.
Definition at line 106 of file brightStarCutout.py.
Member Data Documentation
◆ bad_mask_planes
|
static |
Initial value:
= ListField[str](
doc="Mask planes that identify excluded pixels for the calculation of ``min_area_fraction``.",
default=[
"BAD",
"CR",
"CROSSTALK",
"EDGE",
"NO_DATA",
"SAT",
"SUSPECT",
"UNMASKEDNAN",
NEIGHBOR_MASK_PLANE,
],
)
Definition at line 131 of file brightStarCutout.py.
◆ bright_star_stamps
|
staticinherited |
Initial value:
= Output(
name="bright_star_stamps",
storageClass="BrightStarStamps",
doc="Set of preprocessed postage stamp cutouts, each centered on a single bright star.",
dimensions=("visit", "detector"),
)
Definition at line 98 of file brightStarCutout.py.
◆ exclude_arcsec_radius
|
static |
Initial value:
= Field[float](
doc="No postage stamp will be generated for stars with a neighboring star in the range "
"``exclude_mag_range`` mag within ``exclude_arcsec_radius`` arcseconds.",
default=5,
)
Definition at line 117 of file brightStarCutout.py.
◆ exclude_mag_range
|
static |
Initial value:
= ListField[float](
doc="No postage stamp will be generated for stars with a neighboring star in the range "
"``exclude_mag_range`` mag within ``exclude_arcsec_radius`` arcseconds.",
default=[0, 20],
)
Definition at line 122 of file brightStarCutout.py.
◆ input_background
|
staticinherited |
Initial value:
= Input(
name="preliminary_visit_image_background",
storageClass="Background",
doc="Background model for the input exposure, to be added back on during processing.",
dimensions=("visit", "detector"),
)
Definition at line 86 of file brightStarCutout.py.
◆ input_exposure
|
staticinherited |
Initial value:
= Input(
name="preliminary_visit_image",
storageClass="ExposureF",
doc="Background-subtracted input exposure from which to extract bright star stamp cutouts.",
dimensions=("visit", "detector"),
)
Definition at line 80 of file brightStarCutout.py.
◆ input_source_catalog
|
staticinherited |
Initial value:
= Input(
name="single_visit_star_footprints",
storageClass="SourceCatalog",
doc="Source catalog containing footprints on the input exposure, used to mask neighboring sources.",
dimensions=("visit", "detector"),
)
Definition at line 92 of file brightStarCutout.py.
◆ load_reference_objects_config
|
static |
Initial value:
= ConfigField[LoadReferenceObjectsConfig](
doc="Reference object loader for astrometric calibration.",
)
Definition at line 184 of file brightStarCutout.py.
◆ mag_range
|
static |
Initial value:
= ListField[float](
doc="Magnitude range in Gaia G. Cutouts will be made for all stars in this range.",
default=[10, 18],
)
Definition at line 113 of file brightStarCutout.py.
◆ mask_warping_kernel_name
|
static |
Initial value:
= ChoiceField[str](
doc="Warping kernel for mask warping. Typically a more conservative kernel (e.g. with less ringing) "
"is desirable for warping masks than for warping image data.",
default="bilinear",
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 171 of file brightStarCutout.py.
◆ max_focal_plane_radius
|
static |
Initial value:
= Field[float](
doc="Maximum distance to the center of the focal plane, in mm. "
"Stars with a focal plane radius larger than this will be omitted.",
default=np.inf,
)
Definition at line 150 of file brightStarCutout.py.
◆ min_area_fraction
|
static |
Initial value:
= Field[float](
doc="Minimum fraction of the stamp area, post-masking, that must remain for a cutout to be retained.",
default=0.1,
)
Definition at line 127 of file brightStarCutout.py.
◆ min_focal_plane_radius
|
static |
Initial value:
= Field[float](
doc="Minimum distance to the center of the focal plane, in mm. "
"Stars with a focal plane radius smaller than this will be omitted.",
default=0.0,
)
Definition at line 145 of file brightStarCutout.py.
◆ ref_cat
|
staticinherited |
Initial value:
= PrerequisiteInput(
name="the_monster_20250219",
storageClass="SimpleCatalog",
doc="Reference catalog that contains bright star positions.",
dimensions=("skypix",),
multiple=True,
deferLoad=True,
)
Definition at line 72 of file brightStarCutout.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 187 of file brightStarCutout.py.
◆ stamp_size
|
static |
Initial value:
= ListField[int](
doc="Size of the stamps to be extracted, in pixels.",
default=[251, 251],
)
Definition at line 157 of file brightStarCutout.py.
◆ warping_kernel_name
|
static |
Initial value:
= ChoiceField[str](
doc="Warping kernel for image data 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 161 of file brightStarCutout.py.
The documentation for this class was generated from the following file:
- python/lsst/pipe/tasks/brightStarSubtraction/brightStarCutout.py
Generated on Wed Apr 22 2026 09:17:26 for lsst.pipe.tasks by
1.13.2