lsst.afw 22.0.1-48-g5c39d4753+955d02b84f
Classes | Public Member Functions | List of all members
lsst::afw::image::ExposureFitsReader Class Reference

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

#include <ExposureFitsReader.h>

Classes

class  ArchiveReader
 
class  MetadataReader
 

Public Member Functions

 ExposureFitsReader (std::string const &fileName)
 Construct a FITS reader object. More...
 
 ExposureFitsReader (fits::MemFileManager &manager)
 Construct a FITS reader object. More...
 
 ExposureFitsReader (fits::Fits *fitsFile)
 Construct a FITS reader object. More...
 
 ExposureFitsReader (ExposureFitsReader const &)=delete
 
 ExposureFitsReader (ExposureFitsReader &&)=delete
 
ExposureFitsReaderoperator= (ExposureFitsReader const &)=delete
 
ExposureFitsReaderoperator= (ExposureFitsReader &&)=delete
 
 ~ExposureFitsReader () 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...
 
int readSerializationVersion ()
 Read the serialization version number from the header. More...
 
std::shared_ptr< daf::base::PropertyListreadMetadata ()
 Read the flexible metadata associated with the Exposure. More...
 
std::optional< table::RecordIdreadExposureId ()
 Read the Exposure's exposure ID, if it exists. More...
 
std::shared_ptr< afw::geom::SkyWcsreadWcs ()
 Read the Exposure's world coordinate system. More...
 
Filter readFilter ()
 Read the Exposure's filter. More...
 
std::shared_ptr< FilterLabelreadFilterLabel ()
 Read the Exposure's filter information. More...
 
std::shared_ptr< PhotoCalibreadPhotoCalib ()
 Read the Exposure's photometric calibration. More...
 
std::shared_ptr< detection::PsfreadPsf ()
 Read the Exposure's point-spread function. More...
 
std::shared_ptr< afw::geom::polygon::PolygonreadValidPolygon ()
 Read the polygon describing the region of validity for the Exposure. More...
 
std::shared_ptr< ApCorrMapreadApCorrMap ()
 Read the Exposure's aperture correction map. More...
 
std::shared_ptr< CoaddInputsreadCoaddInputs ()
 Read the Exposure's coadd input catalogs. More...
 
std::shared_ptr< VisitInforeadVisitInfo ()
 Read the Exposure's visit metadata. More...
 
std::shared_ptr< TransmissionCurvereadTransmissionCurve ()
 Read the Exposure's transmission curve. More...
 
std::shared_ptr< cameraGeom::DetectorreadDetector ()
 Read the Exposure's detector. More...
 
std::shared_ptr< typehandling::StorablereadComponent (std::string const &componentName)
 Read an arbitrary non-standard component by name. More...
 
std::map< std::string, std::shared_ptr< table::io::Persistable > > readExtraComponents ()
 Read the Exposure's non-standard components. More...
 
std::shared_ptr< ExposureInforeadExposureInfo ()
 Read the ExposureInfo containing all non-image components. 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 > readMaskedImage (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool allowUnsafe=false)
 Read the MaskedImage. More...
 
template<typename ImagePixelT , typename MaskPixelT = MaskPixel, typename VariancePixelT = VariancePixel>
Exposure< ImagePixelT, MaskPixelT, VariancePixelT > read (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool allowUnsafe=false)
 Read the full Exposure. 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...
 
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...
 

Detailed Description

A FITS reader class for Exposures and their components.

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

Definition at line 44 of file ExposureFitsReader.h.

Constructor & Destructor Documentation

◆ ExposureFitsReader() [1/5]

lsst::afw::image::ExposureFitsReader::ExposureFitsReader ( std::string const &  fileName)
explicit

Construct a FITS reader object.

Parameters
fileNameName of a file to open.

Definition at line 490 of file ExposureFitsReader.cc.

◆ ExposureFitsReader() [2/5]

lsst::afw::image::ExposureFitsReader::ExposureFitsReader ( fits::MemFileManager manager)
explicit

Construct a FITS reader object.

Parameters
managerMemory block containing a FITS file.

Definition at line 492 of file ExposureFitsReader.cc.

◆ ExposureFitsReader() [3/5]

lsst::afw::image::ExposureFitsReader::ExposureFitsReader ( 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 494 of file ExposureFitsReader.cc.

◆ ExposureFitsReader() [4/5]

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

◆ ExposureFitsReader() [5/5]

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

◆ ~ExposureFitsReader()

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

Member Function Documentation

◆ getFileName()

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

Return the name of the file this reader targets.

Definition at line 294 of file ExposureFitsReader.h.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ read()

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

Read the full Exposure.

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 (for the image plane). This defaults to the type of the on-disk image.

Definition at line 738 of file ExposureFitsReader.cc.

◆ readApCorrMap()

std::shared_ptr< ApCorrMap > lsst::afw::image::ExposureFitsReader::readApCorrMap ( )

Read the Exposure's aperture correction map.

Definition at line 575 of file ExposureFitsReader.cc.

◆ readBBox()

lsst::geom::Box2I lsst::afw::image::ExposureFitsReader::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 498 of file ExposureFitsReader.cc.

◆ readCoaddInputs()

std::shared_ptr< CoaddInputs > lsst::afw::image::ExposureFitsReader::readCoaddInputs ( )

Read the Exposure's coadd input catalogs.

Definition at line 580 of file ExposureFitsReader.cc.

◆ readComponent()

std::shared_ptr< typehandling::Storable > lsst::afw::image::ExposureFitsReader::readComponent ( std::string const &  componentName)

Read an arbitrary non-standard component by name.

Definition at line 601 of file ExposureFitsReader.cc.

◆ readDetector()

std::shared_ptr< cameraGeom::Detector > lsst::afw::image::ExposureFitsReader::readDetector ( )

Read the Exposure's detector.

Definition at line 596 of file ExposureFitsReader.cc.

◆ readExposureId()

std::optional< table::RecordId > lsst::afw::image::ExposureFitsReader::readExposureId ( )

Read the Exposure's exposure ID, if it exists.

Definition at line 522 of file ExposureFitsReader.cc.

◆ readExposureInfo()

std::shared_ptr< ExposureInfo > lsst::afw::image::ExposureFitsReader::readExposureInfo ( )

Read the ExposureInfo containing all non-image components.

Definition at line 611 of file ExposureFitsReader.cc.

◆ readExtraComponents()

std::map< std::string, std::shared_ptr< table::io::Persistable > > lsst::afw::image::ExposureFitsReader::readExtraComponents ( )

Read the Exposure's non-standard components.

Definition at line 606 of file ExposureFitsReader.cc.

◆ readFilter()

Filter lsst::afw::image::ExposureFitsReader::readFilter ( )

Read the Exposure's filter.

Definition at line 536 of file ExposureFitsReader.cc.

◆ readFilterLabel()

std::shared_ptr< FilterLabel > lsst::afw::image::ExposureFitsReader::readFilterLabel ( )

Read the Exposure's filter information.

Definition at line 546 of file ExposureFitsReader.cc.

◆ readImage()

template<typename ImagePixelT >
template Image< std::uint64_t > lsst::afw::image::ExposureFitsReader::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 693 of file ExposureFitsReader.cc.

◆ readImageArray()

template<typename ImagePixelT >
template ndarray::Array< std::uint64_t, 2, 2 > lsst::afw::image::ExposureFitsReader::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 699 of file ExposureFitsReader.cc.

◆ readImageDType()

std::string lsst::afw::image::ExposureFitsReader::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 511 of file ExposureFitsReader.cc.

◆ readMask()

template<typename MaskPixelT >
template Mask< MaskPixel > lsst::afw::image::ExposureFitsReader::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 705 of file ExposureFitsReader.cc.

◆ readMaskArray()

template<typename MaskPixelT >
template ndarray::Array< MaskPixel, 2, 2 > lsst::afw::image::ExposureFitsReader::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 711 of file ExposureFitsReader.cc.

◆ readMaskDType()

std::string lsst::afw::image::ExposureFitsReader::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 513 of file ExposureFitsReader.cc.

◆ readMaskedImage()

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

Read the 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.
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 730 of file ExposureFitsReader.cc.

◆ readMetadata()

std::shared_ptr< daf::base::PropertyList > lsst::afw::image::ExposureFitsReader::readMetadata ( )

Read the flexible metadata associated with the Exposure.

FITS header keys used to construct other Exposure components will be stripped.

Definition at line 517 of file ExposureFitsReader.cc.

◆ readPhotoCalib()

std::shared_ptr< PhotoCalib > lsst::afw::image::ExposureFitsReader::readPhotoCalib ( )

Read the Exposure's photometric calibration.

Definition at line 555 of file ExposureFitsReader.cc.

◆ readPsf()

std::shared_ptr< detection::Psf > lsst::afw::image::ExposureFitsReader::readPsf ( )

Read the Exposure's point-spread function.

Definition at line 564 of file ExposureFitsReader.cc.

◆ readSerializationVersion()

int lsst::afw::image::ExposureFitsReader::readSerializationVersion ( )

Read the serialization version number from the header.

Definition at line 506 of file ExposureFitsReader.cc.

◆ readTransmissionCurve()

std::shared_ptr< TransmissionCurve > lsst::afw::image::ExposureFitsReader::readTransmissionCurve ( )

Read the Exposure's transmission curve.

Definition at line 590 of file ExposureFitsReader.cc.

◆ readValidPolygon()

std::shared_ptr< afw::geom::polygon::Polygon > lsst::afw::image::ExposureFitsReader::readValidPolygon ( )

Read the polygon describing the region of validity for the Exposure.

Definition at line 569 of file ExposureFitsReader.cc.

◆ readVariance()

template<typename VariancePixelT >
template Image< VariancePixel > lsst::afw::image::ExposureFitsReader::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 717 of file ExposureFitsReader.cc.

◆ readVarianceArray()

template<typename VariancePixelT >
template ndarray::Array< VariancePixel, 2, 2 > lsst::afw::image::ExposureFitsReader::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 723 of file ExposureFitsReader.cc.

◆ readVarianceDType()

std::string lsst::afw::image::ExposureFitsReader::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 515 of file ExposureFitsReader.cc.

◆ readVisitInfo()

std::shared_ptr< VisitInfo > lsst::afw::image::ExposureFitsReader::readVisitInfo ( )

Read the Exposure's visit metadata.

Definition at line 585 of file ExposureFitsReader.cc.

◆ readWcs()

std::shared_ptr< afw::geom::SkyWcs > lsst::afw::image::ExposureFitsReader::readWcs ( )

Read the Exposure's world coordinate system.

Definition at line 527 of file ExposureFitsReader.cc.

◆ readXY0()

lsst::geom::Point2I lsst::afw::image::ExposureFitsReader::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
originCoordinate system convention for the given box. Ignored if bbox is empty.

Definition at line 502 of file ExposureFitsReader.cc.


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