lsst.afw g87b8406481+196bea11fd
Loading...
Searching...
No Matches
Classes | Functions
lsst.afw.image.image._multiband Namespace Reference

Classes

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

Functions

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

Function Documentation

◆ makeImageFromKwargs()

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

◆ makeImageFromSingles()

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

◆ makeTripleFromKwargs()

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

◆ tripleFromArrays()

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

◆ tripleFromSingles()

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