LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
|
Public Member Functions | |
__init__ (self, starStamps, innerRadius=None, outerRadius=None, nb90Rots=None, metadata=None, use_mask=True, use_variance=False, use_archive=False) | |
initAndNormalize (cls, starStamps, innerRadius, outerRadius, nb90Rots=None, metadata=None, use_mask=True, use_variance=False, use_archive=False, imCenter=None, discardNanFluxObjects=True, forceFindFlux=False, statsControl=StatisticsControl(), statsFlag=stringToStatisticsProperty("MEAN"), badMaskPlanes=("BAD", "SAT", "NO_DATA")) | |
readFits (cls, filename) | |
readFitsWithOptions (cls, filename, options) | |
append (self, item, innerRadius=None, outerRadius=None) | |
extend (self, bss) | |
getMagnitudes (self) | |
getGaiaIds (self) | |
getAnnularFluxes (self) | |
getValidPixelsFraction (self) | |
selectByMag (self, magMin=None, magMax=None) | |
Public Attributes | |
normalized | |
nb90Rots | |
Protected Member Functions | |
_refresh_metadata (self) | |
_checkRadius (self, innerRadius, outerRadius) | |
_checkNormalization (self, normalize, innerRadius, outerRadius) | |
Protected Attributes | |
_innerRadius | |
_outerRadius | |
Collection of bright star stamps and associated metadata. Parameters ---------- starStamps : `collections.abc.Sequence` [`BrightStarStamp`] Sequence of star stamps. Cannot contain both normalized and unnormalized 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 ``normalize`` is True. 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 ``normalize`` is True. nb90Rots : `int`, optional Number of 90 degree rotations required to compensate for detector orientation. 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``. use_archive : `bool` If ``True`` read and write an Archive that contains a Persistable associated with each stamp. In the case of bright stars, this is usually a ``TransformPoint2ToPoint2``, used to warp each stamp to the same pixel grid before stacking. Raises ------ ValueError Raised if one of the star stamps provided does not contain the required keys. AttributeError Raised if there is a mix-and-match of normalized and unnormalized stamps, stamps normalized with different annulus definitions, or if stamps are to be normalized but annular radii were not provided. Notes ----- A butler can be used to read only a part of the stamps, specified by a bbox: >>> starSubregions = butler.get( "brightStarStamps", dataId, parameters={"bbox": bbox} )
Definition at line 186 of file brightStarStamps.py.
lsst.meas.algorithms.brightStarStamps.BrightStarStamps.__init__ | ( | self, | |
starStamps, | |||
innerRadius = None, | |||
outerRadius = None, | |||
nb90Rots = None, | |||
metadata = None, | |||
use_mask = True, | |||
use_variance = False, | |||
use_archive = False ) |
Reimplemented from lsst.meas.algorithms.stamps.StampsBase.
Definition at line 239 of file brightStarStamps.py.
|
protected |
Ensure there is no mixing of normalized and unnormalized stars, and that, if requested, normalization can be performed.
Definition at line 641 of file brightStarStamps.py.
|
protected |
Ensure provided annulus radius is consistent with that already present in the instance, or with arguments passed on at initialization.
Definition at line 630 of file brightStarStamps.py.
|
protected |
Refresh metadata. Should be called before writing the object out. This method adds full lists of positions, Gaia magnitudes, IDs and annular fluxes to the shared metadata.
Reimplemented from lsst.meas.algorithms.stamps.Stamps.
Definition at line 452 of file brightStarStamps.py.
lsst.meas.algorithms.brightStarStamps.BrightStarStamps.append | ( | self, | |
item, | |||
innerRadius = None, | |||
outerRadius = None ) |
Add an additional bright star stamp. Parameters ---------- item : `BrightStarStamp` Bright star stamp to append. innerRadius : `int`, optional Inner radius value, in pixels. This and ``outerRadius`` define the annulus used to compute the ``"annularFlux"`` values within each ``BrightStarStamp``. outerRadius : `int`, optional Outer radius value, in pixels. This and ``innerRadius`` define the annulus used to compute the ``"annularFlux"`` values within each ``BrightStarStamp``.
Reimplemented from lsst.meas.algorithms.stamps.Stamps.
Definition at line 517 of file brightStarStamps.py.
lsst.meas.algorithms.brightStarStamps.BrightStarStamps.extend | ( | self, | |
bss ) |
Extend BrightStarStamps instance by appending elements from another instance. Parameters ---------- bss : `BrightStarStamps` Other instance to concatenate.
Reimplemented from lsst.meas.algorithms.stamps.Stamps.
Definition at line 545 of file brightStarStamps.py.
lsst.meas.algorithms.brightStarStamps.BrightStarStamps.getAnnularFluxes | ( | self | ) |
Retrieve normalization factor 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`] Annular fluxes which give the normalization factor for each star.
Definition at line 579 of file brightStarStamps.py.
lsst.meas.algorithms.brightStarStamps.BrightStarStamps.getGaiaIds | ( | self | ) |
Retrieve Gaia IDs for each star. Returns ------- gaiaIds : `list` [`int`] Gaia IDs for each star.
Definition at line 569 of file brightStarStamps.py.
lsst.meas.algorithms.brightStarStamps.BrightStarStamps.getMagnitudes | ( | self | ) |
Retrieve Gaia G-band magnitudes for each star. Returns ------- gaiaGMags : `list` [`float`] Gaia G-band magnitudes for each star.
Definition at line 559 of file brightStarStamps.py.
lsst.meas.algorithms.brightStarStamps.BrightStarStamps.getValidPixelsFraction | ( | self | ) |
Retrieve the fraction of valid pixels within the normalization annulus for each star. Returns ------- validPixelsFractions : `list` [`float`] Fractions of valid pixels within the normalization annulus for each star.
Definition at line 595 of file brightStarStamps.py.
lsst.meas.algorithms.brightStarStamps.BrightStarStamps.initAndNormalize | ( | cls, | |
starStamps, | |||
innerRadius, | |||
outerRadius, | |||
nb90Rots = None, | |||
metadata = None, | |||
use_mask = True, | |||
use_variance = False, | |||
use_archive = False, | |||
imCenter = None, | |||
discardNanFluxObjects = True, | |||
forceFindFlux = False, | |||
statsControl = StatisticsControl(), | |||
statsFlag = stringToStatisticsProperty("MEAN"), | |||
badMaskPlanes = ("BAD", "SAT", "NO_DATA") ) |
Normalize a set of bright star stamps and initialize a BrightStarStamps instance. 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 ---------- starStamps : `collections.abc.Sequence` [`BrightStarStamp`] Sequence of star stamps. Cannot contain both normalized and unnormalized stamps. innerRadius : `int` Inner radius value, in pixels. This and ``outerRadius`` define the annulus used to compute the ``"annularFlux"`` values within each ``starStamp``. outerRadius : `int` Outer radius value, in pixels. This and ``innerRadius`` define the annulus used to compute the ``"annularFlux"`` values within each ``starStamp``. nb90Rots : `int`, optional Number of 90 degree rotations required to compensate for detector orientation. 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``. use_archive : `bool` If ``True`` read and write an Archive that contains a Persistable associated with each stamp. In the case of bright stars, this is usually a ``TransformPoint2ToPoint2``, used to warp each stamp to the same pixel grid before stacking. imCenter : `collections.abc.Sequence`, optional Center of the object, in pixels. If not provided, the center of the first stamp's pixel grid will be used. discardNanFluxObjects : `bool` Whether objects with NaN annular flux should be discarded. If False, these objects will not be normalized. forceFindFlux : `bool` Whether to try to find the flux of objects with NaN annular flux at a different annulus. 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 ``~lsst.afw.math.makeStatistics`` to compute annularFlux. Defaults to a simple MEAN. badMaskPlanes : `collections.abc.Collection` [`str`] Collection of mask planes to ignore when computing annularFlux. Raises ------ ValueError Raised if one of the star stamps provided does not contain the required keys. AttributeError Raised if there is a mix-and-match of normalized and unnormalized stamps, stamps normalized with different annulus definitions, or if stamps are to be normalized but annular radii were not provided.
Definition at line 261 of file brightStarStamps.py.
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.Stamps.
Definition at line 473 of file brightStarStamps.py.
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.Stamps.
Definition at line 484 of file brightStarStamps.py.
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 607 of file brightStarStamps.py.
|
protected |
Definition at line 253 of file brightStarStamps.py.
|
protected |
Definition at line 253 of file brightStarStamps.py.
lsst.meas.algorithms.brightStarStamps.BrightStarStamps.nb90Rots |
Definition at line 258 of file brightStarStamps.py.
lsst.meas.algorithms.brightStarStamps.BrightStarStamps.normalized |
Definition at line 255 of file brightStarStamps.py.