lsst.meas.algorithms  22.0.1-18-g3db9cf4b+f395498f22
Public Member Functions | Public Attributes | List of all members
lsst.meas.algorithms.stamps.Stamps Class Reference
Inheritance diagram for lsst.meas.algorithms.stamps.Stamps:
lsst.meas.algorithms.stamps.StampsBase lsst.meas.algorithms.brightStarStamps.BrightStarStamps

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.

◆ __iter__()

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

Definition at line 382 of file stamps.py.

◆ __len__()

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

Definition at line 376 of file stamps.py.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ getPositions()

def lsst.meas.algorithms.stamps.Stamps.getPositions (   self)

Definition at line 416 of file stamps.py.

◆ metadata()

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

Definition at line 406 of file stamps.py.

◆ 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.

◆ 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.

◆ 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.

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: