lsst.afw.fits Namespace Reference

Namespaces
	pickleFits

Classes
class	HeaderIterationFunctor
	An exception thrown when problems are found when reading or writing FITS files. More...
class	MemFileManager
	Lifetime-management for memory that goes into FITS memory files. More...
class	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...

Functions
std::string	makeErrorMessage (std::string const &fileName="", int status=0, std::string const &msg="")
	Return an error message reflecting FITS I/O errors. More...
std::string	makeErrorMessage (std::string const &fileName, int status, boost::format const &msg)
std::string	makeErrorMessage (void *fptr, int status=0, std::string const &msg="")
	Return an error message reflecting FITS I/O errors. More...
std::string	makeErrorMessage (void *fptr, int status, boost::format const &msg)
template<typename T >
int	getBitPix ()
	Return the cfitsio integer BITPIX code for the given data type. More...

Function Documentation

template<typename T >

int lsst::afw::fits::getBitPix

(

)

Return the cfitsio integer BITPIX code for the given data type.

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.

Parameters

[in]	fileName	FITS filename to be included in the error message.
[in]	status	The last status value returned by the cfitsio library; if nonzero, the error message will include a description from cfitsio.
[in]	msg	An additional custom message to include.

std::string lsst::afw::fits::makeErrorMessage ( std::string const &  fileName, int  status, boost::format const &  msg  )

inline

Definition at line 69 of file fits.h.

                                                                                                   {
    return makeErrorMessage(fileName, status, msg.str());
}

std::string lsst::afw::fits::makeErrorMessage	(	void *	fptr,
		int	status = 0,
		std::string const &	msg = ""
	)

Return an error message reflecting FITS I/O errors.

Parameters

[in]	fptr	A cfitsio fitsfile pointer to be inspected for a filename. Passed as void* to avoid including fitsio.h in the header file.
[in]	status	The last status value returned by the cfitsio library; if nonzero, the error message will include a description from cfitsio.
[in]	msg	An additional custom message to include.

std::string lsst::afw::fits::makeErrorMessage ( void *  fptr, int  status, boost::format const &  msg  )

inline

Definition at line 83 of file fits.h.

                                                                                    {
    return makeErrorMessage(fptr, status, msg.str());
}