lsst.afw.image._image._multiband Namespace Reference

Classes
class	MultibandImage
class	MultibandImageBase
class	MultibandMask
class	MultibandMaskedImage
class	MultibandPixel
class	MultibandTripleBase

Functions
	makeImageFromSingles (cls, filters, singles)
	makeImageFromKwargs (cls, filters, filterKwargs, singleType=ImageF, **kwargs)
	tripleFromSingles (cls, filters, singles, **kwargs)
	tripleFromArrays (cls, filters, image, mask, variance, bbox=None)
	makeTripleFromKwargs (cls, filters, filterKwargs, singleType, **kwargs)

Function Documentation

makeImageFromKwargs()

lsst.afw.image._image._multiband.makeImageFromKwargs	(		cls,
			filters,
			filterKwargs,
			singleType = ImageF,
		**	kwargs )

Build a MultibandImage from a set of keyword arguments

Parameters
----------
filters : `list`
   List of filter names.
singleType : class
   Class of the single band objects.
   This is ignored unless `singles` and `array`
   are both `None`, in which case it is required.
filterKwargs : `dict`
   Keyword arguments to initialize a new instance of an inherited class
   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 a given filter as values.
kwargs : `dict`
   Keyword arguments to initialize a new instance of an
   inherited class that are the same in all bands.

Definition at line 297 of file _multiband.py.

def makeImageFromKwargs(cls, filters, filterKwargs, singleType=ImageF, **kwargs):
    """Build a MultibandImage from a set of keyword arguments
 
    Parameters
    ----------
    filters : `list`
       List of filter names.
    singleType : class
       Class of the single band objects.
       This is ignored unless `singles` and `array`
       are both `None`, in which case it is required.
    filterKwargs : `dict`
       Keyword arguments to initialize a new instance of an inherited class
       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 a given filter as values.
    kwargs : `dict`
       Keyword arguments to initialize a new instance of an
       inherited class that are the same in all bands.
    """
    # Attempt to load a set of images
    singles = []
    for f in filters:
        if filterKwargs is not None:
            for key, value in filterKwargs:
                kwargs[key] = value[f]
        singles.append(singleType(**kwargs))
    return cls.makeImageFromSingles(filters, singles)
 
 

makeImageFromSingles()

lsst.afw.image._image._multiband.makeImageFromSingles	(		cls,
			filters,
			singles )

Construct a MultibandImage from a collection of single band images

Parameters
----------
filters : `list`
   List of filter names.
singles : `list`
   A list of single band objects.
   If `array` is not `None`, then `singles` is ignored

Definition at line 279 of file _multiband.py.

def makeImageFromSingles(cls, filters, singles):
    """Construct a MultibandImage from a collection of single band images
 
    Parameters
    ----------
    filters : `list`
       List of filter names.
    singles : `list`
       A list of single band objects.
       If `array` is not `None`, then `singles` is ignored
    """
    array = np.array([image.array for image in singles], dtype=singles[0].array.dtype)
    if not np.all([image.getBBox() == singles[0].getBBox() for image in singles[1:]]):
        raise ValueError("Single band images did not all have the same bounding box")
    bbox = singles[0].getBBox()
    return cls(filters, array, bbox)
 
 

makeTripleFromKwargs()

lsst.afw.image._image._multiband.makeTripleFromKwargs	(		cls,
			filters,
			filterKwargs,
			singleType,
		**	kwargs )

Build a MultibandImage from a set of keyword arguments

Parameters
----------
filters : `list`
   List of filter names.
singleType : `class`
   Class of the single band objects.
   This is ignored unless `singles` and `array`
   are both `None`, in which case it is required.
filterKwargs : `dict`
   Keyword arguments to initialize a new instance of an inherited class
   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 a given filter as values.
kwargs : `dict`
   Keyword arguments to initialize a new instance of an inherited
   class that are the same in all bands.

Definition at line 770 of file _multiband.py.

def makeTripleFromKwargs(cls, filters, filterKwargs, singleType, **kwargs):
    """Build a MultibandImage from a set of keyword arguments
 
    Parameters
    ----------
    filters : `list`
       List of filter names.
    singleType : `class`
       Class of the single band objects.
       This is ignored unless `singles` and `array`
       are both `None`, in which case it is required.
    filterKwargs : `dict`
       Keyword arguments to initialize a new instance of an inherited class
       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 a given filter as values.
    kwargs : `dict`
       Keyword arguments to initialize a new instance of an inherited
       class that are the same in all bands.
    """
    # Attempt to load a set of images
    singles = []
    for f in filters:
        if filterKwargs is not None:
            for key, value in filterKwargs:
                kwargs[key] = value[f]
        singles.append(singleType(**kwargs))
    return tripleFromSingles(cls, filters, singles)
 
 

tripleFromArrays()

lsst.afw.image._image._multiband.tripleFromArrays	(		cls,
			filters,
			image,
			mask,
			variance,
			bbox = None )

Construct a MultibandTriple from a set of arrays

Parameters
----------
filters : `list`
   List of filter names.
image : array
   Array of image values
mask : array
   Array of mask values
variance : array
   Array of variance values
bbox : `Box2I`
   Location of the array in a larger single band image.
   This argument is ignored if `singles` is not `None`.

Definition at line 739 of file _multiband.py.

def tripleFromArrays(cls, filters, image, mask, variance, bbox=None):
    """Construct a MultibandTriple from a set of arrays
 
    Parameters
    ----------
    filters : `list`
       List of filter names.
    image : array
       Array of image values
    mask : array
       Array of mask values
    variance : array
       Array of variance values
    bbox : `Box2I`
       Location of the array in a larger single band image.
       This argument is ignored if `singles` is not `None`.
    """
    if bbox is None:
        bbox = Box2I(Point2I(0, 0), Extent2I(image.shape[1], image.shape[0]))
    mImage = MultibandImage(filters, image, bbox)
    if mask is not None:
        mMask = MultibandMask(filters, mask, bbox)
    else:
        mMask = None
    if variance is not None:
        mVariance = MultibandImage(filters, variance, bbox)
    else:
        mVariance = None
    return cls(filters, mImage, mMask, mVariance)
 
 

tripleFromSingles()

lsst.afw.image._image._multiband.tripleFromSingles	(		cls,
			filters,
			singles,
		**	kwargs )

Construct a MultibandTriple from a collection of single band objects

Parameters
----------
filters : `list`
   List of filter names.
singles : `list`
   A list of single band objects.
   If `array` is not `None`, then `singles` is ignored

Definition at line 720 of file _multiband.py.

def tripleFromSingles(cls, filters, singles, **kwargs):
    """Construct a MultibandTriple from a collection of single band objects
 
    Parameters
    ----------
    filters : `list`
       List of filter names.
    singles : `list`
       A list of single band objects.
       If `array` is not `None`, then `singles` is ignored
    """
    if not np.all([single.getBBox() == singles[0].getBBox() for single in singles[1:]]):
        raise ValueError("Single band images did not all have the same bounding box")
    image = MultibandImage.fromImages(filters, [s.image for s in singles])
    mask = MultibandMask.fromMasks(filters, [s.mask for s in singles])
    variance = MultibandImage.fromImages(filters, [s.variance for s in singles])
    return cls(filters, image, mask, variance, **kwargs)