LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
|
Base class for image FITS readers. More...
#include <ImageBaseFitsReader.h>
Public Member Functions | |
ImageBaseFitsReader (std::string const &fileName, int hdu=fits::DEFAULT_HDU) | |
Construct a FITS reader object. | |
ImageBaseFitsReader (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU) | |
Construct a FITS reader object. | |
ImageBaseFitsReader (fits::Fits *fitsFile) | |
Construct a FITS reader object. | |
ImageBaseFitsReader (ImageBaseFitsReader const &)=delete | |
ImageBaseFitsReader (ImageBaseFitsReader &&)=delete | |
ImageBaseFitsReader & | operator= (ImageBaseFitsReader const &)=delete |
ImageBaseFitsReader & | operator= (ImageBaseFitsReader &&)=delete |
std::string | readDType () const |
Read a string describing the pixel type of the on-disk image. | |
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. | |
std::shared_ptr< daf::base::PropertyList > | readMetadata () |
Read the image's FITS header. | |
template<typename T > | |
ndarray::Array< T, 2, 2 > | readArray (lsst::geom::Box2I const &bbox, ImageOrigin origin=PARENT, bool allowUnsafe=false) |
Read the image's data array. | |
int | getHdu () const noexcept |
Return the HDU this reader targets. | |
std::string | getFileName () const |
Return the name of the file this reader targets. | |
Protected Member Functions | |
~ImageBaseFitsReader () noexcept | |
Friends | |
class | MaskedImageFitsReader |
Base class for image FITS readers.
This class should be considered an implementation detail of ImageFitsReader and MaskFitsReader that provides their common methods, not the definition of an interface.
Definition at line 47 of file ImageBaseFitsReader.h.
|
explicit |
Construct a FITS reader object.
fileName | Name of a file to open. |
hdu | HDU index, where 0 is the primary HDU and DEFAULT_HDU is the first non-empty HDU. |
Definition at line 27 of file ImageBaseFitsReader.cc.
|
explicit |
Construct a FITS reader object.
manager | Memory block containing a FITS file. |
hdu | HDU index, where 0 is the primary HDU and DEFAULT_HDU is the first non-empty HDU. |
Definition at line 37 of file ImageBaseFitsReader.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 47 of file ImageBaseFitsReader.cc.
|
delete |
|
delete |
|
protectednoexcept |
Definition at line 61 of file ImageBaseFitsReader.cc.
|
inline |
Return the name of the file this reader targets.
Definition at line 141 of file ImageBaseFitsReader.h.
|
inlinenoexcept |
Return the HDU this reader targets.
Definition at line 136 of file ImageBaseFitsReader.h.
|
delete |
|
delete |
template ndarray::Array< std::uint64_t, 2, 2 > lsst::afw::image::ImageBaseFitsReader::readArray | ( | lsst::geom::Box2I const & | bbox, |
ImageOrigin | origin = PARENT, | ||
bool | allowUnsafe = false ) |
Read the image's data array.
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. |
Definition at line 171 of file ImageBaseFitsReader.cc.
lsst::geom::Box2I lsst::afw::image::ImageBaseFitsReader::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 86 of file ImageBaseFitsReader.cc.
std::string lsst::afw::image::ImageBaseFitsReader::readDType | ( | ) | const |
Read a string describing the pixel type of the on-disk image.
[u](int|float)<bits>
(e.g. "uint16", "float64"). Definition at line 80 of file ImageBaseFitsReader.cc.
std::shared_ptr< daf::base::PropertyList > lsst::afw::image::ImageBaseFitsReader::readMetadata | ( | ) |
Read the image's FITS header.
Definition at line 105 of file ImageBaseFitsReader.cc.
lsst::geom::Point2I lsst::afw::image::ImageBaseFitsReader::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 94 of file ImageBaseFitsReader.cc.
|
friend |
Definition at line 151 of file ImageBaseFitsReader.h.