LSSTApplications  18.0.0+106,18.0.0+50,19.0.0,19.0.0+1,19.0.0+10,19.0.0+11,19.0.0+13,19.0.0+17,19.0.0+2,19.0.0-1-g20d9b18+6,19.0.0-1-g425ff20,19.0.0-1-g5549ca4,19.0.0-1-g580fafe+6,19.0.0-1-g6fe20d0+1,19.0.0-1-g7011481+9,19.0.0-1-g8c57eb9+6,19.0.0-1-gb5175dc+11,19.0.0-1-gdc0e4a7+9,19.0.0-1-ge272bc4+6,19.0.0-1-ge3aa853,19.0.0-10-g448f008b,19.0.0-12-g6990b2c,19.0.0-2-g0d9f9cd+11,19.0.0-2-g3d9e4fb2+11,19.0.0-2-g5037de4,19.0.0-2-gb96a1c4+3,19.0.0-2-gd955cfd+15,19.0.0-3-g2d13df8,19.0.0-3-g6f3c7dc,19.0.0-4-g725f80e+11,19.0.0-4-ga671dab3b+1,19.0.0-4-gad373c5+3,19.0.0-5-ga2acb9c+2,19.0.0-5-gfe96e6c+2,w.2020.01
LSSTDataManagementBasePackage
Classes | Public Member Functions | List of all members
lsst::afw::image::ExposureFitsReader Class Reference

A FITS reader class for Exposures and their components. More...

#include <ExposureFitsReader.h>

Classes

class  ArchiveReader
 
class  MetadataReader
 

Public Member Functions

 ExposureFitsReader (std::string const &fileName)
 Construct a FITS reader object. More...
 
 ExposureFitsReader (fits::MemFileManager &manager)
 Construct a FITS reader object. More...
 
 ExposureFitsReader (fits::Fits *fitsFile)
 Construct a FITS reader object. More...
 
 ExposureFitsReader (ExposureFitsReader const &)=delete
 
 ExposureFitsReader (ExposureFitsReader &&)=delete
 
ExposureFitsReaderoperator= (ExposureFitsReader const &)=delete
 
ExposureFitsReaderoperator= (ExposureFitsReader &&)=delete
 
 ~ExposureFitsReader () noexcept
 
lsst::geom::Box2I readBBox (ImageOrigin origin=PARENT)
 Read the bounding box of the on-disk image. More...
 
lsst::geom::Point2I readXY0 (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT)
 Read the image origin from the on-disk image or a subimage thereof. More...
 
std::shared_ptr< daf::base::PropertyListreadMetadata ()
 Read the flexible metadata associated with the Exposure. More...
 
std::shared_ptr< afw::geom::SkyWcsreadWcs ()
 Read the Exposure's world coordinate system. More...
 
Filter readFilter ()
 Read the Exposure's filter. More...
 
std::shared_ptr< PhotoCalibreadPhotoCalib ()
 Read the Exposure's photometric calibration. More...
 
std::shared_ptr< detection::PsfreadPsf ()
 Read the Exposure's point-spread function. More...
 
std::shared_ptr< afw::geom::polygon::PolygonreadValidPolygon ()
 Read the polygon describing the region of validity for the Exposure. More...
 
std::shared_ptr< ApCorrMapreadApCorrMap ()
 Read the Exposure's aperture correction map. More...
 
std::shared_ptr< CoaddInputsreadCoaddInputs ()
 Read the Exposure's coadd input catalogs. More...
 
std::shared_ptr< VisitInforeadVisitInfo ()
 Read the Exposure's visit metadata. More...
 
std::shared_ptr< TransmissionCurvereadTransmissionCurve ()
 Read the Exposure's transmission curve. More...
 
std::shared_ptr< cameraGeom::DetectorreadDetector ()
 Read the Exposure's detector. More...
 
std::map< std::string, std::shared_ptr< table::io::Persistable > > readExtraComponents ()
 Read the Exposure's non-standard components. More...
 
std::shared_ptr< ExposureInforeadExposureInfo ()
 Read the ExposureInfo containing all non-image components. More...
 
template<typename MaskPixelT >
Mask< MaskPixelT > readMask (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool allowUnsafe=false)
 Read the mask plane. More...
 
template<typename MaskPixelT >
ndarray::Array< MaskPixelT, 2, 2 > readMaskArray (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
 Read the mask plane. More...
 
template<typename ImagePixelT , typename MaskPixelT = MaskPixel, typename VariancePixelT = VariancePixel>
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > readMaskedImage (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool allowUnsafe=false)
 Read the MaskedImage. More...
 
template<typename ImagePixelT , typename MaskPixelT = MaskPixel, typename VariancePixelT = VariancePixel>
Exposure< ImagePixelT, MaskPixelT, VariancePixelT > read (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool allowUnsafe=false)
 Read the full Exposure. More...
 
std::string getFileName () const
 Return the name of the file this reader targets. More...
 
std::string readImageDType () const
 Read a string describing the pixel type of the on-disk image plane. More...
 
std::string readMaskDType () const
 Read a string describing the pixel type of the on-disk image plane. More...
 
std::string readVarianceDType () const
 Read a string describing the pixel type of the on-disk image plane. More...
 
template<typename ImagePixelT >
Image< ImagePixelT > readImage (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
 Read the image plane. More...
 
template<typename ImagePixelT >
ndarray::Array< ImagePixelT, 2, 2 > readImageArray (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
 Read the image plane. More...
 
template<typename VariancePixelT >
Image< VariancePixelT > readVariance (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
 Read the variance plane. More...
 
template<typename VariancePixelT >
ndarray::Array< VariancePixelT, 2, 2 > readVarianceArray (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
 Read the variance plane. More...
 

Detailed Description

A FITS reader class for Exposures and their components.

Exception Safety
All ExposureFitsReader methods provide strong exception safety, but exceptions thrown by the internal fits::Fits object itself may change its status variable or HDU pointer; ExposureFitsReader guards against this by resetting those before any use of the Fits object.

Definition at line 42 of file ExposureFitsReader.h.

Constructor & Destructor Documentation

◆ ExposureFitsReader() [1/5]

lsst::afw::image::ExposureFitsReader::ExposureFitsReader ( std::string const &  fileName)
explicit

Construct a FITS reader object.

Parameters
fileNameName of a file to open.

Definition at line 263 of file ExposureFitsReader.cc.

263 : _maskedImageReader(fileName) {}

◆ ExposureFitsReader() [2/5]

lsst::afw::image::ExposureFitsReader::ExposureFitsReader ( fits::MemFileManager manager)
explicit

Construct a FITS reader object.

Parameters
managerMemory block containing a FITS file.

Definition at line 265 of file ExposureFitsReader.cc.

265 : _maskedImageReader(manager) {}

◆ ExposureFitsReader() [3/5]

lsst::afw::image::ExposureFitsReader::ExposureFitsReader ( fits::Fits fitsFile)
explicit

Construct a FITS reader object.

Parameters
fitsFilePointer to a CFITSIO file object. Lifetime will not be managed by the Reader object.

Definition at line 267 of file ExposureFitsReader.cc.

267 : _maskedImageReader(fitsFile) {}

◆ ExposureFitsReader() [4/5]

lsst::afw::image::ExposureFitsReader::ExposureFitsReader ( ExposureFitsReader const &  )
delete

◆ ExposureFitsReader() [5/5]

lsst::afw::image::ExposureFitsReader::ExposureFitsReader ( ExposureFitsReader &&  )
delete

◆ ~ExposureFitsReader()

lsst::afw::image::ExposureFitsReader::~ExposureFitsReader ( )
defaultnoexcept

Member Function Documentation

◆ getFileName()

std::string lsst::afw::image::ExposureFitsReader::getFileName ( ) const
inline

Return the name of the file this reader targets.

Definition at line 274 of file ExposureFitsReader.h.

274 { return _maskedImageReader.getFileName(); }
std::string getFileName() const
Return the name of the file this reader targets.

◆ operator=() [1/2]

ExposureFitsReader& lsst::afw::image::ExposureFitsReader::operator= ( ExposureFitsReader const &  )
delete

◆ operator=() [2/2]

ExposureFitsReader& lsst::afw::image::ExposureFitsReader::operator= ( ExposureFitsReader &&  )
delete

◆ read()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
template Exposure< std::uint64_t, MaskPixel, VariancePixel > lsst::afw::image::ExposureFitsReader::read ( lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT,
bool  conformMasks = false,
bool  allowUnsafe = false 
)

Read the full Exposure.

Parameters
bboxA bounding box used to defined a subimage, or an empty box (default) to read the whole image.
originCoordinate system convention for the given box.
conformMasksIf True, conform the global mask dict to match this file.
allowUnsafePermit reading into the requested pixel type even when on-disk values may overflow or truncate.

In Python, this templated method is wrapped with an additional dtype argument to provide the type to read (for the image plane). This defaults to the type of the on-disk image.

Definition at line 473 of file ExposureFitsReader.cc.

476  {
477  auto mi =
478  readMaskedImage<ImagePixelT, MaskPixelT, VariancePixelT>(bbox, origin, conformMasks, allowUnsafe);
479  return Exposure<ImagePixelT, MaskPixelT, VariancePixelT>(mi, readExposureInfo());
480 }
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
std::shared_ptr< ExposureInfo > readExposureInfo()
Read the ExposureInfo containing all non-image components.

◆ readApCorrMap()

std::shared_ptr< ApCorrMap > lsst::afw::image::ExposureFitsReader::readApCorrMap ( )

Read the Exposure's aperture correction map.

Definition at line 324 of file ExposureFitsReader.cc.

324  {
325  _ensureReaders();
326  return _archiveReader->readComponent<ApCorrMap>(_getFitsFile(), ArchiveReader::AP_CORR_MAP);
327 }

◆ readBBox()

lsst::geom::Box2I lsst::afw::image::ExposureFitsReader::readBBox ( ImageOrigin  origin = PARENT)

Read the bounding box of the on-disk image.

Parameters
originCoordinate system convention for the returned box. If LOCAL, the returned box will always have a minimum of (0, 0).

Definition at line 271 of file ExposureFitsReader.cc.

271  {
272  return _maskedImageReader.readBBox(origin);
273 }
lsst::geom::Box2I readBBox(ImageOrigin origin=PARENT)
Read the bounding box of the on-disk image.

◆ readCoaddInputs()

std::shared_ptr< CoaddInputs > lsst::afw::image::ExposureFitsReader::readCoaddInputs ( )

Read the Exposure's coadd input catalogs.

Definition at line 329 of file ExposureFitsReader.cc.

329  {
330  _ensureReaders();
331  return _archiveReader->readComponent<CoaddInputs>(_getFitsFile(), ArchiveReader::COADD_INPUTS);
332 }

◆ readDetector()

std::shared_ptr< cameraGeom::Detector > lsst::afw::image::ExposureFitsReader::readDetector ( )

Read the Exposure's detector.

Definition at line 345 of file ExposureFitsReader.cc.

345  {
346  _ensureReaders();
347  return _archiveReader->readComponent<cameraGeom::Detector>(_getFitsFile(), ArchiveReader::DETECTOR);
348 }

◆ readExposureInfo()

std::shared_ptr< ExposureInfo > lsst::afw::image::ExposureFitsReader::readExposureInfo ( )

Read the ExposureInfo containing all non-image components.

Definition at line 355 of file ExposureFitsReader.cc.

355  {
356  auto result = std::make_shared<ExposureInfo>();
357  result->setMetadata(readMetadata());
358  result->setFilter(readFilter());
359  result->setPhotoCalib(readPhotoCalib());
360  result->setVisitInfo(readVisitInfo());
361  // When reading an ExposureInfo (as opposed to reading individual
362  // components), we warn and try to proceed when a component is present
363  // but can't be read due its serialization factory not being set up
364  // (that's what throws the NotFoundErrors caught below).
365  try {
366  result->setPsf(readPsf());
367  } catch (pex::exceptions::NotFoundError& err) {
368  LOGLS_WARN(_log, "Could not read PSF; setting to null: " << err.what());
369  }
370  try {
371  result->setCoaddInputs(readCoaddInputs());
372  } catch (pex::exceptions::NotFoundError& err) {
373  LOGLS_WARN(_log, "Could not read CoaddInputs; setting to null: " << err.what());
374  }
375  try {
376  result->setApCorrMap(readApCorrMap());
377  } catch (pex::exceptions::NotFoundError& err) {
378  LOGLS_WARN(_log, "Could not read ApCorrMap; setting to null: " << err.what());
379  }
380  try {
381  result->setValidPolygon(readValidPolygon());
382  } catch (pex::exceptions::NotFoundError& err) {
383  LOGLS_WARN(_log, "Could not read ValidPolygon; setting to null: " << err.what());
384  }
385  try {
386  result->setTransmissionCurve(readTransmissionCurve());
387  } catch (pex::exceptions::NotFoundError& err) {
388  LOGLS_WARN(_log, "Could not read TransmissionCurve; setting to null: " << err.what());
389  }
390  try {
391  result->setDetector(readDetector());
392  } catch (pex::exceptions::NotFoundError& err) {
393  LOGLS_WARN(_log, "Could not read Detector; setting to null: " << err.what());
394  }
395  // In the case of WCS, we fall back to the metadata WCS if the one from
396  // the archive can't be read.
397  _ensureReaders();
398  result->setWcs(_metadataReader->wcs);
399  try {
400  auto wcs = _archiveReader->readComponent<afw::geom::SkyWcs>(_getFitsFile(), ArchiveReader::WCS);
401  if (!wcs) {
402  LOGLS_DEBUG(_log, "No WCS found in binary table");
403  } else {
404  result->setWcs(wcs);
405  }
406  } catch (pex::exceptions::NotFoundError& err) {
407  auto msg = str(boost::format("Could not read WCS extension; setting to null: %s") % err.what());
408  if (result->hasWcs()) {
409  msg += " ; using WCS from FITS header";
410  }
411  LOGLS_WARN(_log, msg);
412  }
413  for (auto keyValue : readExtraComponents()) {
415  std::string key = keyValue.first;
416  StorablePtr object = std::dynamic_pointer_cast<StorablePtr::element_type>(keyValue.second);
417 
418  if (object.use_count() > 0) { // Failed cast guarantees empty pointer, but not a null one
419  result->setComponent(typehandling::makeKey<StorablePtr>(key), object);
420  } else {
421  LOGLS_WARN(_log, "Data corruption: generic component " << key << " is not a Storable; skipping.");
422  }
423  }
424  return result;
425 } // namespace image
#define LOGLS_WARN(logger, message)
Log a warn-level message using an iostream-based interface.
Definition: Log.h:648
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174
std::shared_ptr< CoaddInputs > readCoaddInputs()
Read the Exposure&#39;s coadd input catalogs.
std::shared_ptr< VisitInfo > readVisitInfo()
Read the Exposure&#39;s visit metadata.
std::shared_ptr< PhotoCalib > readPhotoCalib()
Read the Exposure&#39;s photometric calibration.
table::Key< table::Array< std::uint8_t > > wcs
Definition: SkyWcs.cc:71
STL class.
Filter readFilter()
Read the Exposure&#39;s filter.
std::map< std::string, std::shared_ptr< table::io::Persistable > > readExtraComponents()
Read the Exposure&#39;s non-standard components.
std::shared_ptr< afw::geom::polygon::Polygon > readValidPolygon()
Read the polygon describing the region of validity for the Exposure.
#define LOGLS_DEBUG(logger, message)
Log a debug-level message using an iostream-based interface.
Definition: Log.h:608
Key< U > key
Definition: Schema.cc:281
T dynamic_pointer_cast(T... args)
std::shared_ptr< ApCorrMap > readApCorrMap()
Read the Exposure&#39;s aperture correction map.
std::shared_ptr< cameraGeom::Detector > readDetector()
Read the Exposure&#39;s detector.
std::shared_ptr< daf::base::PropertyList > readMetadata()
Read the flexible metadata associated with the Exposure.
std::shared_ptr< detection::Psf > readPsf()
Read the Exposure&#39;s point-spread function.
std::shared_ptr< TransmissionCurve > readTransmissionCurve()
Read the Exposure&#39;s transmission curve.
py::object result
Definition: _schema.cc:429

◆ readExtraComponents()

std::map< std::string, std::shared_ptr< table::io::Persistable > > lsst::afw::image::ExposureFitsReader::readExtraComponents ( )

Read the Exposure's non-standard components.

Definition at line 350 of file ExposureFitsReader.cc.

350  {
351  _ensureReaders();
352  return _archiveReader->readExtraComponents(_getFitsFile());
353 }

◆ readFilter()

Filter lsst::afw::image::ExposureFitsReader::readFilter ( )

Read the Exposure's filter.

Definition at line 299 of file ExposureFitsReader.cc.

299  {
300  _ensureReaders();
301  return _metadataReader->filter;
302 }

◆ readImage()

template<typename ImagePixelT >
template Image< std::uint64_t > lsst::afw::image::ExposureFitsReader::readImage ( lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT,
bool  allowUnsafe = false 
)

Read the image plane.

Parameters
bboxA bounding box used to defined a subimage, or an empty box (default) to read the whole image.
originCoordinate system convention for the given box.
allowUnsafePermit reading into the requested pixel type even when on-disk values may overflow or truncate.

In Python, this templated method is wrapped with an additional dtype argument to provide the type to read. This defaults to the type of the on-disk image.

Definition at line 428 of file ExposureFitsReader.cc.

429  {
430  return _maskedImageReader.readImage<ImagePixelT>(bbox, origin, allowUnsafe);
431 }
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
Image< ImagePixelT > readImage(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
Read the image plane.

◆ readImageArray()

template<typename ImagePixelT >
template ndarray::Array< std::uint64_t, 2, 2 > lsst::afw::image::ExposureFitsReader::readImageArray ( lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT,
bool  allowUnsafe = false 
)

Read the image plane.

Parameters
bboxA bounding box used to defined a subimage, or an empty box (default) to read the whole image.
originCoordinate system convention for the given box.
allowUnsafePermit reading into the requested pixel type even when on-disk values may overflow or truncate.

In Python, this templated method is wrapped with an additional dtype argument to provide the type to read. This defaults to the type of the on-disk image.

Definition at line 434 of file ExposureFitsReader.cc.

435  {
436  return _maskedImageReader.readImageArray<ImagePixelT>(bbox, origin, allowUnsafe);
437 }
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
ndarray::Array< ImagePixelT, 2, 2 > readImageArray(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
Read the image plane.

◆ readImageDType()

std::string lsst::afw::image::ExposureFitsReader::readImageDType ( ) const

Read a string describing the pixel type of the on-disk image plane.

Returns
A string of the form [u](int|float)<bits> (e.g. "uint16", "float64").

Definition at line 279 of file ExposureFitsReader.cc.

279 { return _maskedImageReader.readImageDType(); }
std::string readImageDType() const
Read a string describing the pixel type of the on-disk image plane.

◆ readMask()

template<typename MaskPixelT >
template Mask< MaskPixel > lsst::afw::image::ExposureFitsReader::readMask ( lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT,
bool  conformMasks = false,
bool  allowUnsafe = false 
)

Read the mask plane.

Parameters
bboxA bounding box used to defined a subimage, or an empty box (default) to read the whole image.
originCoordinate system convention for the given box.
conformMasksIf True, conform the global mask dict to match this file.
allowUnsafePermit reading into the requested pixel type even when on-disk values may overflow or truncate.

In Python, this templated method is wrapped with an additional dtype argument to provide the type to read. This defaults to the type of the on-disk image.

Definition at line 440 of file ExposureFitsReader.cc.

441  {
442  return _maskedImageReader.readMask<MaskPixelT>(bbox, origin, conformMasks, allowUnsafe);
443 }
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
Mask< MaskPixelT > readMask(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool allowUnsafe=false)
Read the mask plane.

◆ readMaskArray()

template<typename MaskPixelT >
template ndarray::Array< MaskPixel, 2, 2 > lsst::afw::image::ExposureFitsReader::readMaskArray ( lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT,
bool  allowUnsafe = false 
)

Read the mask plane.

Parameters
bboxA bounding box used to defined a subimage, or an empty box (default) to read the whole image.
originCoordinate system convention for the given box.
allowUnsafePermit reading into the requested pixel type even when on-disk values may overflow or truncate.

In Python, this templated method is wrapped with an additional dtype argument to provide the type to read. This defaults to the type of the on-disk image.

Definition at line 446 of file ExposureFitsReader.cc.

447  {
448  return _maskedImageReader.readMaskArray<MaskPixelT>(bbox, origin, allowUnsafe);
449 }
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
ndarray::Array< MaskPixelT, 2, 2 > readMaskArray(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
Read the mask plane.

◆ readMaskDType()

std::string lsst::afw::image::ExposureFitsReader::readMaskDType ( ) const

Read a string describing the pixel type of the on-disk image plane.

Returns
A string of the form [u](int|float)<bits> (e.g. "uint16", "float64").

Definition at line 281 of file ExposureFitsReader.cc.

281 { return _maskedImageReader.readMaskDType(); }
std::string readMaskDType() const
Read a string describing the pixel type of the on-disk image plane.

◆ readMaskedImage()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
template MaskedImage< std::uint64_t, MaskPixel, VariancePixel > lsst::afw::image::ExposureFitsReader::readMaskedImage ( lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT,
bool  conformMasks = false,
bool  allowUnsafe = false 
)

Read the MaskedImage.

Parameters
bboxA bounding box used to defined a subimage, or an empty box (default) to read the whole image.
originCoordinate system convention for the given box.
conformMasksIf True, conform the global mask dict to match this file.
allowUnsafePermit reading into the requested pixel type even when on-disk values may overflow or truncate.

In Python, this templated method is wrapped with an additional dtype argument to provide the type to read (for the image plane). This defaults to the type of the on-disk image.

Definition at line 465 of file ExposureFitsReader.cc.

466  {
467  return _maskedImageReader.read<ImagePixelT, MaskPixelT, VariancePixelT>(bbox, origin, conformMasks,
468  /* needAllHdus= */ false,
469  allowUnsafe);
470 }
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > read(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool needAllHdus=false, bool allowUnsafe=false)
Read the full MaskedImage.

◆ readMetadata()

std::shared_ptr< daf::base::PropertyList > lsst::afw::image::ExposureFitsReader::readMetadata ( )

Read the flexible metadata associated with the Exposure.

FITS header keys used to construct other Exposure components will be stripped.

Definition at line 285 of file ExposureFitsReader.cc.

285  {
286  _ensureReaders();
287  return _metadataReader->metadata;
288 }

◆ readPhotoCalib()

std::shared_ptr< PhotoCalib > lsst::afw::image::ExposureFitsReader::readPhotoCalib ( )

Read the Exposure's photometric calibration.

Definition at line 304 of file ExposureFitsReader.cc.

304  {
305  _ensureReaders();
306  if (_metadataReader->version == 0) {
307  return _metadataReader->photoCalib;
308  } else {
309  return _archiveReader->readComponent<image::PhotoCalib>(_getFitsFile(), ArchiveReader::PHOTOCALIB);
310  }
311 }
The photometric calibration of an exposure.
Definition: PhotoCalib.h:114

◆ readPsf()

std::shared_ptr< detection::Psf > lsst::afw::image::ExposureFitsReader::readPsf ( )

Read the Exposure's point-spread function.

Definition at line 313 of file ExposureFitsReader.cc.

313  {
314  _ensureReaders();
315  return _archiveReader->readComponent<detection::Psf>(_getFitsFile(), ArchiveReader::PSF);
316 }

◆ readTransmissionCurve()

std::shared_ptr< TransmissionCurve > lsst::afw::image::ExposureFitsReader::readTransmissionCurve ( )

Read the Exposure's transmission curve.

Definition at line 339 of file ExposureFitsReader.cc.

339  {
340  _ensureReaders();
341  return _archiveReader->readComponent<TransmissionCurve>(_getFitsFile(),
343 }

◆ readValidPolygon()

std::shared_ptr< afw::geom::polygon::Polygon > lsst::afw::image::ExposureFitsReader::readValidPolygon ( )

Read the polygon describing the region of validity for the Exposure.

Definition at line 318 of file ExposureFitsReader.cc.

318  {
319  _ensureReaders();
320  return _archiveReader->readComponent<afw::geom::polygon::Polygon>(_getFitsFile(),
322 }

◆ readVariance()

template<typename VariancePixelT >
template Image< VariancePixel > lsst::afw::image::ExposureFitsReader::readVariance ( lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT,
bool  allowUnsafe = false 
)

Read the variance plane.

Parameters
bboxA bounding box used to defined a subimage, or an empty box (default) to read the whole image.
originCoordinate system convention for the given box.
allowUnsafePermit reading into the requested pixel type even when on-disk values may overflow or truncate.

In Python, this templated method is wrapped with an additional dtype argument to provide the type to read. This defaults to the type of the on-disk image.

Definition at line 452 of file ExposureFitsReader.cc.

453  {
454  return _maskedImageReader.readVariance<VariancePixelT>(bbox, origin, allowUnsafe);
455 }
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
Image< VariancePixelT > readVariance(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
Read the variance plane.

◆ readVarianceArray()

template<typename VariancePixelT >
template ndarray::Array< VariancePixel, 2, 2 > lsst::afw::image::ExposureFitsReader::readVarianceArray ( lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT,
bool  allowUnsafe = false 
)

Read the variance plane.

Parameters
bboxA bounding box used to defined a subimage, or an empty box (default) to read the whole image.
originCoordinate system convention for the given box.
allowUnsafePermit reading into the requested pixel type even when on-disk values may overflow or truncate.

In Python, this templated method is wrapped with an additional dtype argument to provide the type to read. This defaults to the type of the on-disk image.

Definition at line 458 of file ExposureFitsReader.cc.

460  {
461  return _maskedImageReader.readVarianceArray<VariancePixelT>(bbox, origin, allowUnsafe);
462 }
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
ndarray::Array< VariancePixelT, 2, 2 > readVarianceArray(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
Read the variance plane.

◆ readVarianceDType()

std::string lsst::afw::image::ExposureFitsReader::readVarianceDType ( ) const

Read a string describing the pixel type of the on-disk image plane.

Returns
A string of the form [u](int|float)<bits> (e.g. "uint16", "float64").

Definition at line 283 of file ExposureFitsReader.cc.

283 { return _maskedImageReader.readVarianceDType(); }
std::string readVarianceDType() const
Read a string describing the pixel type of the on-disk image plane.

◆ readVisitInfo()

std::shared_ptr< VisitInfo > lsst::afw::image::ExposureFitsReader::readVisitInfo ( )

Read the Exposure's visit metadata.

Definition at line 334 of file ExposureFitsReader.cc.

334  {
335  _ensureReaders();
336  return _metadataReader->visitInfo;
337 }

◆ readWcs()

std::shared_ptr< afw::geom::SkyWcs > lsst::afw::image::ExposureFitsReader::readWcs ( )

Read the Exposure's world coordinate system.

Definition at line 290 of file ExposureFitsReader.cc.

290  {
291  _ensureReaders();
292  auto r = _archiveReader->readComponent<afw::geom::SkyWcs>(_getFitsFile(), ArchiveReader::WCS);
293  if (!r) {
294  r = _metadataReader->wcs;
295  }
296  return r;
297 }

◆ readXY0()

lsst::geom::Point2I lsst::afw::image::ExposureFitsReader::readXY0 ( lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT 
)

Read the image origin from the on-disk image or a subimage thereof.

Parameters
bboxA bounding box used to defined a subimage, or an empty
originCoordinate system convention for the given box. Ignored if bbox is empty.

Definition at line 275 of file ExposureFitsReader.cc.

275  {
276  return _maskedImageReader.readXY0(bbox, origin);
277 }
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
lsst::geom::Point2I readXY0(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT)
Read the image origin from the on-disk image or a subimage thereof.

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