lsst.meas.algorithms g6770999e7e+e8406c078b
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.algorithms.brightStarStamps.BrightStarStamp Class Reference
Inheritance diagram for lsst.meas.algorithms.brightStarStamps.BrightStarStamp:
lsst.meas.algorithms.stamps.AbstractStamp

Public Member Functions

 factory (cls, stamp_im, metadata, idx, archive_element=None, minValidAnnulusFraction=0.0)
 
 measureAndNormalize (self, SpanSet annulus, StatisticsControl statsControl=StatisticsControl(), Property statsFlag=stringToStatisticsProperty("MEAN"), Collection[str] badMaskPlanes=("BAD", "SAT", "NO_DATA"))
 

Public Attributes

 stamp_im
 
 minValidAnnulusFraction
 
 annularFlux
 

Static Public Attributes

MaskedImageF stamp_im
 
float gaiaGMag
 
int gaiaId
 
Point2I position
 
Persistable archive_element = None
 
float annularFlux = None
 
float minValidAnnulusFraction = 0.0
 
int optimalInnerRadius = None
 
int optimalOuterRadius = None
 

Detailed Description

Single stamp centered on a bright star, normalized by its annularFlux.

Parameters
----------
stamp_im : `~lsst.afw.image.MaskedImage`
    Pixel data for this postage stamp
gaiaGMag : `float`
    Gaia G magnitude for the object in this stamp
gaiaId : `int`
    Gaia object identifier
position : `~lsst.geom.Point2I`
    Origin of the stamps in its origin exposure (pixels)
archive_element : `~lsst.afw.table.io.Persistable` or None, optional
    Archive element (e.g. Transform or WCS) associated with this stamp.
annularFlux : `float` or None, optional
    Flux in an annulus around the object

Definition at line 45 of file brightStarStamps.py.

Member Function Documentation

◆ factory()

lsst.meas.algorithms.brightStarStamps.BrightStarStamp.factory ( cls,
stamp_im,
metadata,
idx,
archive_element = None,
minValidAnnulusFraction = 0.0 )
This method is needed to service the FITS reader. We need a standard
interface to construct objects like this. Parameters needed to
construct this object are passed in via a metadata dictionary and then
passed to the constructor of this class.  This particular factory
method requires keys: G_MAGS, GAIA_IDS, and ANNULAR_FLUXES. They should
each point to lists of values.

Parameters
----------
stamp_im : `~lsst.afw.image.MaskedImage`
    Pixel data to pass to the constructor
metadata : `dict`
    Dictionary containing the information
    needed by the constructor.
idx : `int`
    Index into the lists in ``metadata``
archive_element : `~lsst.afw.table.io.Persistable` or None, optional
    Archive element (e.g. Transform or WCS) associated with this stamp.
minValidAnnulusFraction : `float`, optional
    The fraction of valid pixels within the normalization annulus of a
    star.

Returns
-------
brightstarstamp : `BrightStarStamp`
    An instance of this class

Reimplemented from lsst.meas.algorithms.stamps.AbstractStamp.

Definition at line 75 of file brightStarStamps.py.

◆ measureAndNormalize()

lsst.meas.algorithms.brightStarStamps.BrightStarStamp.measureAndNormalize ( self,
SpanSet annulus,
StatisticsControl statsControl = StatisticsControl(),
Property statsFlag = stringToStatisticsProperty("MEAN"),
Collection[str] badMaskPlanes = ("BAD", "SAT", "NO_DATA") )
Compute "annularFlux", the integrated flux within an annulus
around an object's center, and normalize it.

Since the center of bright stars are saturated and/or heavily affected
by ghosts, we measure their flux in an annulus with a large enough
inner radius to avoid the most severe ghosts and contain enough
non-saturated pixels.

Parameters
----------
annulus : `~lsst.afw.geom.spanSet.SpanSet`
    SpanSet containing the annulus to use for normalization.
statsControl : `~lsst.afw.math.statistics.StatisticsControl`, optional
    StatisticsControl to be used when computing flux over all pixels
    within the annulus.
statsFlag : `~lsst.afw.math.statistics.Property`, optional
    statsFlag to be passed on to ``afwMath.makeStatistics`` to compute
    annularFlux. Defaults to a simple MEAN.
badMaskPlanes : `collections.abc.Collection` [`str`]
    Collection of mask planes to ignore when computing annularFlux.

Definition at line 119 of file brightStarStamps.py.

Member Data Documentation

◆ annularFlux [1/2]

float lsst.meas.algorithms.brightStarStamps.BrightStarStamp.annularFlux = None
static

Definition at line 69 of file brightStarStamps.py.

◆ annularFlux [2/2]

lsst.meas.algorithms.brightStarStamps.BrightStarStamp.annularFlux

Definition at line 168 of file brightStarStamps.py.

◆ archive_element

Persistable lsst.meas.algorithms.brightStarStamps.BrightStarStamp.archive_element = None
static

Definition at line 68 of file brightStarStamps.py.

◆ gaiaGMag

float lsst.meas.algorithms.brightStarStamps.BrightStarStamp.gaiaGMag
static

Definition at line 65 of file brightStarStamps.py.

◆ gaiaId

int lsst.meas.algorithms.brightStarStamps.BrightStarStamp.gaiaId
static

Definition at line 66 of file brightStarStamps.py.

◆ minValidAnnulusFraction [1/2]

float lsst.meas.algorithms.brightStarStamps.BrightStarStamp.minValidAnnulusFraction = 0.0
static

Definition at line 70 of file brightStarStamps.py.

◆ minValidAnnulusFraction [2/2]

lsst.meas.algorithms.brightStarStamps.BrightStarStamp.minValidAnnulusFraction

Definition at line 166 of file brightStarStamps.py.

◆ optimalInnerRadius

int lsst.meas.algorithms.brightStarStamps.BrightStarStamp.optimalInnerRadius = None
static

Definition at line 71 of file brightStarStamps.py.

◆ optimalOuterRadius

int lsst.meas.algorithms.brightStarStamps.BrightStarStamp.optimalOuterRadius = None
static

Definition at line 72 of file brightStarStamps.py.

◆ position

Point2I lsst.meas.algorithms.brightStarStamps.BrightStarStamp.position
static

Definition at line 67 of file brightStarStamps.py.

◆ stamp_im [1/2]

MaskedImageF lsst.meas.algorithms.brightStarStamps.BrightStarStamp.stamp_im
static

Definition at line 64 of file brightStarStamps.py.

◆ stamp_im [2/2]

lsst.meas.algorithms.brightStarStamps.BrightStarStamp.stamp_im

Definition at line 153 of file brightStarStamps.py.


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