lsst.afw.image._image._multiband Namespace Reference

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

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

Function Documentation

makeImageFromKwargs()

makeImageFromKwargs	(		cls,
			bands,
			bandKwargs,
			singleType = ImageF,
		**	kwargs )

Build a MultibandImage from a set of keyword arguments

Parameters
----------
bands : `list`
   List of band 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.
bandKwargs : `dict`
   Keyword arguments to initialize a new instance of an inherited class
   that are different for each band.
   The keys are the names of the arguments and the values
   should also be dictionaries, with band names as keys
   and the value of the argument for a given band 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()

makeImageFromSingles	(		cls,
			bands,
			singles )

Construct a MultibandImage from a collection of single band images

Parameters
----------
bands : `list`
   List of band 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()

makeTripleFromKwargs	(		cls,
			bands,
			bandKwargs,
			singleType,
		**	kwargs )

Build a MultibandImage from a set of keyword arguments

Parameters
----------
bands : `list`
   List of band 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.
bandKwargs : `dict`
   Keyword arguments to initialize a new instance of an inherited class
   that are different for each band.
   The keys are the names of the arguments and the values
   should also be dictionaries, with band names as keys
   and the value of the argument for a given band 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()

tripleFromArrays	(		cls,
			bands,
			image,
			mask,
			variance,
			bbox = None )

Construct a MultibandTriple from a set of arrays

Parameters
----------
bands : `list`
   List of band 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()

tripleFromSingles	(		cls,
			bands,
			singles,
		**	kwargs )

Construct a MultibandTriple from a collection of single band objects

Parameters
----------
bands : `list`
   List of band 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.