lsst.afw.image.image._multiband.MultibandMaskedImage Class Reference

Inheritance diagram for lsst.afw.image.image._multiband.MultibandMaskedImage:

Public Member Functions
def	__init__ (self, filters, image=None, mask=None, variance=None)

Static Public Member Functions
def	fromImages (filters, singles)
def	fromArrays (filters, image, mask, variance, bbox=None)
def	fromKwargs (filters, filterKwargs, singleType=MaskedImageF, **kwargs)

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__()

def 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.

    def __init__(self, filters, image=None, mask=None, variance=None):
        super().__init__(filters, image, mask, variance)
 

Member Function Documentation

fromArrays()

def 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.

    def fromArrays(filters, image, mask, variance, bbox=None):
        """Construct a MultibandMaskedImage from a collection of arrays
 
        see `tripleFromArrays` for a description of parameters
        """
        return tripleFromArrays(MultibandMaskedImage, filters, image, mask, variance, bbox)
 

fromImages()

def 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.

    def fromImages(filters, singles):
        """Construct a MultibandImage from a collection of single band images
 
        see `tripleFromImages` for a description of parameters
        """
        return tripleFromSingles(MultibandMaskedImage, filters, singles)
 

fromKwargs()

def 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.

    def fromKwargs(filters, filterKwargs, singleType=MaskedImageF, **kwargs):
        """Build a MultibandImage from a set of keyword arguments
 
        see `makeTripleFromKwargs` for a description of parameters
        """
        return makeTripleFromKwargs(MultibandMaskedImage, filters, filterKwargs, singleType, **kwargs)
 

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-5.0.1/Linux64/afw/gf46e8334de+81c9a61069/python/lsst/afw/image/image/_multiband.py