LSST Applications g0265f82a02+0e5473021a,g02d81e74bb+0dd8ce4237,g1470d8bcf6+3ea6592b6f,g2079a07aa2+86d27d4dc4,g2305ad1205+5ca4c0b359,g295015adf3+d10818ec9d,g2a9a014e59+6f9be1b9cd,g2bbee38e9b+0e5473021a,g337abbeb29+0e5473021a,g3ddfee87b4+703ba97ebf,g487adcacf7+4fa16da234,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+ffa42b374e,g5a732f18d5+53520f316c,g64a986408d+0dd8ce4237,g858d7b2824+0dd8ce4237,g8a8a8dda67+585e252eca,g99cad8db69+d39438377f,g9ddcbc5298+9a081db1e4,ga1e77700b3+15fc3df1f7,ga8c6da7877+f1d96605c8,gb0e22166c9+60f28cb32d,gb6a65358fc+0e5473021a,gba4ed39666+c2a2e4ac27,gbb8dafda3b+e5339d463f,gc120e1dc64+da31e9920e,gc28159a63d+0e5473021a,gcf0d15dbbd+703ba97ebf,gdaeeff99f8+f9a426f77a,ge6526c86ff+889fc9d533,ge79ae78c31+0e5473021a,gee10cc3b42+585e252eca,gf18bd8381d+7268b93478,gff1a9f87cc+0dd8ce4237,w.2024.16
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.