Inheritance diagram for lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory:
Public Member Functions | |
| computeSizeAndSigma (self, fwhm=None) | |
| validate (self) | |
| apply (self, fwhm=None) | |
| makeField (cls, doc) | |
Static Public Attributes | |
| size | |
| sizeFactor | |
| minSize | |
| maxSize | |
| defaultFwhm | |
| addWing | |
| wingFwhmFactor | |
| wingAmplitude | |
Detailed Description
Factory for simple Gaussian PSF models Provides a high-level interface to DoubleGaussianPsf and SingleGaussianPsf by specifying Gaussian PSF model width in FWHM instead of sigma, and supporting computing kernel size as a multiple of PSF width. This makes it suitable for tasks where PSF width is not known in advance.
Definition at line 38 of file gaussianPsfFactory.py.
Member Function Documentation
◆ apply()
| lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.apply | ( | self, | |
| fwhm = None ) |
Construct a GaussianPsf
Parameters
----------
fwhm : `float`
FWHM of core of star (pixels); if None then self.defaultFwhm is used
Returns
-------
DoubleGaussianPsf : ``lsst.meas.algorithms.DoubleGaussianPsf``
Returns if self.addWing is True
SingleGaussianPsf : ``lsst.meas.algorithms.SingleGaussianPsf``
Returns if self.addWing is False
Definition at line 140 of file gaussianPsfFactory.py.
140 def apply(self, fwhm=None):
141 """Construct a GaussianPsf
142
143 Parameters
144 ----------
145 fwhm : `float`
146 FWHM of core of star (pixels); if None then self.defaultFwhm is used
147
148 Returns
149 -------
150 DoubleGaussianPsf : ``lsst.meas.algorithms.DoubleGaussianPsf``
151 Returns if self.addWing is True
152 SingleGaussianPsf : ``lsst.meas.algorithms.SingleGaussianPsf``
153 Returns if self.addWing is False
154 """
155 kernelSize, sigma = self.computeSizeAndSigma(fwhm)
156 if self.addWing:
157 wingsSigma = sigma * self.wingFwhmFactor
158 return DoubleGaussianPsf(kernelSize, kernelSize, sigma, wingsSigma, self.wingAmplitude)
159 else:
160 return SingleGaussianPsf(kernelSize, kernelSize, sigma)
161
◆ computeSizeAndSigma()
| lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.computeSizeAndSigma | ( | self, | |
| fwhm = None ) |
Compute kernel size and star width as sigma. The kernel size will be
odd unless minSize or maxSize is used and that value is even. Assumes
a valid config.
Parameters
----------
fwhm : `float`
FWHM of core star (pixels); if None then defaultFwhm is used
Returns
-------
size : `int`
Kernel size (width == height) in pixels
sigma : `float`
Sigma equivalent to supplied FWHM, assuming a Gaussian (pixels)
Definition at line 102 of file gaussianPsfFactory.py.
102 def computeSizeAndSigma(self, fwhm=None):
103 """Compute kernel size and star width as sigma. The kernel size will be
104 odd unless minSize or maxSize is used and that value is even. Assumes
105 a valid config.
106
107 Parameters
108 ----------
109 fwhm : `float`
110 FWHM of core star (pixels); if None then defaultFwhm is used
111
112 Returns
113 -------
114 size : `int`
115 Kernel size (width == height) in pixels
116 sigma : `float`
117 Sigma equivalent to supplied FWHM, assuming a Gaussian (pixels)
118 """
119 if fwhm is None:
120 fwhm = self.defaultFwhm
121
122 if self.size is not None:
123 size = self.size
124 else:
125 desSize = (int(self.sizeFactor * fwhm) // 2) * 2 + 1 # make result odd
126 if self.minSize and self.minSize > desSize:
127 size = self.minSize
128 elif self.maxSize and self.maxSize < desSize:
129 size = self.maxSize
130 else:
131 size = desSize
132
133 return size, fwhm * SigmaPerFwhm
134
◆ makeField()
| lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.makeField | ( | cls, | |
| doc ) |
Make an lsst.pex.config.ConfigurableField
Definition at line 163 of file gaussianPsfFactory.py.
163 def makeField(cls, doc):
164 """Make an lsst.pex.config.ConfigurableField
165 """
166 def applyWrapper(config, **kwargs):
167 """Construct a Gaussian PSF
168
169 Parameters
170 ----------
171 config : instance of ``GaussianPsfFactory``
172 """
173 return config.apply(**kwargs)
174 return ConfigurableField(
175 doc=doc,
176 target=applyWrapper,
177 ConfigClass=cls
178 )
◆ validate()
| lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.validate | ( | self | ) |
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 `~lsst.pex.config.Field.validate` methods.
Complex single-field validation can be defined by deriving new Field
types. For convenience, some derived `lsst.pex.config.Field`-types
(`~lsst.pex.config.ConfigField` and
`~lsst.pex.config.ConfigChoiceField`) are defined in
``lsst.pex.config`` that handle recursing into subconfigs.
Inter-field relationships should only be checked in derived
`~lsst.pex.config.Config` classes after calling this method, and base
validation is complete.
Reimplemented from lsst.pex.config.config.Config.
Definition at line 135 of file gaussianPsfFactory.py.
135 def validate(self):
136 Config.validate(self)
137 if self.minSize and self.maxSize and self.minSize > self.maxSize:
138 raise RuntimeError("minSize=%s > maxSize=%s" % (self.minSize, self.maxSize))
139
Member Data Documentation
◆ addWing
|
static |
Initial value:
= Field(
doc="Add a Gaussian to represent wings?",
dtype=bool,
optional=False,
default=True,
)
Definition at line 81 of file gaussianPsfFactory.py.
◆ defaultFwhm
|
static |
Initial value:
= Field(
doc="Default FWHM of Gaussian model of core of star (pixels)",
dtype=float,
default=3.0,
check=isPositive,
)
Definition at line 75 of file gaussianPsfFactory.py.
◆ maxSize
|
static |
Initial value:
= Field(
doc="Maximum kernel size if using sizeFactor (pixels); ignored if size is not None",
dtype=int,
optional=True,
default=None,
check=isPositive,
)
Definition at line 68 of file gaussianPsfFactory.py.
◆ minSize
|
static |
Initial value:
= Field(
doc="Minimum kernel size if using sizeFactor (pixels); ignored if size is not None",
dtype=int,
optional=True,
default=5,
check=isPositive,
)
Definition at line 61 of file gaussianPsfFactory.py.
◆ size
|
static |
Initial value:
= Field(
doc="Kernel size (width and height) (pixels); if None then sizeFactor is used",
dtype=int,
optional=True,
default=None,
check=isPositive,
)
Definition at line 46 of file gaussianPsfFactory.py.
◆ sizeFactor
|
static |
Initial value:
= Field(
doc="Kernel size as a factor of fwhm (dimensionless); "
"size = sizeFactor * fwhm; ignored if size is not None",
dtype=float,
optional=False,
default=3.0,
check=isPositive,
)
Definition at line 53 of file gaussianPsfFactory.py.
◆ wingAmplitude
|
static |
Initial value:
= Field(
doc="wing amplitude, as a multiple of core amplitude (dimensionless); ignored if addWing false",
dtype=float,
optional=False,
default=0.1,
check=isPositive,
)
Definition at line 94 of file gaussianPsfFactory.py.
◆ wingFwhmFactor
|
static |
Initial value:
= Field(
doc="wing width, as a multiple of core width (dimensionless); ignored if addWing false",
dtype=float,
optional=False,
default=2.5,
check=isPositive,
)
Definition at line 87 of file gaussianPsfFactory.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_algorithms/ge6526c86ff+0d71447b4b/python/lsst/meas/algorithms/gaussianPsfFactory.py
