LSST Applications g044012fb7c+304891ab8a,g04a91732dc+4e1b87f259,g07dc498a13+f701f15b83,g114c6a66ad+c7887c1284,g1409bbee79+f701f15b83,g1a7e361dbc+f701f15b83,g1fd858c14a+6ebd102b59,g35bb328faa+0eb18584fe,g3bd4b5ce2c+e83bf4edc8,g4e0f332c67+976ceb6bc8,g53246c7159+0eb18584fe,g5477a8d5ce+51234355ef,g60b5630c4e+c7887c1284,g623d845a50+c7887c1284,g6f0c2978f1+98123c34b6,g71fabbc107+c7887c1284,g75b6c65c88+ce466f4385,g78460c75b0+85633614c8,g786e29fd12+02b9b86fc9,g8852436030+cfe5cf5b7b,g89139ef638+f701f15b83,g9125e01d80+0eb18584fe,g95236ca021+d4f98599f0,g974caa22f6+0eb18584fe,g989de1cb63+f701f15b83,g9f33ca652e+b4908f5dcd,gaaedd4e678+f701f15b83,gabe3b4be73+543c3c03c9,gace736f484+07e57cea59,gb1101e3267+487fd1b06d,gb58c049af0+492386d360,gc99c83e5f0+a513197d39,gcf25f946ba+cfe5cf5b7b,gd0fa69b896+babbe6e5fe,gd6cbbdb0b4+3fef02d88a,gde0f65d7ad+e8379653a2,ge278dab8ac+ae64226a64,gfba249425e+0eb18584fe,w.2025.07
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. | |
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 | |
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. | |
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.