lsst.afw g9c22b2923f+53520f316c
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
lsst.afw.image._image._multiband.MultibandTripleBase Class Reference
Inheritance diagram for lsst.afw.image._image._multiband.MultibandTripleBase:
lsst.afw.multiband.MultibandBase lsst.afw.image._exposure._multiband.MultibandExposure lsst.afw.image._image._multiband.MultibandMaskedImage

Public Member Functions

 __init__ (self, filters, image, mask, variance)
 
 setXY0 (self, xy0)
 
 shiftedTo (self, xy0)
 
 clone (self, deep=True)
 
 image (self)
 
 mask (self)
 
 variance (self)
 
 getBBox (self, origin=PARENT)
 

Public Attributes

 filters
 

Protected Member Functions

 _slice (self, filters, filterIndex, indices)
 
 _verifyUpdate (self, image=None, mask=None, variance=None)
 

Protected Attributes

 _filters
 
 _image
 
 _mask
 
 _variance
 
 _singles
 
 _bbox
 

Detailed Description

MultibandTripleBase class

This is a base class inherited by multiband classes
with `image`, `mask`, and `variance` objects,
such as `MultibandMaskedImage` and `MultibandExposure`.

Parameters
----------
filters : `list`
   List of filter names. If `singles` is an `OrderedDict`
   then this argument is ignored, otherwise it is required.
image : `list` or `MultibandImage`
   List of `Image` objects that represent the image in each band or
   a `MultibandImage`.
   Ignored if `singles` is not `None`.
mask : `list` or `MultibandMask`
   List of `Mask` objects that represent the mask in each bandor
   a `MultibandMask`.
   Ignored if `singles` is not `None`.
variance : `list` or `MultibandImage`
   List of `Image` objects that represent the variance in each bandor
   a `MultibandImage`.
   Ignored if `singles` is not `None`.

Definition at line 554 of file _multiband.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.afw.image._image._multiband.MultibandTripleBase.__init__ ( self,
filters,
image,
mask,
variance )

Member Function Documentation

◆ _slice()

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

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

Reimplemented from lsst.afw.multiband.MultibandBase.

Reimplemented in lsst.afw.image._exposure._multiband.MultibandExposure.

Definition at line 653 of file _multiband.py.

◆ _verifyUpdate()

lsst.afw.image._image._multiband.MultibandTripleBase._verifyUpdate ( self,
image = None,
mask = None,
variance = None )
protected
Check that the new image, mask, or variance is valid

This basically means checking that the update to the
property matches the current bounding box and inherits
from the `MultibandBase` class.

Definition at line 680 of file _multiband.py.

◆ clone()

lsst.afw.image._image._multiband.MultibandTripleBase.clone ( self,
deep = True )
Make a copy of the current instance

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 639 of file _multiband.py.

◆ getBBox()

lsst.afw.image._image._multiband.MultibandTripleBase.getBBox ( self,
origin = PARENT )
Bounding box

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 710 of file _multiband.py.

◆ image()

lsst.afw.image._image._multiband.MultibandTripleBase.image ( self)
The image of the MultibandMaskedImage

Definition at line 696 of file _multiband.py.

◆ mask()

lsst.afw.image._image._multiband.MultibandTripleBase.mask ( self)
The mask of the MultibandMaskedImage

Definition at line 701 of file _multiband.py.

◆ setXY0()

lsst.afw.image._image._multiband.MultibandTripleBase.setXY0 ( self,
xy0 )
Shift the bounding box but keep the same Extent
This is different than `MultibandBase.setXY0`
because the multiband `image`, `mask`, and `variance` objects
must all have their bounding boxes updated.
Parameters
----------
xy0 : `Point2I`
   New minimum bounds of the bounding box

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 595 of file _multiband.py.

◆ shiftedTo()

lsst.afw.image._image._multiband.MultibandTripleBase.shiftedTo ( self,
xy0 )
Shift the bounding box but keep the same Extent

This is different than `MultibandBase.shiftedTo`
because the multiband `image`, `mask`, and `variance` objects
must all have their bounding boxes updated.

Parameters
----------
xy0 : `Point2I`
   New minimum bounds of the bounding box

Returns
-------
result : `MultibandBase`
   A copy of the object, shifted to `xy0`.

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 612 of file _multiband.py.

◆ variance()

lsst.afw.image._image._multiband.MultibandTripleBase.variance ( self)
The variance of the MultibandMaskedImage

Definition at line 706 of file _multiband.py.

Member Data Documentation

◆ _bbox

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

Definition at line 593 of file _multiband.py.

◆ _filters

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

Definition at line 580 of file _multiband.py.

◆ _image

lsst.afw.image._image._multiband.MultibandTripleBase._image
protected

Definition at line 588 of file _multiband.py.

◆ _mask

lsst.afw.image._image._multiband.MultibandTripleBase._mask
protected

Definition at line 589 of file _multiband.py.

◆ _singles

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

Definition at line 592 of file _multiband.py.

◆ _variance

lsst.afw.image._image._multiband.MultibandTripleBase._variance
protected

Definition at line 590 of file _multiband.py.

◆ filters

lsst.afw.image._image._multiband.MultibandTripleBase.filters

Definition at line 651 of file _multiband.py.


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