lsst.meas.algorithms.stamps.Stamps Class Reference

Inheritance diagram for lsst.meas.algorithms.stamps.Stamps:

Public Member Functions
	getPositions (self)
	append (self, item)
	extend (self, stamp_list)
	readFits (cls, filename)
	readFitsWithOptions (cls, filename, options)
	writeFits (self, filename)
	__len__ (self)
	__getitem__ (self, index)
	__iter__ (self)
	getMaskedImages (self)
	getArchiveElements (self)
	metadata (self)

Public Attributes
	use_mask = use_mask
	use_variance = use_variance
	use_archive = use_archive

Protected Member Functions
	_refresh_metadata (self)

Protected Attributes
	_stamps = stamps
	_metadata = PropertyList() if metadata is None else metadata.deepCopy()

Detailed Description

Definition at line 469 of file stamps.py.

Member Function Documentation

__getitem__()

lsst.meas.algorithms.stamps.StampsBase.__getitem__ ( self, index )

inherited

Definition at line 438 of file stamps.py.

__iter__()

lsst.meas.algorithms.stamps.StampsBase.__iter__ ( self )

inherited

Definition at line 441 of file stamps.py.

__len__()

lsst.meas.algorithms.stamps.StampsBase.__len__ ( self )

inherited

Definition at line 435 of file stamps.py.

_refresh_metadata()

lsst.meas.algorithms.stamps.Stamps._refresh_metadata ( self )

protected

Make sure metadata is up to date, as this object can be extended.

Reimplemented from lsst.meas.algorithms.stamps.StampsBase.

Reimplemented in lsst.meas.algorithms.brightStarStamps.BrightStarStamps.

Definition at line 470 of file stamps.py.

append()

lsst.meas.algorithms.stamps.Stamps.append	(		self,
			item )

Add an additional stamp.

Parameters
----------
item : `Stamp`
    Stamp object to append.

Reimplemented in lsst.meas.algorithms.brightStarStamps.BrightStarStamps.

Definition at line 478 of file stamps.py.

extend()

lsst.meas.algorithms.stamps.Stamps.extend	(		self,
			stamp_list )

Extend Stamps instance by appending elements from another instance.

Parameters
----------
stamps_list : `list` [`Stamp`]
    List of Stamp object to append.

Reimplemented in lsst.meas.algorithms.brightStarStamps.BrightStarStamps.

Definition at line 491 of file stamps.py.

getArchiveElements()

lsst.meas.algorithms.stamps.StampsBase.getArchiveElements ( self )

inherited

Retrieve archive elements associated with each stamp.

Returns
-------
archiveElements :
    `list` [`~lsst.afw.table.io.Persistable`]

Definition at line 454 of file stamps.py.

getMaskedImages()

lsst.meas.algorithms.stamps.StampsBase.getMaskedImages ( self )

inherited

Retrieve star images.

Returns
-------
maskedImages :
    `list` [`~lsst.afw.image.MaskedImageF`]

Definition at line 444 of file stamps.py.

getPositions()

lsst.meas.algorithms.stamps.Stamps.getPositions

(

self

)

Definition at line 475 of file stamps.py.

metadata()

lsst.meas.algorithms.stamps.StampsBase.metadata ( self )

inherited

Definition at line 465 of file stamps.py.

readFits()

lsst.meas.algorithms.stamps.Stamps.readFits	(		cls,
			filename )

Build an instance of this class from a file.

Parameters
----------
filename : `str`
    Name of the file to read.

Returns
-------
object : `Stamps`
    An instance of this class.

Reimplemented from lsst.meas.algorithms.stamps.StampsBase.

Reimplemented in lsst.meas.algorithms.brightStarStamps.BrightStarStamps.

Definition at line 505 of file stamps.py.

readFitsWithOptions()

lsst.meas.algorithms.stamps.Stamps.readFitsWithOptions	(		cls,
			filename,
			options )

Build an instance of this class with options.

Parameters
----------
filename : `str`
    Name of the file to read.
options : `PropertyList` or `dict`
    Collection of metadata parameters.

Returns
-------
object : `Stamps`
    An instance of this class.

Reimplemented from lsst.meas.algorithms.stamps.StampsBase.

Reimplemented in lsst.meas.algorithms.brightStarStamps.BrightStarStamps.

Definition at line 521 of file stamps.py.

writeFits()

lsst.meas.algorithms.stamps.StampsBase.writeFits ( self, filename )

inherited

Write this object to a file.

Parameters
----------
filename : `str`
    Name of file to write.

Definition at line 415 of file stamps.py.

Member Data Documentation

_metadata

lsst.meas.algorithms.stamps.StampsBase._metadata = PropertyList() if metadata is None else metadata.deepCopy()

protectedinherited

Definition at line 359 of file stamps.py.

_stamps

lsst.meas.algorithms.stamps.StampsBase._stamps = stamps

protectedinherited

Definition at line 358 of file stamps.py.

use_archive

lsst.meas.algorithms.stamps.StampsBase.use_archive = use_archive

inherited

Definition at line 362 of file stamps.py.

use_mask

lsst.meas.algorithms.stamps.StampsBase.use_mask = use_mask

inherited

Definition at line 360 of file stamps.py.

use_variance

lsst.meas.algorithms.stamps.StampsBase.use_variance = use_variance

inherited

Definition at line 361 of file stamps.py.

---

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

• python/lsst/meas/algorithms/stamps.py