lsst.afw g4e8c878dce+b648b522b0
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
lsst::afw::image::MaskedImageFitsReader Class Referencefinal

A FITS reader class for MaskedImages and their components. More...

#include <MaskedImageFitsReader.h>

Public Member Functions

 MaskedImageFitsReader (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Construct a FITS reader object. More...
 
 MaskedImageFitsReader (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Construct a FITS reader object. More...
 
 MaskedImageFitsReader (fits::Fits *fitsFile)
 Construct a FITS reader object. More...
 
 MaskedImageFitsReader (MaskedImageFitsReader const &)=delete
 
 MaskedImageFitsReader (MaskedImageFitsReader &&)=delete
 
MaskedImageFitsReaderoperator= (MaskedImageFitsReader const &)=delete
 
MaskedImageFitsReaderoperator= (MaskedImageFitsReader &&)=delete
 
 ~MaskedImageFitsReader () noexcept
 
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...
 
template<typename MaskPixelT >
Mask< MaskPixelT > readMask (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool allowUnsafe=false)
 Read the mask plane. More...
 
template<typename MaskPixelT >
ndarray::Array< MaskPixelT, 2, 2 > readMaskArray (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
 Read the mask plane. More...
 
template<typename ImagePixelT , typename MaskPixelT = MaskPixel, typename VariancePixelT = VariancePixel>
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > read (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool needAllHdus=false, bool allowUnsafe=false)
 Read the full MaskedImage. More...
 
std::string getFileName () const
 Return the name of the file this reader targets. More...
 
std::string readImageDType () const
 Read a string describing the pixel type of the on-disk image plane. More...
 
std::string readMaskDType () const
 Read a string describing the pixel type of the on-disk image plane. More...
 
std::string readVarianceDType () const
 Read a string describing the pixel type of the on-disk image plane. More...
 
std::shared_ptr< daf::base::PropertyListreadPrimaryMetadata ()
 Read the FITS header of one of the HDUs. More...
 
std::shared_ptr< daf::base::PropertyListreadImageMetadata ()
 Read the FITS header of one of the HDUs. More...
 
std::shared_ptr< daf::base::PropertyListreadMaskMetadata ()
 Read the FITS header of one of the HDUs. More...
 
std::shared_ptr< daf::base::PropertyListreadVarianceMetadata ()
 Read the FITS header of one of the HDUs. More...
 
template<typename ImagePixelT >
Image< ImagePixelT > readImage (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
 Read the image plane. More...
 
template<typename ImagePixelT >
ndarray::Array< ImagePixelT, 2, 2 > readImageArray (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
 Read the image plane. More...
 
template<typename VariancePixelT >
Image< VariancePixelT > readVariance (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
 Read the variance plane. More...
 
template<typename VariancePixelT >
ndarray::Array< VariancePixelT, 2, 2 > readVarianceArray (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
 Read the variance plane. More...
 

Friends

class ExposureFitsReader
 

Detailed Description

A FITS reader class for MaskedImages and their components.

Exception Safety
All MaskedImageFitsReader methods provide strong exception safety, but exceptions thrown by the internal fits::Fits object itself may change its status variable or HDU pointer; MaskedImageFitsReader guards against this by resetting those before any use of the Fits object.

Definition at line 41 of file MaskedImageFitsReader.h.

Constructor & Destructor Documentation

◆ MaskedImageFitsReader() [1/5]

lsst::afw::image::MaskedImageFitsReader::MaskedImageFitsReader ( std::string const &  fileName,
int  hdu = fits::DEFAULT_HDU 
)
explicit

Construct a FITS reader object.

Parameters
fileNameName of a file to open.
hduHDU index for the image plane, where 0 is the primary HDU and DEFAULT_HDU is the first non-empty HDU.

Definition at line 46 of file MaskedImageFitsReader.cc.

◆ MaskedImageFitsReader() [2/5]

lsst::afw::image::MaskedImageFitsReader::MaskedImageFitsReader ( fits::MemFileManager manager,
int  hdu = fits::DEFAULT_HDU 
)
explicit

Construct a FITS reader object.

Parameters
managerMemory block containing a FITS file.
hduHDU index for the image plane, where 0 is the primary HDU and DEFAULT_HDU is the first non-empty HDU.

Definition at line 52 of file MaskedImageFitsReader.cc.

◆ MaskedImageFitsReader() [3/5]

lsst::afw::image::MaskedImageFitsReader::MaskedImageFitsReader ( fits::Fits fitsFile)
explicit

Construct a FITS reader object.

Parameters
fitsFilePointer to a CFITSIO file object. Lifetime will not be managed by the Reader object.

Definition at line 58 of file MaskedImageFitsReader.cc.

◆ MaskedImageFitsReader() [4/5]

lsst::afw::image::MaskedImageFitsReader::MaskedImageFitsReader ( MaskedImageFitsReader const &  )
delete

◆ MaskedImageFitsReader() [5/5]

lsst::afw::image::MaskedImageFitsReader::MaskedImageFitsReader ( MaskedImageFitsReader &&  )
delete

◆ ~MaskedImageFitsReader()

lsst::afw::image::MaskedImageFitsReader::~MaskedImageFitsReader ( )
defaultnoexcept

Member Function Documentation

◆ getFileName()

std::string lsst::afw::image::MaskedImageFitsReader::getFileName ( ) const
inline

Return the name of the file this reader targets.

Definition at line 230 of file MaskedImageFitsReader.h.

◆ operator=() [1/2]

MaskedImageFitsReader & lsst::afw::image::MaskedImageFitsReader::operator= ( MaskedImageFitsReader &&  )
delete

◆ operator=() [2/2]

MaskedImageFitsReader & lsst::afw::image::MaskedImageFitsReader::operator= ( MaskedImageFitsReader const &  )
delete

◆ read()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >
template MaskedImage< std::uint64_t, MaskPixel, VariancePixel > lsst::afw::image::MaskedImageFitsReader::read ( lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT,
bool  conformMasks = false,
bool  needAllHdus = false,
bool  allowUnsafe = false 
)

Read the full MaskedImage.

Parameters
bboxA bounding box used to defined a subimage, or an empty box (default) to read the whole image.
originCoordinate system convention for the given box.
conformMasksIf True, conform the global mask dict to match this file.
needAllHdusIf True, refuse to read the image if the mask or variance plane is not present (the image plane is always required).
allowUnsafePermit 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 (for the image plane). This defaults to the type of the on-disk image.

Definition at line 170 of file MaskedImageFitsReader.cc.

◆ readBBox()

lsst::geom::Box2I lsst::afw::image::MaskedImageFitsReader::readBBox ( ImageOrigin  origin = PARENT)

Read the bounding box of the on-disk image.

Parameters
originCoordinate system convention for the returned box. If LOCAL, the returned box will always have a minimum of (0, 0).

Definition at line 72 of file MaskedImageFitsReader.cc.

◆ readImage()

template<typename ImagePixelT >
template Image< std::uint64_t > lsst::afw::image::MaskedImageFitsReader::readImage ( lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT,
bool  allowUnsafe = false 
)

Read the image plane.

Parameters
bboxA bounding box used to defined a subimage, or an empty box (default) to read the whole image.
originCoordinate system convention for the given box.
allowUnsafePermit 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 131 of file MaskedImageFitsReader.cc.

◆ readImageArray()

template<typename ImagePixelT >
template ndarray::Array< std::uint64_t, 2, 2 > lsst::afw::image::MaskedImageFitsReader::readImageArray ( lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT,
bool  allowUnsafe = false 
)

Read the image plane.

Parameters
bboxA bounding box used to defined a subimage, or an empty box (default) to read the whole image.
originCoordinate system convention for the given box.
allowUnsafePermit 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 137 of file MaskedImageFitsReader.cc.

◆ readImageDType()

std::string lsst::afw::image::MaskedImageFitsReader::readImageDType ( ) const

Read a string describing the pixel type of the on-disk image plane.

Returns
A string of the form [u](int|float)<bits> (e.g. "uint16", "float64").

Definition at line 66 of file MaskedImageFitsReader.cc.

◆ readImageMetadata()

std::shared_ptr< daf::base::PropertyList > lsst::afw::image::MaskedImageFitsReader::readImageMetadata ( )

Read the FITS header of one of the HDUs.

Definition at line 106 of file MaskedImageFitsReader.cc.

◆ readMask()

template<typename MaskPixelT >
template Mask< MaskPixel > lsst::afw::image::MaskedImageFitsReader::readMask ( lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT,
bool  conformMasks = false,
bool  allowUnsafe = false 
)

Read the mask plane.

Parameters
bboxA bounding box used to defined a subimage, or an empty box (default) to read the whole image.
originCoordinate system convention for the given box.
conformMasksIf True, conform the global mask dict to match this file.
allowUnsafePermit 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 144 of file MaskedImageFitsReader.cc.

◆ readMaskArray()

template<typename MaskPixelT >
template ndarray::Array< MaskPixel, 2, 2 > lsst::afw::image::MaskedImageFitsReader::readMaskArray ( lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT,
bool  allowUnsafe = false 
)

Read the mask plane.

Parameters
bboxA bounding box used to defined a subimage, or an empty box (default) to read the whole image.
originCoordinate system convention for the given box.
allowUnsafePermit 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 150 of file MaskedImageFitsReader.cc.

◆ readMaskDType()

std::string lsst::afw::image::MaskedImageFitsReader::readMaskDType ( ) const

Read a string describing the pixel type of the on-disk image plane.

Returns
A string of the form [u](int|float)<bits> (e.g. "uint16", "float64").

Definition at line 68 of file MaskedImageFitsReader.cc.

◆ readMaskMetadata()

std::shared_ptr< daf::base::PropertyList > lsst::afw::image::MaskedImageFitsReader::readMaskMetadata ( )

Read the FITS header of one of the HDUs.

Definition at line 114 of file MaskedImageFitsReader.cc.

◆ readPrimaryMetadata()

std::shared_ptr< daf::base::PropertyList > lsst::afw::image::MaskedImageFitsReader::readPrimaryMetadata ( )

Read the FITS header of one of the HDUs.

Definition at line 100 of file MaskedImageFitsReader.cc.

◆ readVariance()

template<typename VariancePixelT >
template Image< VariancePixel > lsst::afw::image::MaskedImageFitsReader::readVariance ( lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT,
bool  allowUnsafe = false 
)

Read the variance plane.

Parameters
bboxA bounding box used to defined a subimage, or an empty box (default) to read the whole image.
originCoordinate system convention for the given box.
allowUnsafePermit 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 157 of file MaskedImageFitsReader.cc.

◆ readVarianceArray()

template<typename VariancePixelT >
template ndarray::Array< VariancePixel, 2, 2 > lsst::afw::image::MaskedImageFitsReader::readVarianceArray ( lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT,
bool  allowUnsafe = false 
)

Read the variance plane.

Parameters
bboxA bounding box used to defined a subimage, or an empty box (default) to read the whole image.
originCoordinate system convention for the given box.
allowUnsafePermit 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 163 of file MaskedImageFitsReader.cc.

◆ readVarianceDType()

std::string lsst::afw::image::MaskedImageFitsReader::readVarianceDType ( ) const

Read a string describing the pixel type of the on-disk image plane.

Returns
A string of the form [u](int|float)<bits> (e.g. "uint16", "float64").

Definition at line 70 of file MaskedImageFitsReader.cc.

◆ readVarianceMetadata()

std::shared_ptr< daf::base::PropertyList > lsst::afw::image::MaskedImageFitsReader::readVarianceMetadata ( )

Read the FITS header of one of the HDUs.

Definition at line 122 of file MaskedImageFitsReader.cc.

◆ readXY0()

lsst::geom::Point2I lsst::afw::image::MaskedImageFitsReader::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.

Parameters
bboxA bounding box used to defined a subimage, or an empty box (default) to use the whole image.
originCoordinate system convention for the given box. Ignored if bbox is empty.

Definition at line 76 of file MaskedImageFitsReader.cc.

Friends And Related Function Documentation

◆ ExposureFitsReader

friend class ExposureFitsReader
friend

Definition at line 234 of file MaskedImageFitsReader.h.


The documentation for this class was generated from the following files: