EleFits  4.0.1
A modern C++ API on top of CFitsIO
Public Member Functions | List of all members
Euclid::Fits::SifFile Class Reference

#include <SifFile.h>

Class Description

Single image Fits file handler.

Provide read/write access to the header and image raster.

See also
File and HDU handlers
Inheritance diagram for Euclid::Fits::SifFile:
[legend]

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. More...
 
const ImageRasterraster () const
 Access the data unit.
 
template<typename T , long n = 2>
void writeAll (const RecordSeq &records, const Raster< T, n > &raster)
 Write both the records and the raster.
 
template<typename T , long n = 2>
VecRaster< T, n > readRaster () const
 Read the raster.
 
template<typename T , long n>
void writeRaster (const Raster< T, n > &raster) const
 Write the raster (initialize primary HDU if not done).
 
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 Euclid::Fits::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.
 

Additional Inherited Members

- Protected Member Functions inherited from Euclid::Fits::FitsFile
void open (const std::string &filename, FileMode permission)
 Open a Fits file with given filename and permission. More...
 
- Protected Attributes inherited from Euclid::Fits::FitsFile
fitsfile * m_fptr
 The CFitsIO file handler.
 
std::string m_filename
 The file name.
 
FileMode m_permission
 The file permission.
 
bool m_open
 An open flag to nullify m_fptr at close.
 

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