lsst.afw g5a732f18d5+53520f316c
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | 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

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

Protected Member Functions

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

Protected Attributes

 _singles
 

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

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

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.

◆ _getArray()

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

Since `self._singles` is just a 1D array,
`array` just returns `self._singles`.

Definition at line 70 of file _multiband.py.

◆ _setArray()

lsst.afw.image._image._multiband.MultibandPixel._setArray ( self,
value )
protected

Definition at line 78 of file _multiband.py.

◆ _slice()

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

Different inherited classes will handling slicing differently,
so this method must be overloaded in inherited classes.

Parameters
----------
filters: `list` of `str`
    List of filter names for the slice. This is a subset of the
    filters in the parent multiband object
filterIndex: `list` of `int` or `slice`
    Index along the filter dimension
indices: `tuple` of remaining indices
    `MultibandBase.__getitem__` separates the first (filter)
    index from the remaining indices, so `indices` is a tuple
    of all of the indices that come after `filter` in the
    `args` passed to `MultibandBase.__getitem__`.

Returns
-------
result: `object`
    Sliced version of the current object, which could be the
    same class or a different class depending on the
    slice being made.

Reimplemented from lsst.afw.multiband.MultibandBase.

Definition at line 124 of file _multiband.py.

◆ clone()

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.

Member Data Documentation

◆ _singles

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

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