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...
boost::shared_ptr < daf::base::PropertyList >	readMetadata (std::string const &fileName, int hdu=0, bool strip=false)
	Read FITS header. More...
boost::shared_ptr < daf::base::PropertyList >	readMetadata (fits::MemFileManager &manager, int hdu=0, bool strip=false)
	Read FITS header. More...
boost::shared_ptr < daf::base::PropertyList >	readMetadata (fits::Fits &fitsfile, bool strip=false)
	Read FITS header. 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());
}

boost::shared_ptr< daf::base::PropertyList > lsst::afw::fits::readMetadata ( std::string const &  fileName, int  hdu = 0, bool  strip = false  )

inline

Read FITS header.

If 'strip' is true, common FITS keys that usually have non-metadata intepretations (e.g. NAXIS, BITPIX) will be ignored.

Includes support for the INHERIT convention: if 'INHERIT = T' is in the header, the PHU will be read as well, and nominated HDU will override any duplicated values.

Read FITS header.

Deprecated:

Use lsst::afw::fits::readMetadata instead.

Parameters

[in]	fileName	File to read.
[in]	hdu	HDU to read, 1-indexed. The special value of 0 will read the first non-empty HDU.
[in]	strip	If true, ignore special header keys usually managed by cfitsio (e.g. NAXIS).

Definition at line 62 of file Utils.h.

                                                                                                      {
    return afw::fits::readMetadata(fileName, hdu, strip);
}

boost::shared_ptr< daf::base::PropertyList > lsst::afw::fits::readMetadata	(	fits::MemFileManager &	manager,
		int	hdu = 0,
		bool	strip = false
	)

Read FITS header.

If 'strip' is true, common FITS keys that usually have non-metadata intepretations (e.g. NAXIS, BITPIX) will be ignored.

Includes support for the INHERIT convention: if 'INHERIT = T' is in the header, the PHU will be read as well, and nominated HDU will override any duplicated values.

Read FITS header.

Deprecated:

Use lsst::afw::fits::readMetadata instead.

Parameters

[in]	fileName	File to read.
[in]	hdu	HDU to read, 1-indexed. The special value of 0 will read the first non-empty HDU.
[in]	strip	If true, ignore special header keys usually managed by cfitsio (e.g. NAXIS).

boost::shared_ptr< daf::base::PropertyList > lsst::afw::fits::readMetadata	(	fits::Fits &	fitsfile,
		bool	strip = false
	)

Read FITS header.

If 'strip' is true, common FITS keys that usually have non-metadata intepretations (e.g. NAXIS, BITPIX) will be ignored.

Includes support for the INHERIT convention: if 'INHERIT = T' is in the header, the PHU will be read as well, and nominated HDU will override any duplicated values.

Read FITS header.

Deprecated:

Use lsst::afw::fits::readMetadata instead.

Parameters

[in]	fileName	File to read.
[in]	hdu	HDU to read, 1-indexed. The special value of 0 will read the first non-empty HDU.
[in]	strip	If true, ignore special header keys usually managed by cfitsio (e.g. NAXIS).