lsst.meas.algorithms  20.0.0-6-g01203fff+883dccf1c0
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

 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 39 of file gaussianPsfFactory.py.

Member Function Documentation

◆ apply()

def lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.apply (   self,
  fwhm = None 
)
Construct a GaussianPsf

@param[in] self: an instance of ConfigClass
@param[in] fwhm: FWHM of core of star (pixels); if None then self.defaultFwhm is used
@return a DoubleGaussianPsf if self.addWing is True, else a SingleGaussianPsf

Definition at line 136 of file gaussianPsfFactory.py.

◆ computeSizeAndSigma()

def lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.computeSizeAndSigma (   self,
  fwhm = None 
)
Compute kernel size and star width as sigma

kernel size will be odd unless minSize or maxSize is used and that value is even.

@param[in] fwhm: FWHM of core star (pixels); if None then defaultFwhm is used
@return two values:
- kernel size (width == height) in pixels
- sigma equivalent to supplied fwhm, assuming a Gaussian (pixels)

@warning assumes a valid config

Definition at line 103 of file gaussianPsfFactory.py.

◆ makeField()

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

Definition at line 151 of file gaussianPsfFactory.py.

◆ validate()

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

Definition at line 131 of file gaussianPsfFactory.py.

Member Data Documentation

◆ addWing

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 82 of file gaussianPsfFactory.py.

◆ defaultFwhm

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 76 of file gaussianPsfFactory.py.

◆ maxSize

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 69 of file gaussianPsfFactory.py.

◆ minSize

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 62 of file gaussianPsfFactory.py.

◆ size

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 47 of file gaussianPsfFactory.py.

◆ sizeFactor

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 54 of file gaussianPsfFactory.py.

◆ wingAmplitude

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 95 of file gaussianPsfFactory.py.

◆ wingFwhmFactor

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 88 of file gaussianPsfFactory.py.


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