LSSTApplications  20.0.0
LSSTDataManagementBasePackage
Classes | Namespaces | Macros | Functions
fits.h File Reference
#include <climits>
#include <string>
#include <set>
#include <boost/format.hpp>
#include "lsst/base.h"
#include "lsst/pex/exceptions.h"
#include "lsst/daf/base.h"
#include "ndarray.h"
#include "lsst/afw/fitsCompression.h"
#include "lsst/afw/fitsDefaults.h"

Go to the source code of this file.

Classes

class  lsst::afw::fits::FitsError
 An exception thrown when problems are found when reading or writing FITS files. More...
 
class  lsst::afw::fits::FitsTypeError
 An exception thrown when a FITS file has the wrong type. More...
 
class  lsst::afw::fits::HeaderIterationFunctor
 Base class for polymorphic functors used to iterator over FITS key headers. More...
 
class  lsst::afw::fits::MemFileManager
 Lifetime-management for memory that goes into FITS memory files. More...
 
struct  lsst::afw::fits::ImageWriteOptions
 Options for writing an image to FITS. More...
 
class  lsst::afw::fits::Fits
 A simple struct that combines the two arguments that must be passed to most cfitsio routines and contains thin and/or templated wrappers around common cfitsio routines. More...
 
class  lsst::afw::fits::HduMoveGuard
 RAII scoped guard for moving the HDU in a Fits object. More...
 

Namespaces

 lsst
 A base class for image defects.
 
 lsst::afw
 
 lsst::afw::fits
 

Macros

#define LSST_FITS_EXCEPT(type, fitsObj, ...)   type(LSST_EXCEPT_HERE, lsst::afw::fits::makeErrorMessage((fitsObj).fptr, (fitsObj).status, __VA_ARGS__))
 A FITS-related replacement for LSST_EXCEPT that takes an additional Fits object and uses makeErrorMessage(fitsObj.fptr, fitsObj.status, ...) to construct the message. More...
 
#define LSST_FITS_CHECK_STATUS(fitsObj, ...)   if ((fitsObj).status != 0) throw LSST_FITS_EXCEPT(lsst::afw::fits::FitsError, fitsObj, __VA_ARGS__)
 Throw a FitsError exception if the status of the given Fits object is nonzero. More...
 

Functions

std::string lsst::afw::fits::makeErrorMessage (std::string const &fileName="", int status=0, std::string const &msg="")
 Return an error message reflecting FITS I/O errors. More...
 
std::string lsst::afw::fits::makeErrorMessage (std::string const &fileName, int status, boost::format const &msg)
 
std::string lsst::afw::fits::makeErrorMessage (void *fptr, int status=0, std::string const &msg="")
 Return an error message reflecting FITS I/O errors. More...
 
std::string lsst::afw::fits::makeErrorMessage (void *fptr, int status, boost::format const &msg)
 
std::string lsst::afw::fits::makeLimitedFitsHeader (lsst::daf::base::PropertySet const &metadata, std::set< std::string > const &excludeNames={})
 Format a PropertySet into an FITS header string in a simplistic fashion. More...
 
template<typename T >
int lsst::afw::fits::getBitPix ()
 Return the cfitsio integer BITPIX code for the given data type. More...
 
template<typename T , int N, int C>
ndarray::Array< T const, N, N > const lsst::afw::fits::makeContiguousArray (ndarray::Array< T, N, C > const &array)
 Construct a contiguous ndarray. More...
 
std::shared_ptr< daf::base::PropertyList > lsst::afw::fits::combineMetadata (std::shared_ptr< const daf::base::PropertyList > first, std::shared_ptr< const daf::base::PropertyList > second)
 Combine two sets of metadata in a FITS-appropriate fashion. More...
 
std::shared_ptr< daf::base::PropertyList > lsst::afw::fits::readMetadata (std::string const &fileName, int hdu=DEFAULT_HDU, bool strip=false)
 Read FITS header. More...
 
std::shared_ptr< daf::base::PropertyList > lsst::afw::fits::readMetadata (fits::MemFileManager &manager, int hdu=DEFAULT_HDU, bool strip=false)
 Read FITS header. More...
 
std::shared_ptr< daf::base::PropertyList > lsst::afw::fits::readMetadata (fits::Fits &fitsfile, bool strip=false)
 Read FITS header. More...
 
void lsst::afw::fits::setAllowImageCompression (bool allow)
 
bool lsst::afw::fits::getAllowImageCompression ()
 

Macro Definition Documentation

◆ LSST_FITS_CHECK_STATUS

#define LSST_FITS_CHECK_STATUS (   fitsObj,
  ... 
)    if ((fitsObj).status != 0) throw LSST_FITS_EXCEPT(lsst::afw::fits::FitsError, fitsObj, __VA_ARGS__)

Throw a FitsError exception if the status of the given Fits object is nonzero.

Definition at line 112 of file fits.h.

◆ LSST_FITS_EXCEPT

#define LSST_FITS_EXCEPT (   type,
  fitsObj,
  ... 
)    type(LSST_EXCEPT_HERE, lsst::afw::fits::makeErrorMessage((fitsObj).fptr, (fitsObj).status, __VA_ARGS__))

A FITS-related replacement for LSST_EXCEPT that takes an additional Fits object and uses makeErrorMessage(fitsObj.fptr, fitsObj.status, ...) to construct the message.

Definition at line 106 of file fits.h.