LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
|
Namespaces | |
namespace | _compression |
namespace | _fitsContinued |
namespace | _pickleFits |
namespace | detail |
Classes | |
struct | Bzero |
Scaling zero-point, set according to pixel type. More... | |
struct | Bzero< std::uint64_t > |
struct | Bzero< T, typename std::enable_if< std::numeric_limits< T >::is_integer &&!std::numeric_limits< T >::is_signed >::type > |
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... | |
class | FitsError |
An exception thrown when problems are found when reading or writing FITS files. More... | |
class | FitsTypeError |
An exception thrown when a FITS file has the wrong type. More... | |
class | HduMoveGuard |
RAII scoped guard for moving the HDU in a Fits object. More... | |
class | HeaderIterationFunctor |
Base class for polymorphic functors used to iterator over FITS key headers. More... | |
struct | ImageCompressionOptions |
Options for tile compression of image pixels. More... | |
struct | ImageScale |
Scale to apply to image. More... | |
class | ImageScalingOptions |
Options for scaling image pixels. More... | |
struct | ImageWriteOptions |
Options for writing an image to FITS. More... | |
class | MemFileManager |
Lifetime-management for memory that goes into FITS memory files. More... | |
Typedefs | |
using | dafPlistPtr = std::shared_ptr<daf::base::PropertyList> |
Enumerations | |
enum class | HduType : int { IMAGE = 0 , ASCII_TABLE = 1 , BIN_TABLE = 2 , ANY = -1 } |
an enum representing the various types of FITS HDU that are available in cfitsio library 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. | |
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. | |
std::string | makeErrorMessage (void *fptr, int status, boost::format const &msg) |
std::string | 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 | getBitPix () |
Return the cfitsio integer BITPIX code for the given data type. | |
template<typename T, int N, int C> | |
ndarray::Array< T const, N, N > const | makeContiguousArray (ndarray::Array< T, N, C > const &array) |
Construct a contiguous ndarray. | |
std::shared_ptr< daf::base::PropertyList > | combineMetadata (daf::base::PropertyList const &first, daf::base::PropertyList const &second) |
Combine two sets of metadata in a FITS-appropriate fashion. | |
std::shared_ptr< daf::base::PropertyList > | readMetadata (std::string const &fileName, int hdu=DEFAULT_HDU, bool strip=false) |
Read FITS header. | |
std::shared_ptr< daf::base::PropertyList > | 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 > | readMetadata (fits::MemFileManager &manager, int hdu=DEFAULT_HDU, bool strip=false) |
Read FITS header. | |
std::shared_ptr< daf::base::PropertyList > | 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 > | readMetadata (fits::Fits &fitsfile, bool strip=false) |
Read FITS header. | |
void | setAllowImageCompression (bool allow) |
bool | getAllowImageCompression () |
ImageCompressionOptions::CompressionAlgorithm | compressionAlgorithmFromString (std::string const &name) |
Interpret compression algorithm expressed in string. | |
std::string | compressionAlgorithmToString (ImageCompressionOptions::CompressionAlgorithm algorithm) |
Provide string version of compression algorithm. | |
ImageCompressionOptions::CompressionAlgorithm | compressionAlgorithmFromCfitsio (int cfitsio) |
Convert compression algorithm from cfitsio to ImageCompressionOptions::CompressionAlgorithm. | |
int | compressionAlgorithmToCfitsio (ImageCompressionOptions::CompressionAlgorithm algorithm) |
Convert ImageCompressionOptions::CompressionAlgorithm to cfitsio. | |
ImageScalingOptions::ScalingAlgorithm | scalingAlgorithmFromString (std::string const &name) |
Interpret scaling algorithm expressed in string. | |
std::string | scalingAlgorithmToString (ImageScalingOptions::ScalingAlgorithm algorithm) |
Provide string version of compression algorithm. | |
PYBIND11_MODULE (_fits, mod) | |
template ImageScale | ImageScalingOptions::determine< std::uint8_t, 2 > (ndarray::Array< std::uint8_t const, 2, 2 > const &image, ndarray::Array< bool, 2, 2 > const &mask) const |
template std::shared_ptr< detail::PixelArrayBase > | ImageScale::toFits< std::uint8_t > (ndarray::Array< std::uint8_t const, 2, 2 > const &, bool, bool, ndarray::Array< long, 1 > const &, int) const |
template ndarray::Array< std::uint8_t, 2, 2 > | ImageScale::fromFits< std::uint8_t > (ndarray::Array< std::uint8_t, 2, 2 > const &) const |
template ImageScale | ImageScalingOptions::determine< std::uint16_t, 2 > (ndarray::Array< std::uint16_t const, 2, 2 > const &image, ndarray::Array< bool, 2, 2 > const &mask) const |
template std::shared_ptr< detail::PixelArrayBase > | ImageScale::toFits< std::uint16_t > (ndarray::Array< std::uint16_t const, 2, 2 > const &, bool, bool, ndarray::Array< long, 1 > const &, int) const |
template ndarray::Array< std::uint16_t, 2, 2 > | ImageScale::fromFits< std::uint16_t > (ndarray::Array< std::uint16_t, 2, 2 > const &) const |
template ImageScale | ImageScalingOptions::determine< std::int16_t, 2 > (ndarray::Array< std::int16_t const, 2, 2 > const &image, ndarray::Array< bool, 2, 2 > const &mask) const |
template std::shared_ptr< detail::PixelArrayBase > | ImageScale::toFits< std::int16_t > (ndarray::Array< std::int16_t const, 2, 2 > const &, bool, bool, ndarray::Array< long, 1 > const &, int) const |
template ndarray::Array< std::int16_t, 2, 2 > | ImageScale::fromFits< std::int16_t > (ndarray::Array< std::int16_t, 2, 2 > const &) const |
template ImageScale | ImageScalingOptions::determine< std::uint32_t, 2 > (ndarray::Array< std::uint32_t const, 2, 2 > const &image, ndarray::Array< bool, 2, 2 > const &mask) const |
template std::shared_ptr< detail::PixelArrayBase > | ImageScale::toFits< std::uint32_t > (ndarray::Array< std::uint32_t const, 2, 2 > const &, bool, bool, ndarray::Array< long, 1 > const &, int) const |
template ndarray::Array< std::uint32_t, 2, 2 > | ImageScale::fromFits< std::uint32_t > (ndarray::Array< std::uint32_t, 2, 2 > const &) const |
template ImageScale | ImageScalingOptions::determine< std::int32_t, 2 > (ndarray::Array< std::int32_t const, 2, 2 > const &image, ndarray::Array< bool, 2, 2 > const &mask) const |
template std::shared_ptr< detail::PixelArrayBase > | ImageScale::toFits< std::int32_t > (ndarray::Array< std::int32_t const, 2, 2 > const &, bool, bool, ndarray::Array< long, 1 > const &, int) const |
template ndarray::Array< std::int32_t, 2, 2 > | ImageScale::fromFits< std::int32_t > (ndarray::Array< std::int32_t, 2, 2 > const &) const |
template ImageScale | ImageScalingOptions::determine< std::uint64_t, 2 > (ndarray::Array< std::uint64_t const, 2, 2 > const &image, ndarray::Array< bool, 2, 2 > const &mask) const |
template std::shared_ptr< detail::PixelArrayBase > | ImageScale::toFits< std::uint64_t > (ndarray::Array< std::uint64_t const, 2, 2 > const &, bool, bool, ndarray::Array< long, 1 > const &, int) const |
template ndarray::Array< std::uint64_t, 2, 2 > | ImageScale::fromFits< std::uint64_t > (ndarray::Array< std::uint64_t, 2, 2 > const &) const |
template ImageScale | ImageScalingOptions::determine< std::int64_t, 2 > (ndarray::Array< std::int64_t const, 2, 2 > const &image, ndarray::Array< bool, 2, 2 > const &mask) const |
template std::shared_ptr< detail::PixelArrayBase > | ImageScale::toFits< std::int64_t > (ndarray::Array< std::int64_t const, 2, 2 > const &, bool, bool, ndarray::Array< long, 1 > const &, int) const |
template ndarray::Array< std::int64_t, 2, 2 > | ImageScale::fromFits< std::int64_t > (ndarray::Array< std::int64_t, 2, 2 > const &) const |
template ImageScale | ImageScalingOptions::determine< boost::float32_t, 2 > (ndarray::Array< boost::float32_t const, 2, 2 > const &image, ndarray::Array< bool, 2, 2 > const &mask) const |
template std::shared_ptr< detail::PixelArrayBase > | ImageScale::toFits< boost::float32_t > (ndarray::Array< boost::float32_t const, 2, 2 > const &, bool, bool, ndarray::Array< long, 1 > const &, int) const |
template ndarray::Array< boost::float32_t, 2, 2 > | ImageScale::fromFits< boost::float32_t > (ndarray::Array< boost::float32_t, 2, 2 > const &) const |
template ImageScale | ImageScalingOptions::determine< boost::float64_t, 2 > (ndarray::Array< boost::float64_t const, 2, 2 > const &image, ndarray::Array< bool, 2, 2 > const &mask) const |
template std::shared_ptr< detail::PixelArrayBase > | ImageScale::toFits< boost::float64_t > (ndarray::Array< boost::float64_t const, 2, 2 > const &, bool, bool, ndarray::Array< long, 1 > const &, int) const |
template ndarray::Array< boost::float64_t, 2, 2 > | ImageScale::fromFits< boost::float64_t > (ndarray::Array< boost::float64_t, 2, 2 > const &) const |
Variables | |
const int | DEFAULT_HDU = INT_MIN |
Specify that the default HDU should be read. | |
|
strong |
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.
"COMMENT" and "HISTORY" entries:
second
are appended to values in first
All other entries:
second
override values in first
(regardless of type)[in] | first | The first set of metadata to combine |
[in] | second | The second set of metadata to combine |
first
, omitting all names except "COMMENT" and "HISTORY" that appear in second
second
, omitting "COMMENT" and "HISTORY" if valid versions appear in first
Definition at line 1655 of file fits.cc.
ImageCompressionOptions::CompressionAlgorithm lsst::afw::fits::compressionAlgorithmFromCfitsio | ( | int | cfitsio | ) |
Convert compression algorithm from cfitsio to ImageCompressionOptions::CompressionAlgorithm.
Definition at line 49 of file fitsCompression.cc.
ImageCompressionOptions::CompressionAlgorithm lsst::afw::fits::compressionAlgorithmFromString | ( | std::string const & | name | ) |
Interpret compression algorithm expressed in string.
Definition at line 19 of file fitsCompression.cc.
int lsst::afw::fits::compressionAlgorithmToCfitsio | ( | ImageCompressionOptions::CompressionAlgorithm | algorithm | ) |
Convert ImageCompressionOptions::CompressionAlgorithm to cfitsio.
Definition at line 71 of file fitsCompression.cc.
std::string lsst::afw::fits::compressionAlgorithmToString | ( | ImageCompressionOptions::CompressionAlgorithm | algorithm | ) |
Provide string version of compression algorithm.
Definition at line 30 of file fitsCompression.cc.
bool lsst::afw::fits::getAllowImageCompression | ( | ) |
int lsst::afw::fits::getBitPix | ( | ) |
template ndarray::Array< boost::float32_t, 2, 2 > lsst::afw::fits::ImageScale::fromFits< boost::float32_t > | ( | ndarray::Array< boost::float32_t, 2, 2 > const & | ) | const |
template ndarray::Array< boost::float64_t, 2, 2 > lsst::afw::fits::ImageScale::fromFits< boost::float64_t > | ( | ndarray::Array< boost::float64_t, 2, 2 > const & | ) | const |
template ndarray::Array< std::int16_t, 2, 2 > lsst::afw::fits::ImageScale::fromFits< std::int16_t > | ( | ndarray::Array< std::int16_t, 2, 2 > const & | ) | const |
template ndarray::Array< std::int32_t, 2, 2 > lsst::afw::fits::ImageScale::fromFits< std::int32_t > | ( | ndarray::Array< std::int32_t, 2, 2 > const & | ) | const |
template ndarray::Array< std::int64_t, 2, 2 > lsst::afw::fits::ImageScale::fromFits< std::int64_t > | ( | ndarray::Array< std::int64_t, 2, 2 > const & | ) | const |
template ndarray::Array< std::uint16_t, 2, 2 > lsst::afw::fits::ImageScale::fromFits< std::uint16_t > | ( | ndarray::Array< std::uint16_t, 2, 2 > const & | ) | const |
template ndarray::Array< std::uint32_t, 2, 2 > lsst::afw::fits::ImageScale::fromFits< std::uint32_t > | ( | ndarray::Array< std::uint32_t, 2, 2 > const & | ) | const |
template ndarray::Array< std::uint64_t, 2, 2 > lsst::afw::fits::ImageScale::fromFits< std::uint64_t > | ( | ndarray::Array< std::uint64_t, 2, 2 > const & | ) | const |
template ndarray::Array< std::uint8_t, 2, 2 > lsst::afw::fits::ImageScale::fromFits< std::uint8_t > | ( | ndarray::Array< std::uint8_t, 2, 2 > const & | ) | const |
template std::shared_ptr< detail::PixelArrayBase > lsst::afw::fits::ImageScale::toFits< boost::float32_t > | ( | ndarray::Array< boost::float32_t const, 2, 2 > const & | , |
bool | , | ||
bool | , | ||
ndarray::Array< long, 1 > const & | , | ||
int | ) const |
template std::shared_ptr< detail::PixelArrayBase > lsst::afw::fits::ImageScale::toFits< boost::float64_t > | ( | ndarray::Array< boost::float64_t const, 2, 2 > const & | , |
bool | , | ||
bool | , | ||
ndarray::Array< long, 1 > const & | , | ||
int | ) const |
template std::shared_ptr< detail::PixelArrayBase > lsst::afw::fits::ImageScale::toFits< std::int16_t > | ( | ndarray::Array< std::int16_t const, 2, 2 > const & | , |
bool | , | ||
bool | , | ||
ndarray::Array< long, 1 > const & | , | ||
int | ) const |
template std::shared_ptr< detail::PixelArrayBase > lsst::afw::fits::ImageScale::toFits< std::int32_t > | ( | ndarray::Array< std::int32_t const, 2, 2 > const & | , |
bool | , | ||
bool | , | ||
ndarray::Array< long, 1 > const & | , | ||
int | ) const |
template std::shared_ptr< detail::PixelArrayBase > lsst::afw::fits::ImageScale::toFits< std::int64_t > | ( | ndarray::Array< std::int64_t const, 2, 2 > const & | , |
bool | , | ||
bool | , | ||
ndarray::Array< long, 1 > const & | , | ||
int | ) const |
template std::shared_ptr< detail::PixelArrayBase > lsst::afw::fits::ImageScale::toFits< std::uint16_t > | ( | ndarray::Array< std::uint16_t const, 2, 2 > const & | , |
bool | , | ||
bool | , | ||
ndarray::Array< long, 1 > const & | , | ||
int | ) const |
template std::shared_ptr< detail::PixelArrayBase > lsst::afw::fits::ImageScale::toFits< std::uint32_t > | ( | ndarray::Array< std::uint32_t const, 2, 2 > const & | , |
bool | , | ||
bool | , | ||
ndarray::Array< long, 1 > const & | , | ||
int | ) const |
template std::shared_ptr< detail::PixelArrayBase > lsst::afw::fits::ImageScale::toFits< std::uint64_t > | ( | ndarray::Array< std::uint64_t const, 2, 2 > const & | , |
bool | , | ||
bool | , | ||
ndarray::Array< long, 1 > const & | , | ||
int | ) const |
template std::shared_ptr< detail::PixelArrayBase > lsst::afw::fits::ImageScale::toFits< std::uint8_t > | ( | ndarray::Array< std::uint8_t const, 2, 2 > const & | , |
bool | , | ||
bool | , | ||
ndarray::Array< long, 1 > const & | , | ||
int | ) const |
template ImageScale lsst::afw::fits::ImageScalingOptions::determine< boost::float32_t, 2 > | ( | ndarray::Array< boost::float32_t const, 2, 2 > const & | image, |
ndarray::Array< bool, 2, 2 > const & | mask ) const |
template ImageScale lsst::afw::fits::ImageScalingOptions::determine< boost::float64_t, 2 > | ( | ndarray::Array< boost::float64_t const, 2, 2 > const & | image, |
ndarray::Array< bool, 2, 2 > const & | mask ) const |
template ImageScale lsst::afw::fits::ImageScalingOptions::determine< std::int16_t, 2 > | ( | ndarray::Array< std::int16_t const, 2, 2 > const & | image, |
ndarray::Array< bool, 2, 2 > const & | mask ) const |
template ImageScale lsst::afw::fits::ImageScalingOptions::determine< std::int32_t, 2 > | ( | ndarray::Array< std::int32_t const, 2, 2 > const & | image, |
ndarray::Array< bool, 2, 2 > const & | mask ) const |
template ImageScale lsst::afw::fits::ImageScalingOptions::determine< std::int64_t, 2 > | ( | ndarray::Array< std::int64_t const, 2, 2 > const & | image, |
ndarray::Array< bool, 2, 2 > const & | mask ) const |
template ImageScale lsst::afw::fits::ImageScalingOptions::determine< std::uint16_t, 2 > | ( | ndarray::Array< std::uint16_t const, 2, 2 > const & | image, |
ndarray::Array< bool, 2, 2 > const & | mask ) const |
template ImageScale lsst::afw::fits::ImageScalingOptions::determine< std::uint32_t, 2 > | ( | ndarray::Array< std::uint32_t const, 2, 2 > const & | image, |
ndarray::Array< bool, 2, 2 > const & | mask ) const |
template ImageScale lsst::afw::fits::ImageScalingOptions::determine< std::uint64_t, 2 > | ( | ndarray::Array< std::uint64_t const, 2, 2 > const & | image, |
ndarray::Array< bool, 2, 2 > const & | mask ) const |
template ImageScale lsst::afw::fits::ImageScalingOptions::determine< std::uint8_t, 2 > | ( | ndarray::Array< std::uint8_t const, 2, 2 > const & | image, |
ndarray::Array< bool, 2, 2 > const & | mask ) const |
ndarray::Array< T const, N, N > const lsst::afw::fits::makeContiguousArray | ( | ndarray::Array< T, N, C > const & | array | ) |
Construct a contiguous ndarray.
A deep copy is only performed if the array is not already contiguous.
Definition at line 212 of file fits.h.
|
inline |
Definition at line 65 of file fits.h.
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.
[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. |
Definition at line 431 of file fits.cc.
|
inline |
std::string lsst::afw::fits::makeErrorMessage | ( | void * | fptr, |
int | status = 0, | ||
std::string const & | msg = "" ) |
Return an error message reflecting FITS I/O errors.
[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. |
Definition at line 459 of file fits.cc.
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.
This function is designed to format data for creating a WCS. As such, it is quite limited:
[in] | metadata | Metadata to format; if this is a PropertyList then the order of items is preserved |
[in] | excludeNames | Names of entries to exclude from the returned header string |
Definition at line 468 of file fits.cc.
lsst::afw::fits::PYBIND11_MODULE | ( | _fits | , |
mod | ) |
Definition at line 284 of file _fits.cc.
std::shared_ptr< daf::base::PropertyList > lsst::afw::fits::readMetadata | ( | fits::Fits & | fitsfile, |
bool | strip = false ) |
Read FITS header.
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.
fitsfile | the file and HDU to be read |
strip | if true , common FITS keys that usually have non-metadata intepretations (e.g. NAXIS, BITPIX) will be ignored. |
Definition at line 1714 of file fits.cc.
dafPlistPtr lsst::afw::fits::readMetadata | ( | fits::MemFileManager & | manager, |
int | hdu = DEFAULT_HDU, | ||
bool | strip = false ) |
Read FITS header.
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.
manager | the in-memory file whose header will be read |
hdu | the HDU to read (0-indexed; 0 is the Primary HDU). |
strip | if true , common FITS keys that usually have non-metadata intepretations (e.g. NAXIS, BITPIX) will be ignored. |
Definition at line 1705 of file fits.cc.
dafPlistPtr lsst::afw::fits::readMetadata | ( | fits::MemFileManager & | manager, |
std::string const & | hduname, | ||
HduType | type = HduType::ANY, | ||
int | hduver = 0, | ||
bool | strip = false ) |
Read FITS header.
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.
manager | the in-memory file whose header will be read |
hduname | the name of the HDU to read |
type | type of FITS header to match. Defaults to ANY_HDU |
hduver | version of HDU header to match, defaults to 0 (version ignored) |
strip | if true , common FITS keys that usually have non-metadata intepretations (e.g. NAXIS, BITPIX) will be ignored. |
dafPlistPtr lsst::afw::fits::readMetadata | ( | std::string const & | fileName, |
int | hdu = DEFAULT_HDU, | ||
bool | strip = false ) |
Read FITS header.
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.
fileName | the file whose header will be read |
hdu | the HDU to read (0-indexed; 0 is the Primary HDU). |
strip | if true , common FITS keys that usually have non-metadata intepretations (e.g. NAXIS, BITPIX) will be ignored. |
dafPlistPtr 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.
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.
fileName | the file whose header will be read |
hduname | the name of the HDU to read |
type | type of FITS header to match. Defaults to ANY_HDU |
hduver | version of HDU header to match, defaults to 0 (version ignored) |
strip | if true , common FITS keys that usually have non-metadata intepretations (e.g. NAXIS, BITPIX) will be ignored. |
ImageScalingOptions::ScalingAlgorithm lsst::afw::fits::scalingAlgorithmFromString | ( | std::string const & | name | ) |
Interpret scaling algorithm expressed in string.
Definition at line 98 of file fitsCompression.cc.
std::string lsst::afw::fits::scalingAlgorithmToString | ( | ImageScalingOptions::ScalingAlgorithm | algorithm | ) |
Provide string version of compression algorithm.
Definition at line 108 of file fitsCompression.cc.
void lsst::afw::fits::setAllowImageCompression | ( | bool | allow | ) |
const int lsst::afw::fits::DEFAULT_HDU = INT_MIN |
Specify that the default HDU should be read.
This special HDU number indicates that the first extension should be used if the primary HDU is empty (i.e., has NAXIS=0) and the Primary HDU is the current.
Definition at line 18 of file fitsDefaults.h.