casacore::FitsIO Class Reference

#include <fitsio.h>

Inheritance diagram for casacore::FitsIO:

Public Types
enum	FitsErrs { OK, IOERR, MISSKEY, BADBEGIN, EMPTYFILE, NOPRIMARY, BADOPER, BADEOF, MEMERR, BADBITPIX, NOAXISN, NOPCOUNT, NOGCOUNT, BADPCOUNT, BADGCOUNT, NOGROUPS, BADNAXIS, BADPRIMARY, BADSIZE, HDUERR }
	error return code. More...
Public Member Functions
virtual	~FitsIO ()
int	err () const
int	fitsrecsize () const
	record size, in bytes, of a FITS block.
Bool	isafits () const
	is it a valid fits file (SIMPLE==T).
Bool	isextend () const
	see if there may be FITS extensions present (EXTENT==T)
Bool	eof () const
	test if end of file has been reached
FITS::FitsRecType	rectype () const
	the FITS record type
FITS::HDUType	hdutype () const
	Header Data Unit type (e.g.
FITS::ValueType	datatype () const
OFF_T	datasize () const
	return the datasize of the current HDU.
Int	itemsize () const
	data characteristics
OFF_T	currsize () const
	for input, size of remaining data for output, size of data written
FitsKeyCardTranslator &	getkc ()
	get FitsKeyCardTranslator
fitsfile *	getfptr () const
	get the fitsfile pointer
OFF_T	getskipsize () const
	get the size of the last skipped HDU
Protected Member Functions
	FitsIO (FITSErrorHandler)
virtual void	errmsg (FitsErrs, const char *)=0
	set error message that belongs to one of the enumerated types
Protected Attributes
fitsfile *	m_fptr
const int	m_recsize
Bool	m_valid_fits
Bool	m_extend
Bool	m_isaprimary
Bool	m_header_done
FITS::FitsRecType	m_rec_type
FITS::HDUType	m_hdu_type
FITSErrorHandler	m_errfn
FitsErrs	m_err_status
FitsKeyCardTranslator	m_kc
FitsKeywordList	m_kw
char *	m_curr
int	m_bytepos
Int	m_item_size
FITS::ValueType	m_data_type
OFF_T	m_data_size
	uInt m_data_size;
OFF_T	m_curr_size
	for input, size of remaining data for output, size of data written uInt m_curr_size;
OFF_T	m_skipHDU_size
	for size of the last HDU skipped

Detailed Description

sequential FITS I/O

Review Status

Reviewed By:: UNKNOWN
Date Reviewed:: before2004/08/25

Synopsis

FitsIO is a base class that handles all the sequential blocked FITS I/O. Special derived classes do the input and output. No interpretation of the data is attempted here, there are special FITS classes that handle syntax and interpretation.

Example

 FitsInput fin("myfile.fits",FITS::Disk);       // open disk file for FITS input
 if (fin.err() == FitsIO::IOERR) {            // check if open succeeded
 cout << "Could not open FITS input\n";
 exit(0);
 }
 if (fin.rectype() == FITS::HDURecord &&      // test for primary array
 fin.hdutype() == FITS::PrimaryArrayHDU) {
 }

Definition at line 62 of file fitsio.h.

Member Enumeration Documentation

enum casacore::FitsIO::FitsErrs

error return code.

Should be one of an enumerated type:

 enum FitsErrs { OK, IOERR, MISSKEY, BADBEGIN, EMPTYFILE,
 NOPRIMARY, BADOPER, BADEOF, MEMERR, BADBITPIX, NOAXISN,
 NOPCOUNT, NOGCOUNT, BADPCOUNT, BADGCOUNT, NOGROUPS,
 BADNAXIS, BADPRIMARY, BADSIZE, HDUERR };

Enumerator:

OK
IOERR
MISSKEY
BADBEGIN
EMPTYFILE
NOPRIMARY
BADOPER
BADEOF
MEMERR
BADBITPIX
NOAXISN
NOPCOUNT
NOGCOUNT
BADPCOUNT
BADGCOUNT
NOGROUPS
BADNAXIS
BADPRIMARY
BADSIZE
HDUERR