lsst.meas.algorithms gf82c78fb6f+5b4928dc2e
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory Class Reference
Inheritance diagram for lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory:

Public Member Functions

def computeSizeAndSigma (self, fwhm=None)
 
def validate (self)
 
def apply (self, fwhm=None)
 
def makeField (cls, doc)
 

Static Public Attributes

Field size
 
Field sizeFactor
 
Field minSize
 
Field maxSize
 
Field defaultFwhm
 
Field addWing
 
Field wingFwhmFactor
 
Field 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()

def 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.

◆ computeSizeAndSigma()

def 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.

◆ makeField()

def lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.makeField (   cls,
  doc 
)
Make an lsst.pex.config.ConfigurableField

Definition at line 163 of file gaussianPsfFactory.py.

◆ validate()

def lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.validate (   self)

Definition at line 135 of file gaussianPsfFactory.py.

Member Data Documentation

◆ addWing

Field lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.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

Field lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.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

Field lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.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

Field lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.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

Field lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.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

Field lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.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

Field lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.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

Field lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.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: