lsst.pipe.tasks  21.0.0-122-gbd923b4f+52e0c4f563
Public Member Functions | Public Attributes | List of all members
lsst.pipe.tasks.extended_psf.ExtendedPsf Class Reference

Public Member Functions

def __init__ (self, default_extended_psf=None)
 
def add_regional_extended_psf (self, extended_psf_image, region_name, detector_list)
 
def __call__ (self, detector=None)
 
def __len__ (self)
 
def get_regional_extended_psf (self, region_name=None, detector=None)
 
def write_fits (self, filename)
 
def writeFits (self, filename)
 
def read_fits (cls, filename)
 
def readFits (cls, filename)
 

Public Attributes

 default_extended_psf
 
 focal_plane_regions
 
 detectors_focal_plane_regions
 

Detailed Description

Extended PSF model.

Each instance may contain a default extended PSF, a set of extended PSFs
that correspond to different focal plane regions, or both. At this time,
focal plane regions are always defined as a subset of detectors.

Parameters
----------
default_extended_psf : `lsst.afw.image.MaskedImageF`
    Extended PSF model to be used as default (or only) extended PSF model.

Definition at line 58 of file extended_psf.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.extended_psf.ExtendedPsf.__init__ (   self,
  default_extended_psf = None 
)

Definition at line 70 of file extended_psf.py.

Member Function Documentation

◆ __call__()

def lsst.pipe.tasks.extended_psf.ExtendedPsf.__call__ (   self,
  detector = None 
)
Return the appropriate extended PSF.

If the instance contains no extended PSF defined over focal plane
regions, the default extended PSF will be returned regardless of
whether a detector ID was passed as argument.

Parameters
----------
detector : `int`, optional
    Detector ID. If focal plane region PSFs are defined, is used to
    determine which model to return.

Returns
-------
extendedPsfImage : `lsst.afw.image.MaskedImageF`
    The extended PSF model. If this instance contains extended PSFs
    defined over focal plane regions, the extended PSF model for the
    region that contains ``detector`` is returned. If not, the default
    extended PSF is returned.

Definition at line 96 of file extended_psf.py.

◆ __len__()

def lsst.pipe.tasks.extended_psf.ExtendedPsf.__len__ (   self)
Returns the number of extended PSF models present in the instance.

Note that if the instance contains both a default model and a set of
focal plane region models, the length of the instance will be the
number of regional models, plus one (the default). This is true even
in the case where the default model is one of the focal plane
region-specific models.

Definition at line 125 of file extended_psf.py.

◆ add_regional_extended_psf()

def lsst.pipe.tasks.extended_psf.ExtendedPsf.add_regional_extended_psf (   self,
  extended_psf_image,
  region_name,
  detector_list 
)
Add a new focal plane region, along wit hits extended PSF, to the
ExtendedPsf instance.

Parameters
----------
extended_psf_image : `lsst.afw.image.MaskedImageF`
    Extended PSF model for the region.
region_name : `str`
    Name of the focal plane region. Will be converted to all-uppercase.
detector_list : `list` [`int`]
    List of IDs for the detectors that define the focal plane region.

Definition at line 75 of file extended_psf.py.

◆ get_regional_extended_psf()

def lsst.pipe.tasks.extended_psf.ExtendedPsf.get_regional_extended_psf (   self,
  region_name = None,
  detector = None 
)
Returns the extended PSF for a focal plane region.

The region can be identified either by name, or through a detector ID.

Parameters
----------
region_name : `str` or `None`, optional
    Name of the region for which the extended PSF should be retrieved.
    Ignored if  ``detector`` is provided. Must be provided if
    ``detector`` is None.
detector : `int` or `None`, optional
    If provided, returns the extended PSF for the focal plane region
    that includes this detector.

Raises
------
ValueError
    Raised if neither ``detector`` nor ``regionName`` is provided.

Definition at line 139 of file extended_psf.py.

◆ read_fits()

def lsst.pipe.tasks.extended_psf.ExtendedPsf.read_fits (   cls,
  filename 
)
Build an instance of this class from a file.

Parameters
----------
filename : `str`
    Name of the file to read.

Definition at line 208 of file extended_psf.py.

◆ readFits()

def lsst.pipe.tasks.extended_psf.ExtendedPsf.readFits (   cls,
  filename 
)
Alias for ``readFits``; exists for compatibility with the Butler.

Definition at line 258 of file extended_psf.py.

◆ write_fits()

def lsst.pipe.tasks.extended_psf.ExtendedPsf.write_fits (   self,
  filename 
)
Write this object to a file.

Parameters
----------
filename : `str`
    Name of file to write.

Definition at line 165 of file extended_psf.py.

◆ writeFits()

def lsst.pipe.tasks.extended_psf.ExtendedPsf.writeFits (   self,
  filename 
)
Alias for ``write_fits``; exists for compatibility with the Butler.

Definition at line 202 of file extended_psf.py.

Member Data Documentation

◆ default_extended_psf

lsst.pipe.tasks.extended_psf.ExtendedPsf.default_extended_psf

Definition at line 71 of file extended_psf.py.

◆ detectors_focal_plane_regions

lsst.pipe.tasks.extended_psf.ExtendedPsf.detectors_focal_plane_regions

Definition at line 73 of file extended_psf.py.

◆ focal_plane_regions

lsst.pipe.tasks.extended_psf.ExtendedPsf.focal_plane_regions

Definition at line 72 of file extended_psf.py.


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