Arroyo::iofits Class Reference

#include <iofits.h>

List of all members.

Public Types
enum	imagetype {   FLOATIMG = -32, USHORTIMG = 20, DOUBLEIMG = -64, BYTEIMG = 8,   SHORTIMG = 16, LONGIMG = 32 }
Public Member Functions
	iofits ()
	iofits (const char *infile, int iomode=READONLY)
	iofits (const iofits &iof)
virtual	~iofits ()
iofits &	operator= (const iofits &iof)
void	open (const char *infile, int iomode=READONLY)
void	close ()
void	create (const char *infile)
string	name () const
bool	key_exists (const char *keyname) const
void	read_record (int record, string &value) const
template<class T>
void	read_key (const char *keyname, T &value, string &comment) const
template<class T>
void	write_key (const char *keyname, const T &value, const string &comment)
template<class T>
void	update_key (const char *keyname, const T &value, const string &comment)
void	delete_key (const char *keyname)
	fits_delete_key
void	delete_record (int record)
string	read_record (int record) const
string	record_head (int record) const
string	record_val (int record) const
int	get_img_dim () const
int	get_status () const
vector< long >	get_img_size () const
int	movabs_hdu (const int &hdunum) const
int	movrel_hdu (const int &hdunum) const
int	get_num_hdus () const
int	get_hdu_num () const
void	create_hdu ()
void	create_image (const vector< long > &axes, imagetype imgtp)
template<class T>
void	create_image (const vector< long > &axes, const T *t)
template<class T>
void	read_image (int first, int last, T *pixframe) const
template<class T>
void	write_image (int first, int last, const T *pixframe)
void	read_image_header (int &bitpix, vector< long > &axes) const
void	write_image_header (int bitpix, const vector< long > &axes)
void	print_header (ostream &os, const char *prefix="") const
Static Public Attributes
int	verbose_level
	A verbose_level for printing messages.
Protected Attributes
fitsfile *	fp
	pointer to the fits file underlying this instance
string	filename
	name of the fits file
int	status
	mutable status variable used in cfitsio function calls

---

Detailed Description

A class to wrap cfitsio function calls

---

Member Enumeration Documentation

enum Arroyo::iofits::imagetype

Enumeration values: FLOATIMG  USHORTIMG  DOUBLEIMG  BYTEIMG  SHORTIMG  LONGIMG

---

Constructor & Destructor Documentation

Arroyo::iofits::iofits (   )  [inline]

Null constructor

Arroyo::iofits::iofits (  const char *  infile, int  iomode = READONLY )

Construct iofits object from file

Arroyo::iofits::iofits (  const iofits &  iof  )  [inline]

Copy constructor

virtual Arroyo::iofits::~iofits (   )  [virtual]

Destructor that closes the file

---

Member Function Documentation

void Arroyo::iofits::close (   )

Close file

void Arroyo::iofits::create (  const char *  infile  )

Create file

void Arroyo::iofits::create_hdu (   )

Create header

template<class T> void Arroyo::iofits::create_image (  const vector< long > &  axes, const T *  t )

templatized fits_create_image

void Arroyo::iofits::create_image (  const vector< long > &  axes, imagetype  imgtp )

fits_create_image for doubles

void Arroyo::iofits::delete_key (  const char *  keyname  )

fits_delete_key

void Arroyo::iofits::delete_record (  int  record  )

fits_delete_record

int Arroyo::iofits::get_hdu_num (   )  const

fits_get_hdu_num

int Arroyo::iofits::get_img_dim (   )  const

fits_get_img_dim

vector<long> Arroyo::iofits::get_img_size (   )  const

fits_get_img_size

int Arroyo::iofits::get_num_hdus (   )  const

fits_get_num_hdus

int Arroyo::iofits::get_status (   )  const [inline]

Return the status

bool Arroyo::iofits::key_exists (  const char *  keyname  )  const

Function to check whether keyword exists

int Arroyo::iofits::movabs_hdu (  const int &  hdunum  )  const

fits_movabs_hdu

int Arroyo::iofits::movrel_hdu (  const int &  hdunum  )  const

fits_movrel_hdu

string Arroyo::iofits::name (   )  const [inline]

Get name

void Arroyo::iofits::open (  const char *  infile, int  iomode = READONLY )

Open file

iofits& Arroyo::iofits::operator= (  const iofits &  iof  )

Operator = : creates another fitsfile pointer to file

void Arroyo::iofits::print_header (  ostream &  os, const char *  prefix = "" )  const

Write out all the items in the header

template<class T> void Arroyo::iofits::read_image (  int  first, int  last, T *  pixframe )  const

templatized fits_read_img

void Arroyo::iofits::read_image_header (  int &  bitpix, vector< long > &  axes )  const

fits_read_imghdr

template<class T> void Arroyo::iofits::read_key (  const char *  keyname, T &  value, string &  comment )  const

templatized fits_read_key

string Arroyo::iofits::read_record (  int  record  )  const [inline]

Returns the record of entry record

void Arroyo::iofits::read_record (  int  record, string &  value )  const

fits_read_record

string Arroyo::iofits::record_head (  int  record  )  const

Function to get the record head of entry record

string Arroyo::iofits::record_val (  int  record  )  const

Function to get the record value of entry record

template<class T> void Arroyo::iofits::update_key (  const char *  keyname, const T &  value, const string &  comment )

templatized fits_update_key

template<class T> void Arroyo::iofits::write_image (  int  first, int  last, const T *  pixframe )

templatized fits_read_img

void Arroyo::iofits::write_image_header (  int  bitpix, const vector< long > &  axes )

fits_write_imghdr

template<class T> void Arroyo::iofits::write_key (  const char *  keyname, const T &  value, const string &  comment )

templatized fits_write_key

---

Member Data Documentation

string Arroyo::iofits::filename [protected]

name of the fits file

fitsfile* Arroyo::iofits::fp [protected]

pointer to the fits file underlying this instance

int Arroyo::iofits::status [mutable, protected]

mutable status variable used in cfitsio function calls

int Arroyo::iofits::verbose_level [static]

A verbose_level for printing messages.

---

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

• iofits.h

---