lsst.pipe.tasks g1162b98a3f+7357863717
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
lsst.pipe.tasks.extended_psf.ExtendedPsf Class Reference

Public Member Functions

 __init__ (self, default_extended_psf=None)
 
 add_regional_extended_psf (self, extended_psf_image, region_name, region_detectors)
 
 __call__ (self, detector=None)
 
 __len__ (self)
 
 get_extended_psf (self, region_name)
 
 write_fits (self, filename)
 
 writeFits (self, filename)
 
 read_fits (cls, filename)
 
 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 107 of file extended_psf.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 120 of file extended_psf.py.

Member Function Documentation

◆ __call__()

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 147 of file extended_psf.py.

◆ __len__()

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 176 of file extended_psf.py.

◆ add_regional_extended_psf()

lsst.pipe.tasks.extended_psf.ExtendedPsf.add_regional_extended_psf ( self,
extended_psf_image,
region_name,
region_detectors )
Add a new focal plane region, along with its 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.
region_detectors : `lsst.pipe.tasks.extended_psf.DetectorsInRegion`
    List of detector IDs for the detectors that define a region on the
    focal plane.

Definition at line 125 of file extended_psf.py.

◆ get_extended_psf()

lsst.pipe.tasks.extended_psf.ExtendedPsf.get_extended_psf ( self,
region_name )
Returns the extended PSF for a focal plane region or detector.

This method takes either a region name or a detector ID as input. If
the input is a `str` type, it is assumed to be the region name and if
the input is a `int` type it is assumed to be the detector ID.

Parameters
----------
region_name : `str` or `int`
    Name of the region (str) or detector (int) for which the extended
    PSF should be retrieved.

Returns
-------
extended_psf_image: `lsst.afw.image.MaskedImageF`
    The extended PSF model for the requested region or detector.

Raises
------
ValueError
    Raised if the input is not in the correct type.

Definition at line 190 of file extended_psf.py.

◆ read_fits()

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 263 of file extended_psf.py.

◆ readFits()

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

Definition at line 316 of file extended_psf.py.

◆ write_fits()

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 221 of file extended_psf.py.

◆ writeFits()

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

Definition at line 258 of file extended_psf.py.

Member Data Documentation

◆ default_extended_psf

lsst.pipe.tasks.extended_psf.ExtendedPsf.default_extended_psf

Definition at line 121 of file extended_psf.py.

◆ detectors_focal_plane_regions

lsst.pipe.tasks.extended_psf.ExtendedPsf.detectors_focal_plane_regions

Definition at line 123 of file extended_psf.py.

◆ focal_plane_regions

lsst.pipe.tasks.extended_psf.ExtendedPsf.focal_plane_regions

Definition at line 122 of file extended_psf.py.


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