Inheritance diagram for lsst.meas.algorithms.stamps.StampsBase:
Public Member Functions | |
| __init__ (self, stamps, metadata=None, use_mask=True, use_variance=True, use_archive=False) | |
| readFits (cls, filename) | |
| readFitsWithOptions (cls, filename, options) | |
| writeFits (self, filename) | |
| __len__ (self) | |
| __getitem__ (self, index) | |
| __iter__ (self) | |
| getMaskedImages (self) | |
| getArchiveElements (self) | |
| metadata (self) | |
Public Attributes | |
| use_mask | |
| use_variance | |
| use_archive | |
Protected Member Functions | |
| _refresh_metadata (self) | |
Protected Attributes | |
| _stamps | |
| _metadata | |
Detailed Description
Collection of stamps and associated metadata.
Parameters
----------
stamps : iterable
This should be an iterable of dataclass objects
a la ``~lsst.meas.algorithms.Stamp``.
metadata : `~lsst.daf.base.PropertyList`, optional
Metadata associated with the objects within the stamps.
use_mask : `bool`, optional
If ``True`` read and write the mask data. Default ``True``.
use_variance : `bool`, optional
If ``True`` read and write the variance data. Default ``True``.
use_archive : `bool`, optional
If ``True``, read and write an Archive that contains a Persistable
associated with each stamp, for example a Transform or a WCS.
Default ``False``.
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}
)
Constructor & Destructor Documentation
◆ __init__()
| lsst.meas.algorithms.stamps.StampsBase.__init__ | ( | self, | |
| stamps, | |||
| metadata = None, | |||
| use_mask = True, | |||
| use_variance = True, | |||
| use_archive = False ) |
Reimplemented in lsst.meas.algorithms.brightStarStamps.BrightStarStamps.
Definition at line 342 of file stamps.py.
342 def __init__(self, stamps, metadata=None, use_mask=True, use_variance=True, use_archive=False):
343 for stamp in stamps:
344 if not isinstance(stamp, AbstractStamp):
345 raise ValueError(f"The entries in stamps must inherit from AbstractStamp. Got {type(stamp)}.")
346 self._stamps = stamps
347 self._metadata = PropertyList() if metadata is None else metadata.deepCopy()
348 self.use_mask = use_mask
349 self.use_variance = use_variance
350 self.use_archive = use_archive
351
Member Function Documentation
◆ __getitem__()
| lsst.meas.algorithms.stamps.StampsBase.__getitem__ | ( | self, | |
| index ) |
◆ __iter__()
| lsst.meas.algorithms.stamps.StampsBase.__iter__ | ( | self | ) |
◆ __len__()
| lsst.meas.algorithms.stamps.StampsBase.__len__ | ( | self | ) |
◆ _refresh_metadata()
|
protected |
Make sure metadata is up to date, as this object can be extended.
Reimplemented in lsst.meas.algorithms.brightStarStamps.BrightStarStamps, and lsst.meas.algorithms.stamps.Stamps.
Definition at line 399 of file stamps.py.
399 def _refresh_metadata(self):
400 """Make sure metadata is up to date, as this object can be extended."""
401 raise NotImplementedError
402
◆ getArchiveElements()
| lsst.meas.algorithms.stamps.StampsBase.getArchiveElements | ( | self | ) |
Retrieve archive elements associated with each stamp.
Returns
-------
archiveElements :
`list` [`~lsst.afw.table.io.Persistable`]
Definition at line 442 of file stamps.py.
442 def getArchiveElements(self):
443 """Retrieve archive elements associated with each stamp.
444
445 Returns
446 -------
447 archiveElements :
448 `list` [`~lsst.afw.table.io.Persistable`]
449 """
450 return [stamp.archive_element for stamp in self._stamps]
451
◆ getMaskedImages()
| lsst.meas.algorithms.stamps.StampsBase.getMaskedImages | ( | self | ) |
Retrieve star images.
Returns
-------
maskedImages :
`list` [`~lsst.afw.image.MaskedImageF`]
Definition at line 432 of file stamps.py.
432 def getMaskedImages(self):
433 """Retrieve star images.
434
435 Returns
436 -------
437 maskedImages :
438 `list` [`~lsst.afw.image.MaskedImageF`]
439 """
440 return [stamp.stamp_im for stamp in self._stamps]
441
◆ metadata()
| lsst.meas.algorithms.stamps.StampsBase.metadata | ( | self | ) |
◆ readFits()
| lsst.meas.algorithms.stamps.StampsBase.readFits | ( | cls, | |
| filename ) |
Build an instance of this class from a file.
Parameters
----------
filename : `str`
Name of the file to read
Reimplemented in lsst.meas.algorithms.brightStarStamps.BrightStarStamps, and lsst.meas.algorithms.stamps.Stamps.
Definition at line 353 of file stamps.py.
353 def readFits(cls, filename):
354 """Build an instance of this class from a file.
355
356 Parameters
357 ----------
358 filename : `str`
359 Name of the file to read
360 """
361
362 return cls.readFitsWithOptions(filename, None)
363
◆ readFitsWithOptions()
| lsst.meas.algorithms.stamps.StampsBase.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 in lsst.meas.algorithms.brightStarStamps.BrightStarStamps, and lsst.meas.algorithms.stamps.Stamps.
Definition at line 365 of file stamps.py.
365 def readFitsWithOptions(cls, filename, options):
366 """Build an instance of this class with options.
367
368 Parameters
369 ----------
370 filename : `str`
371 Name of the file to read
372 options : `PropertyList`
373 Collection of metadata parameters
374 """
375 # To avoid problems since this is no longer an abstract method.
376 # TO-DO: Consider refactoring this method. This class check was added
377 # to allow the butler formatter to use a generic type but still end up
378 # giving the correct type back, ensuring that the abstract base class
379 # is not used by mistake. Perhaps this logic can be optimised.
380 if cls is not StampsBase:
381 raise NotImplementedError(f"Please implement specific FITS reader for class {cls}")
382
383 # Load metadata to get class
384 metadata = readMetadata(filename, hdu=0)
385 type_name = metadata.get("STAMPCLS")
386 if type_name is None:
387 raise RuntimeError(
388 f"No class name in file {filename}. Unable to instantiate correct stamps subclass. "
389 "Is this an old version format Stamps file?"
390 )
391
392 # Import class and override `cls`
393 stamp_type = doImport(type_name)
394 cls = stamp_type
395
396 return cls.readFitsWithOptions(filename, options)
397
◆ writeFits()
| lsst.meas.algorithms.stamps.StampsBase.writeFits | ( | self, | |
| filename ) |
Write this object to a file.
Parameters
----------
filename : `str`
Name of file to write.
Definition at line 403 of file stamps.py.
403 def writeFits(self, filename):
404 """Write this object to a file.
405
406 Parameters
407 ----------
408 filename : `str`
409 Name of file to write.
410 """
411 self._refresh_metadata()
412 type_name = get_full_type_name(self)
413 writeFits(
414 filename,
415 self._stamps,
416 self._metadata,
417 type_name,
418 self.use_mask,
419 self.use_variance,
420 self.use_archive,
421 )
422
Member Data Documentation
◆ _metadata
|
protected |
◆ _stamps
◆ use_archive
◆ use_mask
◆ use_variance
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_algorithms/ge6526c86ff+d4c1d4bfef/python/lsst/meas/algorithms/stamps.py
