lsst.meas.algorithms  21.0.0-8-g19111d86+898b2b281f
Public Member Functions | Public Attributes | List of all members
lsst.meas.algorithms.brightStarStamps.BrightStarStamps Class Reference
Inheritance diagram for lsst.meas.algorithms.brightStarStamps.BrightStarStamps:
lsst.meas.algorithms.stamps.StampsBase

Public Member Functions

def __init__ (self, starStamps, innerRadius=None, outerRadius=None, metadata=None, use_mask=True, use_variance=False)
 
def readFits (cls, filename)
 
def readFitsWithOptions (cls, filename, options)
 
def append (self, item, innerRadius, outerRadius)
 
def extend (self, bss)
 
def getMagnitudes (self)
 
def getGaiaIds (self)
 
def getAnnularFluxes (self)
 
def selectByMag (self, magMin=None, magMax=None)
 
def writeFits (self, filename)
 
def __len__ (self)
 
def __getitem__ (self, index)
 
def __iter__ (self)
 
def getMaskedImages (self)
 
def metadata (self)
 

Public Attributes

 use_mask
 
 use_variance
 

Detailed Description

Collection of bright star stamps and associated metadata.

Parameters
----------
starStamps : `collections.abc.Sequence` [`BrightStarStamp`]
    Sequence of star stamps.
innerRadius : `int`, optional
    Inner radius value, in pixels. This and ``outerRadius`` define the
    annulus used to compute the ``"annularFlux"`` values within each
    ``starStamp``. Must be provided if ``"INNER_RADIUS"`` and
    ``"OUTER_RADIUS"`` are not present in ``metadata``.
outerRadius : `int`, optional
    Outer radius value, in pixels. This and ``innerRadius`` define the
    annulus used to compute the ``"annularFlux"`` values within each
    ``starStamp``. Must be provided if ``"INNER_RADIUS"`` and
    ``"OUTER_RADIUS"`` are not present in ``metadata``.
metadata : `lsst.daf.base.PropertyList`, optional
    Metadata associated with the bright stars.
use_mask : `bool`
    If `True` read and write mask data. Default `True`.
use_variance : `bool`
    If ``True`` read and write variance data. Default ``False``.

Raises
------
ValueError
    Raised if one of the star stamps provided does not contain the
    required keys.
AttributeError
    Raised if the definition of the annulus used to compute each star's
    normalization factor are not provided, that is, if ``"INNER_RADIUS"``
    and ``"OUTER_RADIUS"`` are not present in ``metadata`` _and_
    ``innerRadius`` and ``outerRadius`` are not provided.

Notes
-----
A (gen2) butler can be used to read only a part of the stamps,
specified by a bbox:

>>> starSubregions = butler.get("brightStarStamps_sub", dataId, bbox=bbox)

Definition at line 94 of file brightStarStamps.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.algorithms.brightStarStamps.BrightStarStamps.__init__ (   self,
  starStamps,
  innerRadius = None,
  outerRadius = None,
  metadata = None,
  use_mask = True,
  use_variance = False 
)

Definition at line 137 of file brightStarStamps.py.

Member Function Documentation

◆ __getitem__()

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

Definition at line 312 of file stamps.py.

◆ __iter__()

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

Definition at line 315 of file stamps.py.

◆ __len__()

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

Definition at line 309 of file stamps.py.

◆ append()

def lsst.meas.algorithms.brightStarStamps.BrightStarStamps.append (   self,
  item,
  innerRadius,
  outerRadius 
)
Add an additional bright star stamp.

Parameters
----------
item : `BrightStarStamp`
    Bright star stamp to append.
innerRadius : `int`
    Inner radius value, in pixels. This and ``outerRadius`` define the
    annulus used to compute the ``"annularFlux"`` values within each
    ``starStamp``.
outerRadius : `int`, optional
    Outer radius value, in pixels. This and ``innerRadius`` define the
    annulus used to compute the ``"annularFlux"`` values within each
    ``starStamp``.

Definition at line 182 of file brightStarStamps.py.

◆ extend()

def lsst.meas.algorithms.brightStarStamps.BrightStarStamps.extend (   self,
  bss 
)
Extend BrightStarStamps instance by appending elements from another
instance.

Parameters
----------
bss : `BrightStarStamps`
    Other instance to concatenate.

Definition at line 205 of file brightStarStamps.py.

◆ getAnnularFluxes()

def lsst.meas.algorithms.brightStarStamps.BrightStarStamps.getAnnularFluxes (   self)
Retrieve normalization factors for each star.

These are computed by integrating the flux in annulus centered on the
bright star, far enough from center to be beyond most severe ghosts and
saturation. The inner and outer radii that define the annulus can be
recovered from the metadata.

Returns
-------
annularFluxes : `list` [`float`]

Definition at line 239 of file brightStarStamps.py.

◆ getGaiaIds()

def lsst.meas.algorithms.brightStarStamps.BrightStarStamps.getGaiaIds (   self)
Retrieve Gaia IDs for each star.

Returns
-------
gaiaIds : `list` [`int`]

Definition at line 230 of file brightStarStamps.py.

◆ getMagnitudes()

def lsst.meas.algorithms.brightStarStamps.BrightStarStamps.getMagnitudes (   self)
Retrieve Gaia G magnitudes for each star.

Returns
-------
gaiaGMags : `list` [`float`]

Definition at line 221 of file brightStarStamps.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 318 of file stamps.py.

◆ metadata()

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

Definition at line 329 of file stamps.py.

◆ readFits()

def lsst.meas.algorithms.brightStarStamps.BrightStarStamps.readFits (   cls,
  filename 
)
Build an instance of this class from a file.

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

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

Definition at line 157 of file brightStarStamps.py.

◆ readFitsWithOptions()

def lsst.meas.algorithms.brightStarStamps.BrightStarStamps.readFitsWithOptions (   cls,
  filename,
  options 
)
Build an instance of this class with options.

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

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

Definition at line 168 of file brightStarStamps.py.

◆ selectByMag()

def lsst.meas.algorithms.brightStarStamps.BrightStarStamps.selectByMag (   self,
  magMin = None,
  magMax = None 
)
Return the subset of bright star stamps for objects with specified
magnitude cuts (in Gaia G).

Parameters
----------
magMin : `float`, optional
    Keep only stars fainter than this value.
magMax : `float`, optional
    Keep only stars brighter than this value.

Definition at line 253 of file brightStarStamps.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 297 of file stamps.py.

Member Data Documentation

◆ use_mask

lsst.meas.algorithms.stamps.StampsBase.use_mask
inherited

Definition at line 261 of file stamps.py.

◆ use_variance

lsst.meas.algorithms.stamps.StampsBase.use_variance
inherited

Definition at line 262 of file stamps.py.


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