lsst.afw.math._backgroundList.BackgroundList Class Reference

Public Member Functions
	__init__ (self, *args)
	__getitem__ (self, *args)
	__len__ (self, *args)
	append (self, val)
	clone (self)
	writeFits (self, fileName, flags=0)
	getImage (self)
	__reduce__ (self)

Static Public Member Functions
	readFits (fileName, hdu=0, flags=0)

Protected Attributes
list	_backgrounds = []

Detailed Description

A list-like class to contain a list of (`lsst.afw.math.Background`,
`lsst.afw.math.Interpolate.Style`, `~lsst.afw.math.UndersampleStyle`)
tuples.

Parameters
----------
*args : `tuple` or `~lsst.afw.math.Background`
    A sequence of arguments, each of which becomes an element of the list.
    We also accept a single `lsst.afw.math.Background` and extract the
    ``interpStyle`` and ``undersampleStyle`` from the as-used values.

Definition at line 32 of file _backgroundList.py.

Constructor & Destructor Documentation

__init__()

lsst.afw.math._backgroundList.BackgroundList.__init__	(		self,
		*	args )

Definition at line 45 of file _backgroundList.py.

Member Function Documentation

__getitem__()

lsst.afw.math._backgroundList.BackgroundList.__getitem__	(		self,
		*	args )

Return an item

Parameters
----------
*args
    Any valid list index.

Definition at line 50 of file _backgroundList.py.

__len__()

lsst.afw.math._backgroundList.BackgroundList.__len__	(		self,
		*	args )

Definition at line 79 of file _backgroundList.py.

__reduce__()

lsst.afw.math._backgroundList.BackgroundList.__reduce__

(

self

)

Definition at line 234 of file _backgroundList.py.

append()

lsst.afw.math._backgroundList.BackgroundList.append	(		self,
			val )

Definition at line 82 of file _backgroundList.py.

clone()

lsst.afw.math._backgroundList.BackgroundList.clone

(

self

)

Return a shallow copy

Shallow copies do not share backgrounds that are appended after copying,
but do share changes to contained background objects.

Definition at line 99 of file _backgroundList.py.

getImage()

lsst.afw.math._backgroundList.BackgroundList.getImage

(

self

)

Compute and return a full-resolution image from our list of
(Background, interpStyle, undersampleStyle).

Definition at line 213 of file _backgroundList.py.

readFits()

lsst.afw.math._backgroundList.BackgroundList.readFits ( fileName, hdu = 0, flags = 0 )

static

Read our list of Backgrounds from a file.

Parameters
----------
fileName : `str`
    FITS file to read
hdu : `int`
    First Header/Data Unit to attempt to read from
flags : `int`
    Flags to control details of reading; currently unused, but present
    for consistency with `lsst.afw.table.BaseCatalog.readFits`.

See Also
--------
getImage

Definition at line 143 of file _backgroundList.py.

writeFits()

lsst.afw.math._backgroundList.BackgroundList.writeFits	(		self,
			fileName,
			flags = 0 )

Save our list of Backgrounds to a file.

Parameters
-----------
fileName : `str`
    FITS file to write
flags : `int`
    Flags to control details of writing; currently unused, but present
    for consistency with `lsst.afw.table.BaseCatalog.writeFits`.

Definition at line 107 of file _backgroundList.py.

Member Data Documentation

_backgrounds

lsst.afw.math._backgroundList.BackgroundList._backgrounds = []

protected

Definition at line 46 of file _backgroundList.py.

---

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

• python/lsst/afw/math/_backgroundList.py