LSST Applications
21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
|
A FITS reader class for regular Images. More...
#include <ImageFitsReader.h>
Public Member Functions | |
template<typename PixelT > | |
Image< PixelT > | read (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false) |
Read the Image. More... | |
ImageBaseFitsReader (std::string const &fileName, int hdu=fits::DEFAULT_HDU) | |
Construct a FITS reader object. More... | |
ImageBaseFitsReader (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU) | |
Construct a FITS reader object. More... | |
ImageBaseFitsReader (fits::Fits *fitsFile) | |
Construct a FITS reader object. More... | |
ImageBaseFitsReader (ImageBaseFitsReader const &)=delete | |
ImageBaseFitsReader (ImageBaseFitsReader &&)=delete | |
std::string | readDType () const |
Read a string describing the pixel type of the on-disk image. More... | |
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::PropertyList > | readMetadata () |
Read the image's FITS header. More... | |
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. More... | |
int | getHdu () const noexcept |
Return the HDU this reader targets. More... | |
std::string | getFileName () const |
Return the name of the file this reader targets. More... | |
A FITS reader class for regular Images.
Definition at line 39 of file ImageFitsReader.h.
|
inlineinherited |
Return the name of the file this reader targets.
Definition at line 141 of file ImageBaseFitsReader.h.
|
inlinenoexceptinherited |
Return the HDU this reader targets.
Definition at line 136 of file ImageBaseFitsReader.h.
|
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 74 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 66 of file ImageBaseFitsReader.cc.
|
delete |
|
delete |
|
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 57 of file ImageBaseFitsReader.cc.
template Image< std::uint64_t > lsst::afw::image::ImageFitsReader::read | ( | lsst::geom::Box2I const & | bbox = lsst::geom::Box2I() , |
ImageOrigin | origin = PARENT , |
||
bool | allowUnsafe = false |
||
) |
Read the Image.
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 27 of file ImageFitsReader.cc.
|
inherited |
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.
|
inherited |
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.
|
inherited |
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.
|
inherited |
Read the image's FITS header.
Definition at line 105 of file ImageBaseFitsReader.cc.
|
inherited |
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.