casacore::FitsInput Class Reference

fixed-length sequential blocked FITS input More...

#include <fitsio.h>

Inheritance diagram for casacore::FitsInput:

List of all members.

Public Member Functions
	FitsInput (const char *, const FITS::FitsDevice &, int=10, FITSErrorHandler errhandler=FITSError::defaultHandler)
	FitsInput (FITSErrorHandler errhandler=FITSError::defaultHandler)
	~FitsInput ()
int	skip_hdu ()
void	skip_all (FITS::HDUType)
	skip all remaining data
char *	read_sp ()
	int skip_hdu2(); read special or unrecognizable records
Vector< String >	kwlist_str (Bool length80=False)
	get hdu header image cards as strings.
int	blockno () const
	number of physical blocks read/written
int	recno () const
	number of logical records read/written
BlockInput &	getfin ()
int	getnumhdu () const
	the number of hdu in this fits file
Private Member Functions
BlockInput &	make_input (const char *, const FITS::FitsDevice &, int, FITSErrorHandler errhandler=FITSError::defaultHandler)
virtual void	errmsg (FitsErrs, const char *)
	set error message that belongs to one of the enumerated types
void	init ()
void	read_header_rec ()
bool	current_hdu_type (FITS::HDUType &)
bool	get_data_type (FITS::ValueType &)
int	process_header (FITS::HDUType, FitsKeywordList &)
	Special interface to class HeaderDataUnit.
OFF_T	read_all (FITS::HDUType, char *)
	read all data into a given address - all responsibility is given to the user
int	read (FITS::HDUType, char *, int)
	read N bytes into address
int	skip (FITS::HDUType, OFF_T)
	skip N bytes
Private Attributes
BlockInput &	m_fin
Bool	m_got_rec
	flag used for read control in errors
int	m_thdunum
	total number of hdu in this fits file
Friends
int	HeaderDataUnit::get_hdr (FITS::HDUType, FitsKeywordList &)
OFF_T	HeaderDataUnit::read_all_data (char *)
int	HeaderDataUnit::read_data (char *, Int)
int	HeaderDataUnit::skip (uInt)
int	HeaderDataUnit::skip ()

---

Detailed Description

fixed-length sequential blocked FITS input

Definition at line 156 of file fitsio.h.

---

Constructor & Destructor Documentation

casacore::FitsInput::FitsInput	(	const char *	,
		const FITS::FitsDevice &	,
		int	= 10,
		FITSErrorHandler	errhandler = FITSError::defaultHandler
	)

casacore::FitsInput::FitsInput

(

FITSErrorHandler

errhandler = FITSError::defaultHandler

)

casacore::FitsInput::~FitsInput

(

)

---

Member Function Documentation

int casacore::FitsInput::blockno

(

)

const [inline]

number of physical blocks read/written

Definition at line 186 of file fitsio.h.

References casacore::BlockIO::blockno(), and m_fin.

bool casacore::FitsInput::current_hdu_type

(

FITS::HDUType &

)

[private]

virtual void casacore::FitsInput::errmsg	(	FitsErrs	,
		const char *
	)			[private, virtual]

set error message that belongs to one of the enumerated types

Implements casacore::FitsIO.

bool casacore::FitsInput::get_data_type

(

FITS::ValueType &

)

[private]

BlockInput& casacore::FitsInput::getfin

(

)

[inline]

Definition at line 190 of file fitsio.h.

References m_fin.

int casacore::FitsInput::getnumhdu

(

)

const [inline]

the number of hdu in this fits file

Definition at line 193 of file fitsio.h.

References m_thdunum.

void casacore::FitsInput::init

(

)

[private]

Vector<String> casacore::FitsInput::kwlist_str

(

Bool

length80 = False

)

get hdu header image cards as strings.

By default the strings will be of variable length. You can optionally ask for them to be length 80 (padded with spaces).

BlockInput& casacore::FitsInput::make_input	(	const char *	,
		const FITS::FitsDevice &	,
		int	,
		FITSErrorHandler	errhandler = FITSError::defaultHandler
	)			[private]

int casacore::FitsInput::process_header	(	FITS::HDUType	,
		FitsKeywordList &
	)			[private]

Special interface to class HeaderDataUnit.

special way to process header

int casacore::FitsInput::read	(	FITS::HDUType	,
		char *	,
		int
	)			[private]

read N bytes into address

OFF_T casacore::FitsInput::read_all	(	FITS::HDUType	,
		char *
	)			[private]

read all data into a given address - all responsibility is given to the user

void casacore::FitsInput::read_header_rec

(

)

[private]

char* casacore::FitsInput::read_sp

(

)

int skip_hdu2(); read special or unrecognizable records

int casacore::FitsInput::recno

(

)

const [inline]

number of logical records read/written

Definition at line 189 of file fitsio.h.

References m_fin, and casacore::BlockIO::recno().

int casacore::FitsInput::skip	(	FITS::HDUType	,
		OFF_T
	)			[private]

skip N bytes

void casacore::FitsInput::skip_all

(

FITS::HDUType

)

skip all remaining data

int casacore::FitsInput::skip_hdu

(

)

---

Friends And Related Function Documentation

int HeaderDataUnit::get_hdr	(	FITS::HDUType	,
		FitsKeywordList &
	)			[friend]

OFF_T HeaderDataUnit::read_all_data

(

char *

)

[friend]

int HeaderDataUnit::read_data	(	char *	,
		Int
	)			[friend]

int HeaderDataUnit::skip

(

)

[friend]

int HeaderDataUnit::skip

(

uInt

)

[friend]

---

Member Data Documentation

BlockInput& casacore::FitsInput::m_fin [private]

Definition at line 196 of file fitsio.h.

Referenced by blockno(), getfin(), and recno().

Bool casacore::FitsInput::m_got_rec [private]

flag used for read control in errors

Definition at line 201 of file fitsio.h.

int casacore::FitsInput::m_thdunum [private]

total number of hdu in this fits file

Definition at line 203 of file fitsio.h.

Referenced by getnumhdu().

---

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

• casacore/fits/FITS/fitsio.h