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)

Protected Member Functions
	_refresh_metadata (self)

Detailed Description

Definition at line 457 of file stamps.py.

Member Function Documentation

_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 458 of file stamps.py.

    def _refresh_metadata(self):
        positions = self.getPositions()
        self._metadata["RA_DEG"] = [p.getRa().asDegrees() for p in positions]
        self._metadata["DEC_DEG"] = [p.getDec().asDegrees() for p in positions]
 

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

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 479 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
 

getPositions()

lsst.meas.algorithms.stamps.Stamps.getPositions

(

self

)

Definition at line 463 of file stamps.py.

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

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

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 509 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"],
        )

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_algorithms/ge6526c86ff+508d0e0a30/python/lsst/meas/algorithms/stamps.py