lsst.meas.algorithms.stamps.Stamps Class Reference

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

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

Public Attributes
	use_mask
	use_variance
	use_archive

Detailed Description

Definition at line 410 of file stamps.py.

Member Function Documentation

__getitem__()

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

inherited

Definition at line 379 of file stamps.py.

    def __getitem__(self, index):
        return self._stamps[index]
 

__iter__()

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

inherited

Definition at line 382 of file stamps.py.

    def __iter__(self):
        return iter(self._stamps)
 

__len__()

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

inherited

Definition at line 376 of file stamps.py.

    def __len__(self):
        return len(self._stamps)
 

append()

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

Add an additional stamp.

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

Definition at line 419 of file stamps.py.

    def append(self, item):
        """Add an additional stamp.
 
        Parameters
        ----------
        item : `Stamp`
            Stamp object to append.
        """
        if not isinstance(item, Stamp):
            raise ValueError("Objects added must be a Stamp object.")
        self._stamps.append(item)
        return None
 

extend()

def 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 432 of file stamps.py.

    def extend(self, stamp_list):
        """Extend Stamps instance by appending elements from another instance.
 
        Parameters
        ----------
        stamps_list : `list` [`Stamp`]
            List of Stamp object to append.
        """
        for s in stamp_list:
            if not isinstance(s, Stamp):
                raise ValueError('Can only extend with Stamp objects')
        self._stamps += stamp_list
 

getArchiveElements()

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

inherited

Retrieve archive elements associated with each stamp.

Returns
-------
archiveElements :
    `list` [`lsst.afwTable.io.Persistable`]

Definition at line 395 of file stamps.py.

    def getArchiveElements(self):
        """Retrieve archive elements associated with each stamp.
 
        Returns
        -------
        archiveElements :
            `list` [`lsst.afwTable.io.Persistable`]
        """
        return [stamp.archive_element for stamp in self._stamps]
 

getMaskedImages()

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

inherited

Retrieve star images.

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

Definition at line 385 of file stamps.py.

    def getMaskedImages(self):
        """Retrieve star images.
 
        Returns
        -------
        maskedImages :
            `list` [`lsst.afw.image.maskedImage.maskedImage.MaskedImageF`]
        """
        return [stamp.stamp_im for stamp in self._stamps]
 

getPositions()

def lsst.meas.algorithms.stamps.Stamps.getPositions

(

self

)

Definition at line 416 of file stamps.py.

    def getPositions(self):
        return [s.position for s in self._stamps]
 

metadata()

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

inherited

Definition at line 406 of file stamps.py.

    def metadata(self):
        return self._metadata
 
 

readFits()

def 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 446 of file stamps.py.

    def 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
        """
        return cls.readFitsWithOptions(filename, None)
 

readFitsWithOptions()

def 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 462 of file stamps.py.

    def 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
        """
        stamps, metadata = readFitsWithOptions(filename, Stamp.factory, options)
        return cls(stamps, metadata=metadata, use_mask=metadata['HAS_MASK'],
                   use_variance=metadata['HAS_VARIANCE'], use_archive=metadata['HAS_ARCHIVE'])

writeFits()

def 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 363 of file stamps.py.

    def writeFits(self, filename):
        """Write this object to a file.
 
        Parameters
        ----------
        filename : `str`
            Name of file to write
        """
        self._refresh_metadata()
        type_name = get_full_type_name(self)
        writeFits(filename, self._stamps, self._metadata, type_name, self.use_mask, self.use_variance,
                  self.use_archive)
 

Member Data Documentation

use_archive

lsst.meas.algorithms.stamps.StampsBase.use_archive

inherited

Definition at line 310 of file stamps.py.

use_mask

lsst.meas.algorithms.stamps.StampsBase.use_mask

inherited

Definition at line 308 of file stamps.py.

use_variance

lsst.meas.algorithms.stamps.StampsBase.use_variance

inherited

Definition at line 309 of file stamps.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_algorithms/22.0.1-32-gf62ce7b1+aa4237961e/python/lsst/meas/algorithms/stamps.py