LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
|
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. | |
ExposureFitsReader (fits::MemFileManager &manager) | |
Construct a FITS reader object. | |
ExposureFitsReader (fits::Fits *fitsFile) | |
Construct a FITS reader object. | |
ExposureFitsReader (ExposureFitsReader const &)=delete | |
ExposureFitsReader (ExposureFitsReader &&)=delete | |
ExposureFitsReader & | operator= (ExposureFitsReader const &)=delete |
ExposureFitsReader & | operator= (ExposureFitsReader &&)=delete |
~ExposureFitsReader () noexcept | |
lsst::geom::Box2I | readBBox (ImageOrigin origin=PARENT) |
Read the bounding box of the on-disk image. | |
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. | |
int | readSerializationVersion () |
Read the serialization version number from the header. | |
std::shared_ptr< daf::base::PropertyList > | readMetadata () |
Read the flexible metadata associated with the Exposure. | |
std::optional< table::RecordId > | readExposureId () |
Read the Exposure's exposure ID, if it exists. | |
std::shared_ptr< afw::geom::SkyWcs > | readWcs () |
Read the Exposure's world coordinate system. | |
std::shared_ptr< FilterLabel > | readFilter () |
Read the Exposure's filter information. | |
std::shared_ptr< PhotoCalib > | readPhotoCalib () |
Read the Exposure's photometric calibration. | |
std::shared_ptr< detection::Psf > | readPsf () |
Read the Exposure's point-spread function. | |
std::shared_ptr< afw::geom::polygon::Polygon > | readValidPolygon () |
Read the polygon describing the region of validity for the Exposure. | |
std::shared_ptr< ApCorrMap > | readApCorrMap () |
Read the Exposure's aperture correction map. | |
std::shared_ptr< CoaddInputs > | readCoaddInputs () |
Read the Exposure's coadd input catalogs. | |
std::shared_ptr< VisitInfo > | readVisitInfo () |
Read the Exposure's visit metadata. | |
std::shared_ptr< TransmissionCurve > | readTransmissionCurve () |
Read the Exposure's transmission curve. | |
std::shared_ptr< cameraGeom::Detector > | readDetector () |
Read the Exposure's detector. | |
std::shared_ptr< typehandling::Storable > | readComponent (std::string const &componentName) |
Read an arbitrary non-standard component by name. | |
std::map< std::string, std::shared_ptr< table::io::Persistable > > | readExtraComponents () |
Read the Exposure's non-standard components. | |
std::shared_ptr< ExposureInfo > | readExposureInfo () |
Read the ExposureInfo containing all non-image components. | |
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. | |
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. | |
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. | |
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. | |
std::string | getFileName () const |
Return the name of the file this reader targets. | |
std::string | readImageDType () const |
Read a string describing the pixel type of the on-disk image plane. | |
std::string | readMaskDType () const |
Read a string describing the pixel type of the on-disk image plane. | |
std::string | readVarianceDType () const |
Read a string describing the pixel type of the on-disk image plane. | |
template<typename ImagePixelT> | |
Image< ImagePixelT > | readImage (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false) |
Read the image plane. | |
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. | |
template<typename VariancePixelT> | |
Image< VariancePixelT > | readVariance (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false) |
Read the variance plane. | |
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. | |
A FITS reader class for Exposures and their components.
Definition at line 44 of file ExposureFitsReader.h.
|
explicit |
Construct a FITS reader object.
fileName | Name of a file to open. |
Definition at line 387 of file ExposureFitsReader.cc.
|
explicit |
Construct a FITS reader object.
manager | Memory block containing a FITS file. |
Definition at line 389 of file ExposureFitsReader.cc.
|
explicit |
Construct a FITS reader object.
fitsFile | Pointer to a CFITSIO file object. Lifetime will not be managed by the Reader object. |
Definition at line 391 of file ExposureFitsReader.cc.
|
delete |
|
delete |
|
defaultnoexcept |
|
inline |
Return the name of the file this reader targets.
Definition at line 289 of file ExposureFitsReader.h.
|
delete |
|
delete |
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.
bbox | A bounding box used to defined a subimage, or an empty box (default) to read the whole image. |
origin | Coordinate system convention for the given box. |
conformMasks | If True, conform the global mask dict to match this file. |
allowUnsafe | Permit 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 625 of file ExposureFitsReader.cc.
std::shared_ptr< ApCorrMap > lsst::afw::image::ExposureFitsReader::readApCorrMap | ( | ) |
Read the Exposure's aperture correction map.
Definition at line 462 of file ExposureFitsReader.cc.
lsst::geom::Box2I lsst::afw::image::ExposureFitsReader::readBBox | ( | ImageOrigin | origin = PARENT | ) |
Read the bounding box of the on-disk image.
origin | Coordinate system convention for the returned box. If LOCAL, the returned box will always have a minimum of (0, 0). |
Definition at line 395 of file ExposureFitsReader.cc.
std::shared_ptr< CoaddInputs > lsst::afw::image::ExposureFitsReader::readCoaddInputs | ( | ) |
Read the Exposure's coadd input catalogs.
Definition at line 467 of file ExposureFitsReader.cc.
std::shared_ptr< typehandling::Storable > lsst::afw::image::ExposureFitsReader::readComponent | ( | std::string const & | componentName | ) |
Read an arbitrary non-standard component by name.
Definition at line 488 of file ExposureFitsReader.cc.
std::shared_ptr< cameraGeom::Detector > lsst::afw::image::ExposureFitsReader::readDetector | ( | ) |
Read the Exposure's detector.
Definition at line 483 of file ExposureFitsReader.cc.
std::optional< table::RecordId > lsst::afw::image::ExposureFitsReader::readExposureId | ( | ) |
Read the Exposure's exposure ID, if it exists.
Definition at line 419 of file ExposureFitsReader.cc.
std::shared_ptr< ExposureInfo > lsst::afw::image::ExposureFitsReader::readExposureInfo | ( | ) |
Read the ExposureInfo containing all non-image components.
Definition at line 498 of file ExposureFitsReader.cc.
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 493 of file ExposureFitsReader.cc.
std::shared_ptr< FilterLabel > lsst::afw::image::ExposureFitsReader::readFilter | ( | ) |
Read the Exposure's filter information.
Definition at line 433 of file ExposureFitsReader.cc.
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.
bbox | A bounding box used to defined a subimage, or an empty box (default) to read the whole image. |
origin | Coordinate system convention for the given box. |
allowUnsafe | Permit 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 580 of file ExposureFitsReader.cc.
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.
bbox | A bounding box used to defined a subimage, or an empty box (default) to read the whole image. |
origin | Coordinate system convention for the given box. |
allowUnsafe | Permit 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 586 of file ExposureFitsReader.cc.
std::string lsst::afw::image::ExposureFitsReader::readImageDType | ( | ) | const |
Read a string describing the pixel type of the on-disk image plane.
[u](int|float)<bits>
(e.g. "uint16", "float64"). Definition at line 408 of file ExposureFitsReader.cc.
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.
bbox | A bounding box used to defined a subimage, or an empty box (default) to read the whole image. |
origin | Coordinate system convention for the given box. |
conformMasks | If True, conform the global mask dict to match this file. |
allowUnsafe | Permit 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 592 of file ExposureFitsReader.cc.
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.
bbox | A bounding box used to defined a subimage, or an empty box (default) to read the whole image. |
origin | Coordinate system convention for the given box. |
allowUnsafe | Permit 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 598 of file ExposureFitsReader.cc.
std::string lsst::afw::image::ExposureFitsReader::readMaskDType | ( | ) | const |
Read a string describing the pixel type of the on-disk image plane.
[u](int|float)<bits>
(e.g. "uint16", "float64"). Definition at line 410 of file ExposureFitsReader.cc.
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.
bbox | A bounding box used to defined a subimage, or an empty box (default) to read the whole image. |
origin | Coordinate system convention for the given box. |
conformMasks | If True, conform the global mask dict to match this file. |
allowUnsafe | Permit 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 617 of file ExposureFitsReader.cc.
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 414 of file ExposureFitsReader.cc.
std::shared_ptr< PhotoCalib > lsst::afw::image::ExposureFitsReader::readPhotoCalib | ( | ) |
Read the Exposure's photometric calibration.
Definition at line 442 of file ExposureFitsReader.cc.
std::shared_ptr< detection::Psf > lsst::afw::image::ExposureFitsReader::readPsf | ( | ) |
Read the Exposure's point-spread function.
Definition at line 451 of file ExposureFitsReader.cc.
int lsst::afw::image::ExposureFitsReader::readSerializationVersion | ( | ) |
Read the serialization version number from the header.
Definition at line 403 of file ExposureFitsReader.cc.
std::shared_ptr< TransmissionCurve > lsst::afw::image::ExposureFitsReader::readTransmissionCurve | ( | ) |
Read the Exposure's transmission curve.
Definition at line 477 of file ExposureFitsReader.cc.
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 456 of file ExposureFitsReader.cc.
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.
bbox | A bounding box used to defined a subimage, or an empty box (default) to read the whole image. |
origin | Coordinate system convention for the given box. |
allowUnsafe | Permit 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 604 of file ExposureFitsReader.cc.
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.
bbox | A bounding box used to defined a subimage, or an empty box (default) to read the whole image. |
origin | Coordinate system convention for the given box. |
allowUnsafe | Permit 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 610 of file ExposureFitsReader.cc.
std::string lsst::afw::image::ExposureFitsReader::readVarianceDType | ( | ) | const |
Read a string describing the pixel type of the on-disk image plane.
[u](int|float)<bits>
(e.g. "uint16", "float64"). Definition at line 412 of file ExposureFitsReader.cc.
std::shared_ptr< VisitInfo > lsst::afw::image::ExposureFitsReader::readVisitInfo | ( | ) |
Read the Exposure's visit metadata.
Definition at line 472 of file ExposureFitsReader.cc.
std::shared_ptr< afw::geom::SkyWcs > lsst::afw::image::ExposureFitsReader::readWcs | ( | ) |
Read the Exposure's world coordinate system.
Definition at line 424 of file ExposureFitsReader.cc.
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.
bbox | A bounding box used to defined a subimage, or an empty |
origin | Coordinate system convention for the given box. Ignored if bbox is empty. |
Definition at line 399 of file ExposureFitsReader.cc.