EleFits  5.0.0
A modern C++ API on top of CFITSIO
Public Member Functions | List of all members
SifFile Class Reference

#include <SifFile.h>

Detailed Description

Single image FITS file handler.

Through constructor and destructor, SifFile handles creation, opening, closing and removing of the SIF-file. Other methods give access to the header unit and image data unit. Note that the data unit is empty at creation, and must be resized to write data.

See also
File and HDU handlers

Public Member Functions

virtual ~SifFile ()=default
 Destroy the object and close the file. More...
 
 SifFile (const std::string &filename, FileMode permission)
 Create a new FITS file handler with given filename and permission. More...
 
const Headerheader () const
 Access the header unit.
 
const ImageRasterraster () const
 Access the data unit.
 
template<typename TRaster >
void writeAll (const RecordSeq &records, const TRaster &raster)
 Write both the records and the raster (resize the data unit if empty).
 
template<typename T , long N = 2>
VecRaster< T, N > readRaster () const
 Read the raster. More...
 
template<typename TRaster >
void writeRaster (const TRaster &raster) const
 Write the raster (resize the data unit if empty). More...
 
void verifyChecksums () const
 Compute the HDU and data checksums and compare them to the values in the header. More...
 
void updateChecksums () const
 Compute and write (or update) the HDU and data checksums. More...
 
- Public Member Functions inherited from FitsFile
 FitsFile (const std::string &filename, FileMode permission)
 Create a new FITS file handler with given filename and permission.
 
virtual ~FitsFile ()
 Destroy the object and close the file. More...
 
std::string filename () const
 Get the file name.
 
bool isOpen () const
 Check whether the file is open.
 
void reopen ()
 Reopen the file. More...
 
void close ()
 Close the file. More...
 
void closeAndDelete ()
 Close and delete the file.
 
fitsfile * handoverToCfitsio ()
 Get CFITSIO's fitsfile*. More...
 

Additional Inherited Members


The documentation for this class was generated from the following file: