lsst.meas.algorithms  13.0-23-gb99accf
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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
 
def validate
 
def apply
 
def makeField
 

Static Public Attributes

tuple size
 
tuple sizeFactor
 
tuple minSize
 
tuple maxSize
 
tuple defaultFwhm
 
tuple addWing
 
tuple wingFwhmFactor
 
tuple 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 40 of file gaussianPsfFactory.py.

Member Function Documentation

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

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

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

Definition at line 152 of file gaussianPsfFactory.py.

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

Definition at line 132 of file gaussianPsfFactory.py.

Member Data Documentation

tuple lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.addWing
static
Initial value:
1 = Field(
2  doc="Add a Gaussian to represent wings?",
3  dtype=bool,
4  optional=False,
5  default=True,
6  )

Definition at line 83 of file gaussianPsfFactory.py.

tuple lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.defaultFwhm
static
Initial value:
1 = Field(
2  doc="Default FWHM of Gaussian model of core of star (pixels)",
3  dtype=float,
4  default=3.0,
5  check=isPositive,
6  )

Definition at line 77 of file gaussianPsfFactory.py.

tuple lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.maxSize
static
Initial value:
1 = Field(
2  doc="Maximum kernel size if using sizeFactor (pixels); ignored if size is not None",
3  dtype=int,
4  optional=True,
5  default=None,
6  check=isPositive,
7  )

Definition at line 70 of file gaussianPsfFactory.py.

tuple lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.minSize
static
Initial value:
1 = Field(
2  doc="Minimum kernel size if using sizeFactor (pixels); ignored if size is not None",
3  dtype=int,
4  optional=True,
5  default=5,
6  check=isPositive,
7  )

Definition at line 63 of file gaussianPsfFactory.py.

tuple lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.size
static
Initial value:
1 = Field(
2  doc="Kernel size (width and height) (pixels); if None then sizeFactor is used",
3  dtype=int,
4  optional=True,
5  default=None,
6  check=isPositive,
7  )

Definition at line 48 of file gaussianPsfFactory.py.

tuple lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.sizeFactor
static
Initial value:
1 = Field(
2  doc = "Kernel size as a factor of fwhm (dimensionless); " +
3  "size = sizeFactor * fwhm; ignored if size is not None",
4  dtype=float,
5  optional=False,
6  default=3.0,
7  check=isPositive,
8  )

Definition at line 55 of file gaussianPsfFactory.py.

tuple lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.wingAmplitude
static
Initial value:
1 = Field(
2  doc="wing amplitude, as a multiple of core amplitude (dimensionless); ignored if addWing false",
3  dtype=float,
4  optional=False,
5  default=0.1,
6  check=isPositive,
7  )

Definition at line 96 of file gaussianPsfFactory.py.

tuple lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory.wingFwhmFactor
static
Initial value:
1 = Field(
2  doc="wing width, as a multiple of core width (dimensionless); ignored if addWing false",
3  dtype=float,
4  optional=False,
5  default=2.5,
6  check=isPositive,
7  )

Definition at line 89 of file gaussianPsfFactory.py.


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