PiffPsfDeterminerConfig

class lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerConfig(*args, **kw)

Bases: BasePsfDeterminerConfig

Attributes Summary

color	The bands to use for calculating color.Ignored if piffPsfConfigYaml is set.
colorOrder	Color order for PSF kernel creation.
debugStarData	Include star images used for fitting in PSF model object.
downsampleRandomSeed	Random seed to use to downsample candidates.
interpolant	GalSim interpolant name for Piff to use.
maxCandidates	Maximum number of candidates to consider.
maxSNR	Rescale the weight of bright stars such that their SNR is less than this value.
minimumUnmaskedFraction	Minimum fraction of unmasked pixels required to use star.
modelSize	Internal model size for PIFF (typically odd, but not enforced).
outlierMaxRemove	Max fraction of stars to remove as outliers each iteration.
outlierNSigma	n sigma for chisq outlier rejection.
piffBasisPolynomialSolver	Solver to solve linear algebra for the spatial interpolation of the PSF.
piffLoggingLevel	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.) (int, default 0).
piffMaxIter	Maximum iteration while doing outlier rejection.Might be overwrite if zerothOrderInterpNotEnoughStars is True and ignore if piffPsfConfigYaml is not None.
piffPixelGridFitCenter	PixelGrid can re-estimate center if this option is True.
piffPsfConfigYaml	Configuration file for PIFF in YAML format.
samplingSize	Resolution of the internal PSF model relative to the pixel size; e.g. 0.5 is equal to 2x oversampling.
spatialOrder	Spatial order for PSF kernel creation.
spatialOrderPerBand	Per-band spatial order for PSF kernel creation.
stampSize	Size of the postage stamp (in native pixels) to render the PSF model.
useColor	Use color information to correct for amtospheric turbulences and differential chromatic refraction.Ignored if piffPsfConfigYaml is set.
useCoordinates	Which spatial coordinates to regress against in PSF modeling.
zeroWeightMaskBits	List of mask bits for which to set pixel weights to zero.
zerothOrderInterpNotEnoughStars	If True, use zeroth order interpolation if not enough stars are found.

Methods Summary

setDefaults()	Subclass hook for computing defaults.
validate()	Validate the Config, raising an exception if invalid.

Attributes Documentation

color

The bands to use for calculating color.Ignored if piffPsfConfigYaml is set. (Dict, default {})

colorOrder

Color order for PSF kernel creation. Ignored if piffPsfConfigYaml is set. (int, default 1)

debugStarData

Include star images used for fitting in PSF model object. (bool, default False)

downsampleRandomSeed

Random seed to use to downsample candidates. (int, default 98765)

interpolant

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. (str, default 'Lanczos(11)')

maxCandidates

Maximum number of candidates to consider. Will down-sample if given more. (int, default 300)

maxSNR

Rescale the weight of bright stars such that their SNR is less than this value. (float, default 200.0)

minimumUnmaskedFraction

Minimum fraction of unmasked pixels required to use star. (float, default 0.5)

modelSize

Internal model size for PIFF (typically odd, but not enforced). Partially ignored if piffPsfConfigYaml is set. (int, default 25)

outlierMaxRemove

Max fraction of stars to remove as outliers each iteration. Ignored if piffPsfConfigYaml is set. (float, default 0.05)

outlierNSigma

n sigma for chisq outlier rejection. Ignored if piffPsfConfigYaml is set. (float, default 4.0)

piffBasisPolynomialSolver

Solver to solve linear algebra for the spatial interpolation of the PSF. Ignore if piffPsfConfigYaml is not None. (str, default 'scipy')

Allowed values:

'scipy'

Default solver using scipy.

'cpp'

C++ solver using eigen.

'jax'

JAX solver.

'qr'

QR decomposition using scipy/numpy.

'None'

Field is optional

piffLoggingLevel

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.) (int, default 0)

Valid Range = [0,3)

piffMaxIter

Maximum iteration while doing outlier rejection.Might be overwrite if zerothOrderInterpNotEnoughStars is True and ignore if piffPsfConfigYaml is not None. (int, default 15)

piffPixelGridFitCenter

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. (bool, default True)

piffPsfConfigYaml

Configuration file for PIFF in YAML format. This overrides many other settings in this config and is not validated ahead of runtime. (str, default None)

samplingSize

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. (float, default 1)

spatialOrder

Spatial order for PSF kernel creation. Ignored if piffPsfConfigYaml is set or if the current band is in the spatialOrderPerBand dict config. (int, default 2)

spatialOrderPerBand

Per-band spatial order for PSF kernel creation. Ignored if piffPsfConfigYaml is set. (Dict, default {})

stampSize

Size of the postage stamp (in native pixels) to render the PSF model. Should be odd. (int, default None)

useColor

Use color information to correct for amtospheric turbulences and differential chromatic refraction.Ignored if piffPsfConfigYaml is set. (bool, default False)

useCoordinates

Which spatial coordinates to regress against in PSF modeling. (str, default 'pixel')

Allowed values:

'pixel'

Regress against pixel coordinates

'field'

Regress against field angles

'sky'

Regress against RA/Dec

'None'

Field is optional

zeroWeightMaskBits

List of mask bits for which to set pixel weights to zero. (List, default ['BAD', 'CR', 'INTRP', 'SAT', 'SUSPECT', 'NO_DATA'])

zerothOrderInterpNotEnoughStars

If True, use zeroth order interpolation if not enough stars are found. (bool, default False)

Methods Documentation

setDefaults()

Subclass hook for computing defaults.

Notes

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

validate()

Validate the Config, raising an exception if invalid.

Raises

lsst.pex.config.FieldValidationError

Raised if verification fails.

Notes

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.