|
| | __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) |
| |
| | getPositions (self) |
| |
| | writeFits (self, filename) |
| |
| | __len__ (self) |
| |
| | __getitem__ (self, index) |
| |
| | __iter__ (self) |
| |
| | getMaskedImages (self) |
| |
| | getArchiveElements (self) |
| |
| | metadata (self) |
| |
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.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.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.
1.13.2