Base class for image FITS readers.
More...
#include <ImageBaseFitsReader.h>
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.
- Exception Safety
- All ImageBaseFitsReader methods provide strong exception safety, but exceptions thrown by the internal fits::Fits object itself may change its status variable or HDU pointer; ImageBaseFitsReader guards against this by resetting those before any use of the Fits object.
Definition at line 47 of file ImageBaseFitsReader.h.
◆ ImageBaseFitsReader() [1/5]
Construct a FITS reader object.
- Parameters
-
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.
◆ ImageBaseFitsReader() [2/5]
Construct a FITS reader object.
- Parameters
-
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.
◆ ImageBaseFitsReader() [3/5]
lsst::afw::image::ImageBaseFitsReader::ImageBaseFitsReader |
( |
fits::Fits * | fitsFile | ) |
|
|
explicit |
Construct a FITS reader object.
- Parameters
-
fitsFile | Pointer to a CFITSIO file object. Lifetime will not be managed by the Reader object. |
Definition at line 47 of file ImageBaseFitsReader.cc.
◆ ImageBaseFitsReader() [4/5]
◆ ImageBaseFitsReader() [5/5]
◆ ~ImageBaseFitsReader()
lsst::afw::image::ImageBaseFitsReader::~ImageBaseFitsReader |
( |
| ) |
|
|
protectednoexcept |
◆ getFileName()
std::string lsst::afw::image::ImageBaseFitsReader::getFileName |
( |
| ) |
const |
|
inline |
◆ getHdu()
int lsst::afw::image::ImageBaseFitsReader::getHdu |
( |
| ) |
const |
|
inlinenoexcept |
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ readArray()
Read the image's data array.
- Parameters
-
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.
◆ readBBox()
Read the bounding box of the on-disk image.
- Parameters
-
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.
◆ readDType()
std::string lsst::afw::image::ImageBaseFitsReader::readDType |
( |
| ) |
const |
Read a string describing the pixel type of the on-disk image.
- Returns
- A string of the form
[u](int|float)<bits>
(e.g. "uint16", "float64").
Definition at line 80 of file ImageBaseFitsReader.cc.
◆ readMetadata()
◆ readXY0()
Read the image origin from the on-disk image or a subimage thereof.
- Parameters
-
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.
◆ MaskedImageFitsReader
The documentation for this class was generated from the following files: