LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
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. 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 | |
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. 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... | |
int | readSerializationVersion () |
Read the serialization version number from the header. More... | |
std::shared_ptr< daf::base::PropertyList > | readMetadata () |
Read the flexible metadata associated with the Exposure. More... | |
std::optional< table::RecordId > | readExposureId () |
Read the Exposure's exposure ID, if it exists. More... | |
std::shared_ptr< afw::geom::SkyWcs > | readWcs () |
Read the Exposure's world coordinate system. More... | |
Filter | readFilter () |
Read the Exposure's filter. More... | |
std::shared_ptr< FilterLabel > | readFilterLabel () |
Read the Exposure's filter information. More... | |
std::shared_ptr< PhotoCalib > | readPhotoCalib () |
Read the Exposure's photometric calibration. More... | |
std::shared_ptr< detection::Psf > | readPsf () |
Read the Exposure's point-spread function. More... | |
std::shared_ptr< afw::geom::polygon::Polygon > | readValidPolygon () |
Read the polygon describing the region of validity for the Exposure. More... | |
std::shared_ptr< ApCorrMap > | readApCorrMap () |
Read the Exposure's aperture correction map. More... | |
std::shared_ptr< CoaddInputs > | readCoaddInputs () |
Read the Exposure's coadd input catalogs. More... | |
std::shared_ptr< VisitInfo > | readVisitInfo () |
Read the Exposure's visit metadata. More... | |
std::shared_ptr< TransmissionCurve > | readTransmissionCurve () |
Read the Exposure's transmission curve. More... | |
std::shared_ptr< cameraGeom::Detector > | readDetector () |
Read the Exposure's detector. More... | |
std::shared_ptr< typehandling::Storable > | readComponent (std::string const &componentName) |
Read an arbitrary non-standard component by name. More... | |
std::map< std::string, std::shared_ptr< table::io::Persistable > > | readExtraComponents () |
Read the Exposure's non-standard components. More... | |
std::shared_ptr< ExposureInfo > | readExposureInfo () |
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... | |
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 490 of file ExposureFitsReader.cc.
|
explicit |
Construct a FITS reader object.
manager | Memory block containing a FITS file. |
Definition at line 492 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 494 of file ExposureFitsReader.cc.
|
delete |
|
delete |
|
defaultnoexcept |
|
inline |
Return the name of the file this reader targets.
Definition at line 294 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 738 of file ExposureFitsReader.cc.
std::shared_ptr< ApCorrMap > lsst::afw::image::ExposureFitsReader::readApCorrMap | ( | ) |
Read the Exposure's aperture correction map.
Definition at line 575 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 498 of file ExposureFitsReader.cc.
std::shared_ptr< CoaddInputs > lsst::afw::image::ExposureFitsReader::readCoaddInputs | ( | ) |
Read the Exposure's coadd input catalogs.
Definition at line 580 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 601 of file ExposureFitsReader.cc.
std::shared_ptr< cameraGeom::Detector > lsst::afw::image::ExposureFitsReader::readDetector | ( | ) |
Read the Exposure's detector.
Definition at line 596 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 522 of file ExposureFitsReader.cc.
std::shared_ptr< ExposureInfo > lsst::afw::image::ExposureFitsReader::readExposureInfo | ( | ) |
Read the ExposureInfo containing all non-image components.
Definition at line 611 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 606 of file ExposureFitsReader.cc.
Filter lsst::afw::image::ExposureFitsReader::readFilter | ( | ) |
Read the Exposure's filter.
Definition at line 536 of file ExposureFitsReader.cc.
std::shared_ptr< FilterLabel > lsst::afw::image::ExposureFitsReader::readFilterLabel | ( | ) |
Read the Exposure's filter information.
Definition at line 546 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 693 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 699 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 511 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 705 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 711 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 513 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 730 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 517 of file ExposureFitsReader.cc.
std::shared_ptr< PhotoCalib > lsst::afw::image::ExposureFitsReader::readPhotoCalib | ( | ) |
Read the Exposure's photometric calibration.
Definition at line 555 of file ExposureFitsReader.cc.
std::shared_ptr< detection::Psf > lsst::afw::image::ExposureFitsReader::readPsf | ( | ) |
int lsst::afw::image::ExposureFitsReader::readSerializationVersion | ( | ) |
Read the serialization version number from the header.
Definition at line 506 of file ExposureFitsReader.cc.
std::shared_ptr< TransmissionCurve > lsst::afw::image::ExposureFitsReader::readTransmissionCurve | ( | ) |
Read the Exposure's transmission curve.
Definition at line 590 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 569 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 717 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 723 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 515 of file ExposureFitsReader.cc.
std::shared_ptr< VisitInfo > lsst::afw::image::ExposureFitsReader::readVisitInfo | ( | ) |
Read the Exposure's visit metadata.
Definition at line 585 of file ExposureFitsReader.cc.
std::shared_ptr< afw::geom::SkyWcs > lsst::afw::image::ExposureFitsReader::readWcs | ( | ) |
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 502 of file ExposureFitsReader.cc.