lsst.afw gb3a676b8dc+b4feba26a1
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
lsst.afw.image._exposure._multiband.MultibandExposure Class Reference
Inheritance diagram for lsst.afw.image._exposure._multiband.MultibandExposure:
lsst.afw.image._image._multiband.MultibandTripleBase lsst.afw.multiband.MultibandBase

Public Member Functions

 __init__ (self, filters, image, mask, variance, psfs=None)
 
 computePsfKernelImage (self, position)
 
 computePsfImage (self, position=None)
 
 getPsfs (self)
 

Static Public Member Functions

 fromExposures (filters, singles)
 
 fromArrays (filters, image, mask, variance, bbox=None)
 
 fromKwargs (filters, filterKwargs, singleType=ExposureF, **kwargs)
 
 fromButler (butler, bands, *args, **kwargs)
 

Public Attributes

 singles
 

Protected Member Functions

 _buildSingles (self, image=None, mask=None, variance=None)
 
 _slice (self, filters, filterIndex, indices)
 

Detailed Description

MultibandExposure class

This class acts as a container for multiple `afw.Exposure` objects.
All exposures must have the same bounding box, and the associated
images must all have the same data type.

See `MultibandTripleBase` for parameter definitions.

Definition at line 119 of file _multiband.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.afw.image._exposure._multiband.MultibandExposure.__init__ ( self,
filters,
image,
mask,
variance,
psfs = None )

Reimplemented from lsst.afw.image._image._multiband.MultibandTripleBase.

Definition at line 128 of file _multiband.py.

Member Function Documentation

◆ _buildSingles()

lsst.afw.image._exposure._multiband.MultibandExposure._buildSingles ( self,
image = None,
mask = None,
variance = None )
protected
Make a new list of single band objects

Parameters
----------
image: `list`
    List of `Image` objects that represent the image in each band.
mask: `list`
    List of `Mask` objects that represent the mask in each band.
variance: `list`
    List of `Image` objects that represent the variance in each band.

Returns
-------
singles: tuple
    Tuple of `MaskedImage` objects for each band,
    where the `image`, `mask`, and `variance` of each `single`
    point to the multiband objects.

Definition at line 159 of file _multiband.py.

◆ _slice()

lsst.afw.image._exposure._multiband.MultibandExposure._slice ( self,
filters,
filterIndex,
indices )
protected
Slice the current object and return the result

See `Multiband._slice` for a list of the parameters.
This overwrites the base method to attach the PSF to
each individual exposure.

Reimplemented from lsst.afw.image._image._multiband.MultibandTripleBase.

Definition at line 289 of file _multiband.py.

◆ computePsfImage()

lsst.afw.image._exposure._multiband.MultibandExposure.computePsfImage ( self,
position = None )
Get a multiband PSF image

The PSF Kernel Image is computed for each band
and combined into a (filter, y, x) array and stored
as `self._psfImage`.
The result is not cached, so if the same PSF is expected
to be used multiple times it is a good idea to store the
result in another variable.

Parameters
----------
position: `Point2D` or `tuple`
    Coordinates to evaluate the PSF. If `position` is `None`
    then `Psf.getAveragePosition()` is used.

Returns
-------
self._psfImage: array
    The multiband PSF image.

Definition at line 252 of file _multiband.py.

◆ computePsfKernelImage()

lsst.afw.image._exposure._multiband.MultibandExposure.computePsfKernelImage ( self,
position )
Get a multiband PSF image

The PSF Kernel Image is computed for each band
and combined into a (filter, y, x) array and stored
as `self._psfImage`.
The result is not cached, so if the same PSF is expected
to be used multiple times it is a good idea to store the
result in another variable.

Parameters
----------
position: `Point2D` or `tuple`
    Coordinates to evaluate the PSF.

Returns
-------
self._psfImage: array
    The multiband PSF image.

Definition at line 226 of file _multiband.py.

◆ fromArrays()

lsst.afw.image._exposure._multiband.MultibandExposure.fromArrays ( filters,
image,
mask,
variance,
bbox = None )
static
Construct a MultibandExposure from a collection of arrays

see `tripleFromArrays` for a description of parameters

Definition at line 144 of file _multiband.py.

◆ fromButler()

lsst.afw.image._exposure._multiband.MultibandExposure.fromButler ( butler,
bands,
* args,
** kwargs )
static
Load a multiband exposure from a butler

Because each band is stored in a separate exposure file,
this method can be used to load all of the exposures for
a given set of bands

Parameters
----------
butler: `lsst.daf.butler.Butler`
    Butler connection to use to load the single band
    calibrated images
bands: `list` or `str`
    List of names for each band
args: `list`
    Arguments to the Butler.
kwargs: `dict`
    Keyword arguments to pass to the Butler
    that are the same in all bands.

Returns
-------
result: `MultibandExposure`
    The new `MultibandExposure` created by combining all of the
    single band exposures.

Definition at line 194 of file _multiband.py.

◆ fromExposures()

lsst.afw.image._exposure._multiband.MultibandExposure.fromExposures ( filters,
singles )
static
Construct a MultibandImage from a collection of single band images

see `tripleFromExposures` for a description of parameters

Definition at line 135 of file _multiband.py.

◆ fromKwargs()

lsst.afw.image._exposure._multiband.MultibandExposure.fromKwargs ( filters,
filterKwargs,
singleType = ExposureF,
** kwargs )
static
Build a MultibandImage from a set of keyword arguments

see `makeTripleFromKwargs` for a description of parameters

Definition at line 152 of file _multiband.py.

◆ getPsfs()

lsst.afw.image._exposure._multiband.MultibandExposure.getPsfs ( self)
Extract the PSF model in each band

Returns
-------
psfs : `dict` of `lsst.afw.detection.Psf`
    The PSF in each band

Definition at line 279 of file _multiband.py.

Member Data Documentation

◆ singles

lsst.afw.image._exposure._multiband.MultibandExposure.singles

Definition at line 131 of file _multiband.py.


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