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
|
A FITS reader class for MaskedImages and their components. More...
#include <MaskedImageFitsReader.h>
Public Member Functions | |
MaskedImageFitsReader (std::string const &fileName, int hdu=fits::DEFAULT_HDU) | |
Construct a FITS reader object. More... | |
MaskedImageFitsReader (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU) | |
Construct a FITS reader object. More... | |
MaskedImageFitsReader (fits::Fits *fitsFile) | |
Construct a FITS reader object. More... | |
MaskedImageFitsReader (MaskedImageFitsReader const &)=delete | |
MaskedImageFitsReader (MaskedImageFitsReader &&)=delete | |
MaskedImageFitsReader & | operator= (MaskedImageFitsReader const &)=delete |
MaskedImageFitsReader & | operator= (MaskedImageFitsReader &&)=delete |
~MaskedImageFitsReader () 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... | |
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 > | 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. 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... | |
std::shared_ptr< daf::base::PropertyList > | readPrimaryMetadata () |
Read the FITS header of one of the HDUs. More... | |
std::shared_ptr< daf::base::PropertyList > | readImageMetadata () |
Read the FITS header of one of the HDUs. More... | |
std::shared_ptr< daf::base::PropertyList > | readMaskMetadata () |
Read the FITS header of one of the HDUs. More... | |
std::shared_ptr< daf::base::PropertyList > | readVarianceMetadata () |
Read the FITS header of one of the HDUs. 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... | |
Friends | |
class | ExposureFitsReader |
A FITS reader class for MaskedImages and their components.
Definition at line 41 of file MaskedImageFitsReader.h.
|
explicit |
Construct a FITS reader object.
fileName | Name of a file to open. |
hdu | HDU index for the image plane, where 0 is the primary HDU and DEFAULT_HDU is the first non-empty HDU. |
Definition at line 46 of file MaskedImageFitsReader.cc.
|
explicit |
Construct a FITS reader object.
manager | Memory block containing a FITS file. |
hdu | HDU index for the image plane, where 0 is the primary HDU and DEFAULT_HDU is the first non-empty HDU. |
Definition at line 52 of file MaskedImageFitsReader.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 58 of file MaskedImageFitsReader.cc.
|
delete |
|
delete |
|
defaultnoexcept |
|
inline |
Return the name of the file this reader targets.
Definition at line 230 of file MaskedImageFitsReader.h.
|
delete |
|
delete |
template MaskedImage< std::uint64_t, MaskPixel, VariancePixel > lsst::afw::image::MaskedImageFitsReader::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.
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. |
needAllHdus | If True, refuse to read the image if the mask or variance plane is not present (the image plane is always required). |
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 170 of file MaskedImageFitsReader.cc.
lsst::geom::Box2I lsst::afw::image::MaskedImageFitsReader::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 72 of file MaskedImageFitsReader.cc.
template Image< std::uint64_t > lsst::afw::image::MaskedImageFitsReader::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 131 of file MaskedImageFitsReader.cc.
template ndarray::Array< std::uint64_t, 2, 2 > lsst::afw::image::MaskedImageFitsReader::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 137 of file MaskedImageFitsReader.cc.
std::string lsst::afw::image::MaskedImageFitsReader::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 66 of file MaskedImageFitsReader.cc.
std::shared_ptr< daf::base::PropertyList > lsst::afw::image::MaskedImageFitsReader::readImageMetadata | ( | ) |
Read the FITS header of one of the HDUs.
Definition at line 106 of file MaskedImageFitsReader.cc.
template Mask< MaskPixel > lsst::afw::image::MaskedImageFitsReader::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 144 of file MaskedImageFitsReader.cc.
template ndarray::Array< MaskPixel, 2, 2 > lsst::afw::image::MaskedImageFitsReader::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 150 of file MaskedImageFitsReader.cc.
std::string lsst::afw::image::MaskedImageFitsReader::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 68 of file MaskedImageFitsReader.cc.
std::shared_ptr< daf::base::PropertyList > lsst::afw::image::MaskedImageFitsReader::readMaskMetadata | ( | ) |
Read the FITS header of one of the HDUs.
Definition at line 114 of file MaskedImageFitsReader.cc.
std::shared_ptr< daf::base::PropertyList > lsst::afw::image::MaskedImageFitsReader::readPrimaryMetadata | ( | ) |
Read the FITS header of one of the HDUs.
Definition at line 100 of file MaskedImageFitsReader.cc.
template Image< VariancePixel > lsst::afw::image::MaskedImageFitsReader::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 157 of file MaskedImageFitsReader.cc.
template ndarray::Array< VariancePixel, 2, 2 > lsst::afw::image::MaskedImageFitsReader::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 163 of file MaskedImageFitsReader.cc.
std::string lsst::afw::image::MaskedImageFitsReader::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 70 of file MaskedImageFitsReader.cc.
std::shared_ptr< daf::base::PropertyList > lsst::afw::image::MaskedImageFitsReader::readVarianceMetadata | ( | ) |
Read the FITS header of one of the HDUs.
Definition at line 122 of file MaskedImageFitsReader.cc.
lsst::geom::Point2I lsst::afw::image::MaskedImageFitsReader::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 box (default) to use the whole image. |
origin | Coordinate system convention for the given box. Ignored if bbox is empty. |
Definition at line 76 of file MaskedImageFitsReader.cc.
|
friend |
Definition at line 234 of file MaskedImageFitsReader.h.