A FITS reader class for Masks.
More...
#include <MaskFitsReader.h>
|
| template<typename PixelT > |
| Mask< PixelT > | read (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool allowUnsafe=false) |
| | Read the Mask. 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 Masks.
- Exception Safety
- All MaskFitsReader methods provide strong exception safety, but exceptions thrown by the internal fits::Fits object itself may change its status variable or HDU pointer; MaskFitsReader guards against this by resetting those before any use of the Fits object.
Definition at line 39 of file MaskFitsReader.h.
◆ getFileName()
| std::string lsst::afw::image::ImageBaseFitsReader::getFileName |
( |
| ) |
const |
|
inlineinherited |
◆ getHdu()
| int lsst::afw::image::ImageBaseFitsReader::getHdu |
( |
| ) |
const |
|
inlinenoexceptinherited |
◆ ImageBaseFitsReader() [1/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 74 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 66 of file ImageBaseFitsReader.cc.
◆ ImageBaseFitsReader() [3/5]
◆ ImageBaseFitsReader() [4/5]
◆ ImageBaseFitsReader() [5/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 57 of file ImageBaseFitsReader.cc.
◆ read()
template<typename PixelT >
Read the Mask.
- 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. |
| conformMasks | If True, conform the global mask dict to match this file. |
| 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 28 of file MaskFitsReader.cc.
◆ 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 |
|
inherited |
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.
The documentation for this class was generated from the following files: