lsst.meas.algorithms g1581cd22ba+dee93ecadb
Loading...
Searching...
No Matches
lsst.meas.algorithms.computeRoughPsfShapelets.ComputeRoughPsfShapeletsConfig Class Reference
Inheritance diagram for lsst.meas.algorithms.computeRoughPsfShapelets.ComputeRoughPsfShapeletsConfig:

Public Member Functions

None validate (self)
 

Static Public Attributes

 bad_mask_planes
 
 bad_pixel_max_fraction
 
 bad_pixel_exclusion_radius
 
 max_footprint_area
 
 min_snr
 
 max_radius_factor
 
 max_shape_distance
 
 min_n_stars
 
 max_n_stars
 
 logarithmic_shapes
 
 radius_mode_min
 
 radius_kde_bandwidth
 
 shapelet_order
 
 shapelet_scale_factor
 

Detailed Description

Definition at line 62 of file computeRoughPsfShapelets.py.

Member Function Documentation

◆ validate()

None lsst.meas.algorithms.computeRoughPsfShapelets.ComputeRoughPsfShapeletsConfig.validate ( self)

Definition at line 147 of file computeRoughPsfShapelets.py.

Member Data Documentation

◆ bad_mask_planes

lsst.meas.algorithms.computeRoughPsfShapelets.ComputeRoughPsfShapeletsConfig.bad_mask_planes
static
Initial value:
= ListField(
"Mask planes to identify pixels to drop from the calculation.",
dtype=str,
default=["SAT", "SUSPECT", "INTRP"],
)

Definition at line 63 of file computeRoughPsfShapelets.py.

◆ bad_pixel_exclusion_radius

lsst.meas.algorithms.computeRoughPsfShapelets.ComputeRoughPsfShapeletsConfig.bad_pixel_exclusion_radius
static
Initial value:
= Field(
"If a bad pixel (according to bad_mask_planes) falls within this "
"radius of the unweighted centroid of a footprint, drop that footprint "
"entirely.",
dtype=float,
default=2.0,
)

Definition at line 74 of file computeRoughPsfShapelets.py.

◆ bad_pixel_max_fraction

lsst.meas.algorithms.computeRoughPsfShapelets.ComputeRoughPsfShapeletsConfig.bad_pixel_max_fraction
static
Initial value:
= Field(
"Maximum fraction of a footprint's pixels that can be bad (according "
"to bad_mask_planes) before that footprint is fully dropped.",
dtype=float,
default=0.25,
)

Definition at line 68 of file computeRoughPsfShapelets.py.

◆ logarithmic_shapes

lsst.meas.algorithms.computeRoughPsfShapelets.ComputeRoughPsfShapeletsConfig.logarithmic_shapes
static
Initial value:
= Field(
"If True, transform the (xx, yy, xy) moments to conformal shear "
"and log trace radius when selecting stars in order to map the ellipse "
"parameter to a space with (-inf, inf) bounds on all quantities (but "
"a less-linear relationship to the pixel data).",
dtype=bool,
default=False,
)

Definition at line 116 of file computeRoughPsfShapelets.py.

◆ max_footprint_area

lsst.meas.algorithms.computeRoughPsfShapelets.ComputeRoughPsfShapeletsConfig.max_footprint_area
static
Initial value:
= Field(
"Footprints with a pixel count larger than this threshold are dropped before computing moments.",
dtype=int,
default=10000,
)

Definition at line 81 of file computeRoughPsfShapelets.py.

◆ max_n_stars

lsst.meas.algorithms.computeRoughPsfShapelets.ComputeRoughPsfShapeletsConfig.max_n_stars
static
Initial value:
= Field(
"Maximum number of stars to select. High shape-distance sources "
"are dropped as needed to meet this target.",
dtype=int,
default=20,
)

Definition at line 110 of file computeRoughPsfShapelets.py.

◆ max_radius_factor

lsst.meas.algorithms.computeRoughPsfShapelets.ComputeRoughPsfShapeletsConfig.max_radius_factor
static
Initial value:
= Field(
"Maximium multiple of the mode of the radius distribution for inclusion in the star sample.",
dtype=float,
default=2.0,
)

Definition at line 91 of file computeRoughPsfShapelets.py.

◆ max_shape_distance

lsst.meas.algorithms.computeRoughPsfShapelets.ComputeRoughPsfShapeletsConfig.max_shape_distance
static
Initial value:
= Field(
"Maximum Mahalanobis distance (distance from the center of the shape "
"distribution in elliptical sigma units) to select a star from the candidate "
"sample, comparing the shape of that source vs. a robust estimate of the "
"distribution of the shapes of all sources.",
dtype=float,
default=3.0,
)

Definition at line 96 of file computeRoughPsfShapelets.py.

◆ min_n_stars

lsst.meas.algorithms.computeRoughPsfShapelets.ComputeRoughPsfShapeletsConfig.min_n_stars
static
Initial value:
= Field(
"Minimum number of stars to select. The S/N, radius, and shape distance thresholds are "
"relaxed as needed to meet this target.",
dtype=int,
default=10,
)

Definition at line 104 of file computeRoughPsfShapelets.py.

◆ min_snr

lsst.meas.algorithms.computeRoughPsfShapelets.ComputeRoughPsfShapeletsConfig.min_snr
static
Initial value:
= Field(
"Mininum flux S/N for inclusion in the star sample.",
dtype=float,
default=50.0,
)

Definition at line 86 of file computeRoughPsfShapelets.py.

◆ radius_kde_bandwidth

lsst.meas.algorithms.computeRoughPsfShapelets.ComputeRoughPsfShapeletsConfig.radius_kde_bandwidth
static
Initial value:
= Field(
"Bandwidth of the Gaussian kernel density estimator used to find the "
"first mode of the radius distribution.",
dtype=float,
default=1.0,
)

Definition at line 130 of file computeRoughPsfShapelets.py.

◆ radius_mode_min

lsst.meas.algorithms.computeRoughPsfShapelets.ComputeRoughPsfShapeletsConfig.radius_mode_min
static
Initial value:
= Field(
"Minimum radius in pixels at which to start searching for the first mode. "
"This just needs be large enough to avoid unphysically small garbage (e.g. CRs).",
dtype=float,
default=1.0,
)

Definition at line 124 of file computeRoughPsfShapelets.py.

◆ shapelet_order

lsst.meas.algorithms.computeRoughPsfShapelets.ComputeRoughPsfShapeletsConfig.shapelet_order
static
Initial value:
= Field(
"Order of the shapelet expansion fit to the stars.",
dtype=int,
default=4,
)

Definition at line 136 of file computeRoughPsfShapelets.py.

◆ shapelet_scale_factor

lsst.meas.algorithms.computeRoughPsfShapelets.ComputeRoughPsfShapeletsConfig.shapelet_scale_factor
static
Initial value:
= Field(
"Scale factor to apply to the moments ellipse when computing the ellipse for the shapelet basis.",
dtype=float,
default=1.0,
)

Definition at line 141 of file computeRoughPsfShapelets.py.


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