lsst.pipe.tasks g540474b770+e939cf0e26
Loading...
Searching...
No Matches
lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConfig:
lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConnections

Static Public Attributes

 mag_range
 
 exclude_arcsec_radius
 
 exclude_mag_range
 
 min_area_fraction
 
 bad_mask_planes
 
 min_focal_plane_radius
 
 max_focal_plane_radius
 
 cutout_size
 
 warping_kernel_name
 
 mask_warping_kernel_name
 
 load_reference_objects_config
 
 ref_cat_filter_name
 
 ref_cat
 
 input_exposure
 
 input_background
 
 input_source_catalog
 
 extended_psf_candidates
 

Detailed Description

Configuration parameters for ExtendedPsfCutoutTask.

Definition at line 104 of file extended_psf_cutout.py.

Member Data Documentation

◆ bad_mask_planes

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConfig.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 129 of file extended_psf_cutout.py.

◆ cutout_size

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConfig.cutout_size
static
Initial value:
= ListField[int](
doc="Size of the cutouts to be extracted, in pixels.",
default=[251, 251],
)

Definition at line 155 of file extended_psf_cutout.py.

◆ exclude_arcsec_radius

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConfig.exclude_arcsec_radius
static
Initial value:
= Field[float](
doc="No cutouts 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 115 of file extended_psf_cutout.py.

◆ exclude_mag_range

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConfig.exclude_mag_range
static
Initial value:
= ListField[float](
doc="No cutouts 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 120 of file extended_psf_cutout.py.

◆ extended_psf_candidates

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConnections.extended_psf_candidates
staticinherited
Initial value:
= Output(
name="extended_psf_candidates",
storageClass="ExtendedPsfCandidates",
doc="Set of preprocessed cutouts, each centered on a single star.",
dimensions=("visit", "detector"),
)

Definition at line 96 of file extended_psf_cutout.py.

◆ input_background

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConnections.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 84 of file extended_psf_cutout.py.

◆ input_exposure

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConnections.input_exposure
staticinherited
Initial value:
= Input(
name="preliminary_visit_image",
storageClass="ExposureF",
doc="Background-subtracted input exposure from which to extract cutouts around a star.",
dimensions=("visit", "detector"),
)

Definition at line 78 of file extended_psf_cutout.py.

◆ input_source_catalog

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConnections.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 90 of file extended_psf_cutout.py.

◆ load_reference_objects_config

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConfig.load_reference_objects_config
static
Initial value:
= ConfigField[LoadReferenceObjectsConfig](
doc="Reference object loader for astrometric calibration.",
)

Definition at line 182 of file extended_psf_cutout.py.

◆ mag_range

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConfig.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 111 of file extended_psf_cutout.py.

◆ mask_warping_kernel_name

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConfig.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 169 of file extended_psf_cutout.py.

◆ max_focal_plane_radius

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConfig.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 148 of file extended_psf_cutout.py.

◆ min_area_fraction

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConfig.min_area_fraction
static
Initial value:
= Field[float](
doc="Minimum fraction of the cutout area, post-masking, that must remain for it to be retained.",
default=0.1,
)

Definition at line 125 of file extended_psf_cutout.py.

◆ min_focal_plane_radius

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConfig.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 143 of file extended_psf_cutout.py.

◆ ref_cat

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConnections.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 70 of file extended_psf_cutout.py.

◆ ref_cat_filter_name

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConfig.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 185 of file extended_psf_cutout.py.

◆ warping_kernel_name

lsst.pipe.tasks.extended_psf.extended_psf_cutout.ExtendedPsfCutoutConfig.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 159 of file extended_psf_cutout.py.


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