lsst.afw g776a55d5bd+f790144ad9
Public Member Functions | Properties | List of all members
lsst.afw.image.image._multiband.MultibandImageBase Class Reference
Inheritance diagram for lsst.afw.image.image._multiband.MultibandImageBase:
lsst.afw.multiband.MultibandBase lsst.afw.image.image._multiband.MultibandImage lsst.afw.image.image._multiband.MultibandMask

Public Member Functions

def __init__ (self, filters, array, singleType, bbox=None)
 
def clone (self, deep=True)
 
def __setitem__ (self, args, value)
 
def getBBox (self, origin=PARENT)
 

Properties

 array = property(_getArray, _setArray)
 

Detailed Description

Multiband Image class

This class acts as a container for multiple `afw.Image` objects.
All images must be contained in the same bounding box,
and have the same data type.
The data is stored in a 3D array (filters, y, x), and the single
band `Image` instances have an internal array that points to the
3D multiband array, so that the single band objects and multiband
array are always in agreement.

Parameters
----------
filters : `list`
   List of filter names.
array : 3D numpy array
   Array (filters, y, x) of multiband data.
   If this is used to initialize a `MultibandImage`,
   either `bbox` or `singles` is also required.
singleType : `type`
   Type of the single band object (eg. `Image`, `Mask`) to
   convert the array into a tuple of single band objects
   that point to the image array.
bbox : `Box2I`
   Location of the array in a larger single band image.
   If `bbox` is `None` then the bounding box is initialized
   at the origin.

Definition at line 128 of file _multiband.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.afw.image.image._multiband.MultibandImageBase.__init__ (   self,
  filters,
  array,
  singleType,
  bbox = None 
)

Member Function Documentation

◆ __setitem__()

def lsst.afw.image.image._multiband.MultibandImageBase.__setitem__ (   self,
  args,
  value 
)
Set a subset of the MultibandImage

Definition at line 249 of file _multiband.py.

◆ clone()

def lsst.afw.image.image._multiband.MultibandImageBase.clone (   self,
  deep = True 
)
Copy the current object

Parameters
----------
deep : `bool`
   Whether or not to make a deep copy

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 190 of file _multiband.py.

◆ getBBox()

def lsst.afw.image.image._multiband.MultibandImageBase.getBBox (   self,
  origin = PARENT 
)
Bounding box

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 269 of file _multiband.py.

Property Documentation

◆ array

lsst.afw.image.image._multiband.MultibandImageBase.array = property(_getArray, _setArray)
static

Definition at line 188 of file _multiband.py.


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