fits.cc File Reference

#include <cstdint>
#include <cstdio>
#include <complex>
#include <cmath>
#include <sstream>
#include <unordered_set>
#include <unordered_map>
#include <filesystem>
#include <regex>
#include <cctype>
#include "fitsio.h"
#include "fitsio2.h"
#include "boost/algorithm/string.hpp"
#include "boost/preprocessor/seq/for_each.hpp"
#include "boost/format.hpp"
#include "lsst/pex/exceptions.h"
#include "lsst/log/Log.h"
#include "lsst/afw/fits.h"
#include "lsst/geom/Angle.h"
#include "lsst/afw/geom/wcsUtils.h"
#include "lsst/afw/fitsCompression.h"

Go to the source code of this file.

Namespaces
namespace	lsst
namespace	lsst::afw
namespace	lsst::afw::fits
namespace	lsst::afw::fits::detail

Macros
#define	INSTANTIATE_KEY_OPS(r, data, T)
#define	INSTANTIATE_IMAGE_OPS(r, data, T)
#define	INSTANTIATE_TABLE_OPS(r, data, T)
#define	INSTANTIATE_TABLE_ARRAY_OPS(r, data, T)
#define	KEY_TYPES
#define	COLUMN_TYPES
#define	COLUMN_ARRAY_TYPES
#define	IMAGE_TYPES    (unsigned char)(short)(unsigned short)(int)(unsigned int)(std::int64_t)(std::uint64_t)(float)(double)

Typedefs
using	lsst::afw::fits::dafPlistPtr = std::shared_ptr<daf::base::PropertyList>

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.
std::string	lsst::afw::fits::makeErrorMessage (void *fptr, int status=0, std::string const &msg="")
	Return an error message reflecting FITS I/O errors.
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.
template<typename T >
int	lsst::afw::fits::getBitPix ()
	Return the cfitsio integer BITPIX code for the given data type.
void	lsst::afw::fits::setAllowImageCompression (bool allow)
bool	lsst::afw::fits::getAllowImageCompression ()
std::shared_ptr< daf::base::PropertyList >	lsst::afw::fits::combineMetadata (daf::base::PropertyList const &first, daf::base::PropertyList const &second)
	Combine two sets of metadata in a FITS-appropriate fashion.
template<typename T , typename... Args>
dafPlistPtr	lsst::afw::fits::detail::_readMetadata (T &&fitsparm, bool strip, Args... args)
std::shared_ptr< daf::base::PropertyList >	lsst::afw::fits::readMetadata (std::string const &fileName, int hdu=DEFAULT_HDU, bool strip=false)
	Read FITS header.
std::shared_ptr< daf::base::PropertyList >	lsst::afw::fits::readMetadata (std::string const &fileName, std::string const &hduname, HduType type=HduType::ANY, int hduver=0, bool strip=false)
	Read FITS header.
std::shared_ptr< daf::base::PropertyList >	lsst::afw::fits::readMetadata (fits::MemFileManager &manager, int hdu=DEFAULT_HDU, bool strip=false)
	Read FITS header.
std::shared_ptr< daf::base::PropertyList >	lsst::afw::fits::readMetadata (fits::MemFileManager &manager, std::string const &hduname, HduType type=HduType::ANY, int hduver=0, bool strip=false)
	Read FITS header.
std::shared_ptr< daf::base::PropertyList >	lsst::afw::fits::readMetadata (fits::Fits &fitsfile, bool strip=false)
	Read FITS header.

Macro Definition Documentation

COLUMN_ARRAY_TYPES

#define COLUMN_ARRAY_TYPES

Value:

    (bool)(char)(std::uint8_t)(std::int16_t)(std::uint16_t)(std::int32_t)(std::uint32_t)(std::int64_t)( \
            float)(double)(lsst::geom::Angle)(std::complex<float>)(std::complex<double>)

Definition at line 1891 of file fits.cc.

#define COLUMN_ARRAY_TYPES                                                                              \
    (bool)(char)(std::uint8_t)(std::int16_t)(std::uint16_t)(std::int32_t)(std::uint32_t)(std::int64_t)( \
            float)(double)(lsst::geom::Angle)(std::complex<float>)(std::complex<double>)

COLUMN_TYPES

#define COLUMN_TYPES

Value:

    (bool)(std::string)(std::int8_t)(std::uint8_t)(std::int16_t)(std::uint16_t)(std::int32_t)(std::uint32_t) \
            (std::int64_t)(float)(double)(lsst::geom::Angle)(std::complex<float>)(std::complex<double>)

Definition at line 1887 of file fits.cc.

#define COLUMN_TYPES                                                                             \
    (bool)(std::string)(std::int8_t)(std::uint8_t)(std::int16_t)(std::uint16_t)(std::int32_t)(std::uint32_t) \
            (std::int64_t)(float)(double)(lsst::geom::Angle)(std::complex<float>)(std::complex<double>)

IMAGE_TYPES

#define IMAGE_TYPES    (unsigned char)(short)(unsigned short)(int)(unsigned int)(std::int64_t)(std::uint64_t)(float)(double)

Definition at line 1895 of file fits.cc.

#define IMAGE_TYPES \
    (unsigned char)(short)(unsigned short)(int)(unsigned int)(std::int64_t)(std::uint64_t)(float)(double)

INSTANTIATE_IMAGE_OPS

#define INSTANTIATE_IMAGE_OPS	(		r,
			data,
			T )

Value:

    template void Fits::writeImageImpl(T const *, int);                                    \
    template void Fits::writeImage(image::ImageBase<T> const &, ImageWriteOptions const &, \
                                   daf::base::PropertySet const *,          \
                                   image::Mask<image::MaskPixel> const *);  \
    template void Fits::readImageImpl(int, T *, long *, long *, long *);                   \
    template bool Fits::checkImageType<T>();                                               \
    template int getBitPix<T>();

Definition at line 1863 of file fits.cc.

#define INSTANTIATE_IMAGE_OPS(r, data, T)                                                  \
    template void Fits::writeImageImpl(T const *, int);                                    \
    template void Fits::writeImage(image::ImageBase<T> const &, ImageWriteOptions const &, \
                                   daf::base::PropertySet const *,          \
                                   image::Mask<image::MaskPixel> const *);  \
    template void Fits::readImageImpl(int, T *, long *, long *, long *);                   \
    template bool Fits::checkImageType<T>();                                               \
    template int getBitPix<T>();

INSTANTIATE_KEY_OPS

#define INSTANTIATE_KEY_OPS	(		r,
			data,
			T )

Value:

    template void Fits::updateKey(std::string const &, T const &, std::string const &);            \
    template void Fits::writeKey(std::string const &, T const &, std::string const &);             \
    template void Fits::updateKey(std::string const &, T const &);                                 \
    template void Fits::writeKey(std::string const &, T const &);                                  \
    template void Fits::updateColumnKey(std::string const &, int, T const &, std::string const &); \
    template void Fits::writeColumnKey(std::string const &, int, T const &, std::string const &);  \
    template void Fits::updateColumnKey(std::string const &, int, T const &);                      \
    template void Fits::writeColumnKey(std::string const &, int, T const &);                       \
    template void Fits::readKey(std::string const &, T &);

Definition at line 1852 of file fits.cc.

#define INSTANTIATE_KEY_OPS(r, data, T)                                                            \
    template void Fits::updateKey(std::string const &, T const &, std::string const &);            \
    template void Fits::writeKey(std::string const &, T const &, std::string const &);             \
    template void Fits::updateKey(std::string const &, T const &);                                 \
    template void Fits::writeKey(std::string const &, T const &);                                  \
    template void Fits::updateColumnKey(std::string const &, int, T const &, std::string const &); \
    template void Fits::writeColumnKey(std::string const &, int, T const &, std::string const &);  \
    template void Fits::updateColumnKey(std::string const &, int, T const &);                      \
    template void Fits::writeColumnKey(std::string const &, int, T const &);                       \
    template void Fits::readKey(std::string const &, T &);

INSTANTIATE_TABLE_ARRAY_OPS

#define INSTANTIATE_TABLE_ARRAY_OPS	(		r,
			data,
			T )

Value:

    template void Fits::writeTableArray(std::size_t row, int col, int nElements, T const *value); \
    template void Fits::readTableArray(std::size_t row, int col, int nElements, T *value);

Definition at line 1875 of file fits.cc.

#define INSTANTIATE_TABLE_ARRAY_OPS(r, data, T)                                                   \
    template void Fits::writeTableArray(std::size_t row, int col, int nElements, T const *value); \
    template void Fits::readTableArray(std::size_t row, int col, int nElements, T *value);

INSTANTIATE_TABLE_OPS

#define INSTANTIATE_TABLE_OPS	(		r,
			data,
			T )

Value:

    template int Fits::addColumn<T>(std::string const &ttype, int size); \
    template int Fits::addColumn<T>(std::string const &ttype, int size, std::string const &comment);

Definition at line 1872 of file fits.cc.

#define INSTANTIATE_TABLE_OPS(r, data, T)                                \
    template int Fits::addColumn<T>(std::string const &ttype, int size); \
    template int Fits::addColumn<T>(std::string const &ttype, int size, std::string const &comment);

KEY_TYPES

#define KEY_TYPES

Value:

    (bool)(unsigned char)(short)(unsigned short)(int)(unsigned int)(long)(unsigned long)(LONGLONG)( \
            float)(double)(std::complex<float>)(std::complex<double>)(std::string)

Definition at line 1883 of file fits.cc.

#define KEY_TYPES                                                                                   \
    (bool)(unsigned char)(short)(unsigned short)(int)(unsigned int)(long)(unsigned long)(LONGLONG)( \
            float)(double)(std::complex<float>)(std::complex<double>)(std::string)

Variable Documentation

isComment

bool isComment

Definition at line 403 of file fits.cc.

isValid

bool isValid

Definition at line 404 of file fits.cc.

list

daf::base::PropertyList* list

Definition at line 932 of file fits.cc.

set

daf::base::PropertySet* set

Definition at line 931 of file fits.cc.

strip

bool strip

Definition at line 930 of file fits.cc.