lsst.afw g8cdfe0ae6a+4fd9e222a8
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
lsst.afw.image._image._multiband.MultibandMaskedImage Class Reference
Inheritance diagram for lsst.afw.image._image._multiband.MultibandMaskedImage:
lsst.afw.image._image._multiband.MultibandTripleBase lsst.afw.multiband.MultibandBase

Public Member Functions

 __init__ (self, filters, image=None, mask=None, variance=None)
 

Static Public Member Functions

 fromImages (filters, singles)
 
 fromArrays (filters, image, mask, variance, bbox=None)
 
 fromKwargs (filters, filterKwargs, singleType=MaskedImageF, **kwargs)
 

Protected Member Functions

 _buildSingles (self, image=None, mask=None, variance=None)
 

Detailed Description

MultibandMaskedImage class

This class acts as a container for multiple `afw.MaskedImage` objects.
All masked images must have the same bounding box, and the associated
images must all have the same data type.
The `image`, `mask`, and `variance` are all stored separately into
a `MultibandImage`, `MultibandMask`, and `MultibandImage` respectively,
which each have their own internal 3D arrays (filter, y, x).

See `MultibandTripleBase` for parameter definitions.

Definition at line 801 of file _multiband.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.afw.image._image._multiband.MultibandMaskedImage.__init__ ( self,
filters,
image = None,
mask = None,
variance = None )

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

Definition at line 813 of file _multiband.py.

Member Function Documentation

◆ _buildSingles()

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

Parameters
----------
image : `MultibandImage`
   `MultibandImage` object that represent the image in each band.
mask : `MultibandMask`
   `MultibandMask` object that represent the mask in each band.
variance : `MultibandImage`
   `MultibandImage` object 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 840 of file _multiband.py.

◆ fromArrays()

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

see `tripleFromArrays` for a description of parameters

Definition at line 825 of file _multiband.py.

◆ fromImages()

lsst.afw.image._image._multiband.MultibandMaskedImage.fromImages ( filters,
singles )
static
Construct a MultibandImage from a collection of single band images

see `tripleFromImages` for a description of parameters

Definition at line 817 of file _multiband.py.

◆ fromKwargs()

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

see `makeTripleFromKwargs` for a description of parameters

Definition at line 833 of file _multiband.py.


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