lsst.afw g8cdfe0ae6a+66d966b544
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | 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

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

Public Attributes

 singles
 

Protected Member Functions

 _getArray (self)
 
 _setArray (self, value)
 
 _slice (self, filters, filterIndex, indices)
 

Protected Attributes

 _array
 
 _filters
 
 _bbox
 
 _singles
 

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

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

Member Function Documentation

◆ __setitem__()

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

Definition at line 249 of file _multiband.py.

◆ _getArray()

lsst.afw.image._image._multiband.MultibandImageBase._getArray ( self)
protected
Data cube array in multiple bands

Returns
-------
self._array : array
   The resulting 3D data cube with shape (filters, y, x).

Definition at line 174 of file _multiband.py.

◆ _setArray()

lsst.afw.image._image._multiband.MultibandImageBase._setArray ( self,
value )
protected
Set the values of the array

Definition at line 184 of file _multiband.py.

◆ _slice()

lsst.afw.image._image._multiband.MultibandImageBase._slice ( self,
filters,
filterIndex,
indices )
protected
Slice the current object and return the result

See `MultibandBase._slice` for a list of the parameters.

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 207 of file _multiband.py.

◆ clone()

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

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.

Member Data Documentation

◆ _array

lsst.afw.image._image._multiband.MultibandImageBase._array
protected

Definition at line 160 of file _multiband.py.

◆ _bbox

lsst.afw.image._image._multiband.MultibandImageBase._bbox
protected

Definition at line 164 of file _multiband.py.

◆ _filters

lsst.afw.image._image._multiband.MultibandImageBase._filters
protected

Definition at line 161 of file _multiband.py.

◆ _singles

lsst.afw.image._image._multiband.MultibandImageBase._singles
protected

Definition at line 168 of file _multiband.py.

◆ singles

lsst.afw.image._image._multiband.MultibandImageBase.singles

Definition at line 172 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: