lsst.afw g1b7e58284d+7dcd958d67
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
lsst.afw.image._image._multiband.MultibandPixel Class Reference
Inheritance diagram for lsst.afw.image._image._multiband.MultibandPixel:
lsst.afw.multiband.MultibandBase

Public Member Functions

def __init__ (self, filters, singles, position)
 
def clone (self, deep=True)
 
def __getitem__ (self, indices)
 

Properties

 array = property(_getArray, _setArray)
 

Detailed Description

Multiband Pixel class

This represent acts as a container for a single pixel
(scalar) in multiple bands.

Parameters
----------
singles : `sequence`
   Either a list of single band objects or an array of values.
filters : `list`
   List of filter names. If `singles` is an `OrderedDict` or
   a `MultibandPixel` then this argument is ignored,
   otherwise it is required.
position : `Point2I`
   Location of the pixel in the parent image.
   Unlike other objects that inherit from `MultibandBase`,
   `MultibandPixel` objects don't have a full `Box2I`
   bounding box, since they only contain a single pixel,
   so the bounding box cannot be inherited from the
   list of `singles`.

Definition at line 33 of file _multiband.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.afw.image._image._multiband.MultibandPixel.__init__ (   self,
  filters,
  singles,
  position 
)

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 55 of file _multiband.py.

Member Function Documentation

◆ __getitem__()

def lsst.afw.image._image._multiband.MultibandPixel.__getitem__ (   self,
  indices 
)
Get a slice of the underlying array

Since a `MultibandPixel` is a scalar in the
spatial dimensions, it can only be indexed with
a filter name, number, or slice.

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 100 of file _multiband.py.

◆ clone()

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

`MultibandPixel.singles` is an array,
so this just makes a copy of the array
(as opposed to a view of the parent array).

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 84 of file _multiband.py.

Property Documentation

◆ array

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

Definition at line 82 of file _multiband.py.


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