lsst.afw g9029821c7d+808890523f
Public Member Functions | Static Public 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

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

Static Public Member Functions

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

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 33 of file _multiband.py.

Constructor & Destructor Documentation

◆ __init__()

def 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 42 of file _multiband.py.

Member Function Documentation

◆ computePsfImage()

def 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 183 of file _multiband.py.

◆ computePsfKernelImage()

def lsst.afw.image.exposure._multiband.MultibandExposure.computePsfKernelImage (   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 149 of file _multiband.py.

◆ fromArrays()

def 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 58 of file _multiband.py.

◆ fromButler()

def lsst.afw.image.exposure._multiband.MultibandExposure.fromButler (   butler,
  filters,
  filterKwargs,
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
filters: `list` or `str`
    List of bands.
filterKwargs: `dict`
    Keyword arguments to pass to the Butler
    that are different for each filter.
    The keys are the names of the arguments and the values
    should also be dictionaries, with filter names as keys
    and the value of the argument for the given filter as values.
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 108 of file _multiband.py.

◆ fromExposures()

def 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 49 of file _multiband.py.

◆ fromKwargs()

def 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 66 of file _multiband.py.


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