lsst.meas.extensions.piff g92c671f44c+f32573b122
 
Loading...
Searching...
No Matches
lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig Class Reference
Inheritance diagram for lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig:

Public Member Functions

 setDefaults (self)
 
 validate (self)
 

Public Attributes

int stampSize = 27
 

Static Public Attributes

 spatialOrderPerBand
 
 spatialOrder
 
 piffBasisPolynomialSolver
 
 piffPixelGridFitCenter
 
 samplingSize
 
 modelSize
 
 outlierNSigma
 
 outlierMaxRemove
 
 maxSNR
 
 zeroWeightMaskBits
 
 minimumUnmaskedFraction
 
 useColor
 
 color
 
 colorOrder
 
 interpolant
 
 zerothOrderInterpNotEnoughStars
 
 debugStarData
 
str useCoordinates
 
 piffMaxIter
 
 piffLoggingLevel
 
 piffPsfConfigYaml
 

Member Data Documentation

◆ color

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.color
static
Initial value:
= pexConfig.DictField(
doc="The bands to use for calculating color."
"Ignored if piffPsfConfigYaml is set.",
default={},
keytype=str,
itemtype=str,
)

◆ colorOrder

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.colorOrder
static
Initial value:
= pexConfig.Field[int](
doc="Color order for PSF kernel creation. "
"Ignored if piffPsfConfigYaml is set.",
default=1,
)

◆ debugStarData

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.debugStarData
static
Initial value:
= pexConfig.Field[bool](
doc="Include star images used for fitting in PSF model object.",
default=False
)

◆ interpolant

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.interpolant
static
Initial value:
= pexConfig.Field[str](
doc="GalSim interpolant name for Piff to use. "
"Options include 'Lanczos(N)', where N is an integer, along with "
"galsim.Cubic, galsim.Delta, galsim.Linear, galsim.Nearest, "
"galsim.Quintic, and galsim.SincInterpolant. Ignored if "
"piffPsfConfigYaml is set.",
check=_validateGalsimInterpolant,
default="Lanczos(11)",
)

◆ maxSNR

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.maxSNR
static
Initial value:
= pexConfig.Field[float](
doc="Rescale the weight of bright stars such that their SNR is less "
"than this value.",
default=200.0
)

◆ minimumUnmaskedFraction

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.minimumUnmaskedFraction
static
Initial value:
= pexConfig.Field[float](
doc="Minimum fraction of unmasked pixels required to use star.",
default=0.5
)

◆ modelSize

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.modelSize
static
Initial value:
= pexConfig.Field[int](
doc="Internal model size for PIFF (typically odd, but not enforced). "
"Partially ignored if piffPsfConfigYaml is set.",
default=25,
)

◆ outlierMaxRemove

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.outlierMaxRemove
static
Initial value:
= pexConfig.Field[float](
doc="Max fraction of stars to remove as outliers each iteration. "
"Ignored if piffPsfConfigYaml is set.",
default=0.05
)

◆ outlierNSigma

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.outlierNSigma
static
Initial value:
= pexConfig.Field[float](
doc="n sigma for chisq outlier rejection. "
"Ignored if piffPsfConfigYaml is set.",
default=4.0
)

◆ piffBasisPolynomialSolver

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.piffBasisPolynomialSolver
static
Initial value:
= pexConfig.ChoiceField[str](
doc="Solver to solve linear algebra for "
"the spatial interpolation of the PSF. "
"Ignore if piffPsfConfigYaml is not None.",
allowed=dict(
scipy="Default solver using scipy.",
cpp="C++ solver using eigen.",
jax="JAX solver.",
qr="QR decomposition using scipy/numpy.",
),
default="scipy",
)

◆ piffLoggingLevel

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.piffLoggingLevel
static
Initial value:
= pexConfig.RangeField[int](
doc="PIFF-specific logging level, from 0 (least chatty) to 3 (very verbose); "
"note that logs will come out with unrelated notations (e.g. WARNING does "
"not imply a warning.)",
default=0,
min=0,
max=3,
)

◆ piffMaxIter

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.piffMaxIter
static
Initial value:
= pexConfig.Field[int](
doc="Maximum iteration while doing outlier rejection."
"Might be overwrite if zerothOrderInterpNotEnoughStars is True and "
"ignore if piffPsfConfigYaml is not None.",
default=15
)

◆ piffPixelGridFitCenter

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.piffPixelGridFitCenter
static
Initial value:
= pexConfig.Field[bool](
doc="PixelGrid can re-estimate center if this option is True. "
"Will use provided centroid if set to False. Default in Piff "
"is set to True. Depends on how input centroids can be trust. "
"Ignore if piffPsfConfigYaml is not None.",
default=True
)

◆ piffPsfConfigYaml

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.piffPsfConfigYaml
static
Initial value:
= pexConfig.Field[str](
doc="Configuration file for PIFF in YAML format. This overrides many "
"other settings in this config and is not validated ahead of runtime.",
default=None,
optional=True,
)

◆ samplingSize

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.samplingSize
static
Initial value:
= pexConfig.Field[float](
doc="Resolution of the internal PSF model relative to the pixel size; "
"e.g. 0.5 is equal to 2x oversampling. This affects only the size of "
"the PSF model stamp if piffPsfConfigYaml is set.",
default=1,
)

◆ spatialOrder

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.spatialOrder
static
Initial value:
= pexConfig.Field[int](
doc="Spatial order for PSF kernel creation. "
"Ignored if piffPsfConfigYaml is set or if the current "
"band is in the spatialOrderPerBand dict config.",
default=2,
)

◆ spatialOrderPerBand

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.spatialOrderPerBand
static
Initial value:
= pexConfig.DictField(
doc="Per-band spatial order for PSF kernel creation. "
"Ignored if piffPsfConfigYaml is set.",
keytype=str,
itemtype=int,
default={},
)

◆ useColor

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.useColor
static
Initial value:
= pexConfig.Field[bool](
doc="Use color information to correct for amtospheric turbulences and "
"differential chromatic refraction."
"Ignored if piffPsfConfigYaml is set.",
default=False,
)

◆ useCoordinates

str lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.useCoordinates
static
Initial value:
= pexConfig.ChoiceField[str](
doc="Which spatial coordinates to regress against in PSF modeling.",
allowed=dict(
pixel='Regress against pixel coordinates',
field='Regress against field angles',
sky='Regress against RA/Dec'
),
default='pixel'
)

◆ zerothOrderInterpNotEnoughStars

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.zerothOrderInterpNotEnoughStars
static
Initial value:
= pexConfig.Field[bool](
doc="If True, use zeroth order interpolation if not enough stars are found.",
default=False
)

◆ zeroWeightMaskBits

lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig.zeroWeightMaskBits
static
Initial value:
= pexConfig.ListField[str](
doc="List of mask bits for which to set pixel weights to zero.",
default=['BAD', 'CR', 'INTRP', 'SAT', 'SUSPECT', 'NO_DATA']
)

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