casacore
|
#include <hdu.h>
Public Types | |
enum | HDUErrs { OK , NOMEM , MISSKEY , BADBITPIX , NOAXISN , NOPCOUNT , NOGCOUNT , BADPCOUNT , BADGCOUNT , NOGROUPS , BADNAXIS , BADREC , BADTYPE , BADRULES , BADSIZE , BADOPER , BADCONV , BADIO } |
error handling and error codes that can be returned More... | |
Public Member Functions | |
virtual | ~HeaderDataUnit () |
Int | dims () const |
Int | dim (int n) const |
OFF_T | fitsdatasize () const |
FITS::ValueType | datatype () const |
Int | fitsitemsize () const |
Int | localitemsize () const |
FITS::HDUType | hdutype () const |
int | err () const |
int | skip (uInt n) |
skipping one or more HDU's More... | |
int | skip () |
int | write_hdr (FitsOutput &) |
write the current header More... | |
ConstFitsKeywordList & | kwlist () |
Operations on the HDU's keyword list. More... | |
Vector< String > | kwlist_str (Bool length80=False) |
return the header of the chdu as a vector of String. More... | |
void | firstkw () |
void | lastkw () |
const FitsKeyword * | nextkw () |
const FitsKeyword * | prevkw () |
const FitsKeyword * | currkw () |
const FitsKeyword * | kw (int n) |
const FitsKeyword * | kw (const FITS::ReservedName &n) |
const FitsKeyword * | nextkw (FITS::ReservedName &n) |
const FitsKeyword * | kw (FITS::ReservedName &n, int i) |
const FitsKeyword * | nextkw (FITS::ReservedName &n, int i) |
const FitsKeyword * | kw (const char *n) |
const FitsKeyword * | nextkw (const char *n) |
void | mk (FITS::ReservedName k, Bool v, const char *c=0) |
void | mk (FITS::ReservedName k, const char *v=0, const char *c=0) |
void | mk (FITS::ReservedName k, Int v, const char *c=0) |
void | mk (FITS::ReservedName k, double v, const char *c=0) |
void | mk (int n, FITS::ReservedName k, Bool v, const char *c=0) |
void | mk (int n, FITS::ReservedName k, const char *v, const char *c=0) |
void | mk (int n, FITS::ReservedName k, Int v, const char *c=0) |
void | mk (int n, FITS::ReservedName k, double v, const char *c=0) |
void | mk (const char *n, Bool v, const char *c=0) |
void | mk (const char *n, const char *v=0, const char *c=0) |
void | mk (const char *n, Int v, const char *c=0) |
void | mk (const char *n, float v, const char *c=0) |
void | mk (const char *n, double v, const char *c=0) |
void | mk (const char *n, Int r, Int i, const char *c=0) |
void | mk (const char *n, float r, float i, const char *c=0) |
void | mk (const char *n, double r, double i, const char *c=0) |
void | spaces (const char *n=0, const char *c=0) |
void | comment (const char *n=0, const char *c=0) |
void | history (const char *c=0) |
Bool | notnull (double x) const |
Bool | notnull (char *s) const |
Bool | notnull (Int l) const |
int | get_hdr (FITS::HDUType, FitsKeywordList &) |
int | read_data (char *, Int) |
int | write_data (FitsOutput &, char *, Int) |
OFF_T | read_all_data (char *) |
int | write_all_data (FitsOutput &, char *) |
Static Public Member Functions | |
static Bool | determine_type (FitsKeywordList &, FITS::HDUType &, FITS::ValueType &, FITSErrorHandler, HDUErrs &) |
Determines the HDU type and the data type Parameterss: keyword list, hdu type, data type, error handler and error status. More... | |
static Bool | compute_size (FitsKeywordList &, OFF_T &, Int &, FITS::HDUType &, FITS::ValueType &, FITSErrorHandler, HDUErrs &) |
Compute the total size of the data associated with an HDU. More... | |
Protected Member Functions | |
HeaderDataUnit (FitsInput &, FITS::HDUType, FITSErrorHandler errhandler=FITSError::defaultHandler) | |
For input – ~ should delete the keyword list: kwflag = 1. More... | |
HeaderDataUnit (FitsKeywordList &, FITS::HDUType, FITSErrorHandler errhandler=FITSError::defaultHandler, FitsInput *=0) | |
For output – ~ should not delete keyword list: kwflag = 0 07/21/98 AKH Clarification: HeaderDataUnit has a copy of the FitsKeywordList, and should delete it. More... | |
HeaderDataUnit (FITS::HDUType, FITSErrorHandler errhandler=FITSError::defaultHandler, FitsInput *=0) | |
constructor for objects that write only required keyword to fits file. More... | |
bool | init_data_unit (FITS::HDUType t) |
for write required keywords only to use. More... | |
void | posEnd () |
void | errmsg (HDUErrs, const char *) |
char * | assign (FITS::ReservedName) |
char * | assign (FITS::ReservedName, int) |
double | asgdbl (FITS::ReservedName, double) |
double | asgdbl (FITS::ReservedName, int, double) |
Protected Attributes | |
FitsKeywordList & | kwlist_ |
ConstFitsKeywordList | constkwlist_ |
FitsInput * | fin |
FITSErrorHandler | errfn |
HDUErrs | err_status |
Int | no_dims |
Int * | dimn |
OFF_T | fits_data_size |
uInt fits_data_size; // size in bytes of total amount of data More... | |
FITS::ValueType | data_type |
Int | fits_item_size |
Int | local_item_size |
FITS::HDUType | hdu_type |
char | pad_char |
double | double_null |
char | char_null |
Int | Int_null |
Friends | |
std::ostream & | operator<< (std::ostream &, HeaderDataUnit &) |
base class that defines a HDU
The class HeaderDataUnit contains what is common to all header-data-units, including the collection of keywords. From this class a number of FITS header-data-units are derived, each of them with their own rich assortment of functions for accessing and manipulating data of specific types. The following inheritence hierarchy illustrates the current derived classes:
|
virtual |
|
protected |
For input – ~ should delete the keyword list: kwflag = 1.
|
protected |
For output – ~ should not delete keyword list: kwflag = 0 07/21/98 AKH Clarification: HeaderDataUnit has a copy of the FitsKeywordList, and should delete it.
The kwflag comments above are not important now.
|
protected |
constructor for objects that write only required keyword to fits file.
the write method to call by these object should be those for the specific hdu, such as write_bintbl_hdr().
|
protected |
|
protected |
|
protected |
|
protected |
|
inline |
Definition at line 259 of file hdu.h.
References casacore::C::c, casacore::FitsKeywordList::comment(), kwlist_, and posEnd().
|
static |
Compute the total size of the data associated with an HDU.
The number of dimensions is also determined. This routine assumes that hdu type has been appropriately set, but it may be changed in the process. Data type is also determined. Returns False if a serious error was detected, otherwise True
|
inline |
Definition at line 128 of file hdu.h.
References casacore::FitsKeywordList::curr(), and kwlist_.
|
inline |
|
static |
Determines the HDU type and the data type Parameterss: keyword list, hdu type, data type, error handler and error status.
Returns False if a serious error was detected, otherwise True
|
inline |
Definition at line 77 of file hdu.h.
Referenced by casacore::MSPrimaryTableHolder::dim(), casacore::MSPrimaryGroupHolder::dim(), and casacore::BinaryTableExtension::nrows().
|
inline |
Definition at line 76 of file hdu.h.
References no_dims.
Referenced by casacore::MSPrimaryTableHolder::dims(), and casacore::MSPrimaryGroupHolder::dims().
|
inline |
Definition at line 90 of file hdu.h.
References err_status.
|
protected |
|
inline |
Definition at line 124 of file hdu.h.
References casacore::FitsKeywordList::first(), and kwlist_.
|
inline |
Definition at line 78 of file hdu.h.
References fits_data_size.
|
inline |
Definition at line 80 of file hdu.h.
References fits_item_size.
int casacore::HeaderDataUnit::get_hdr | ( | FITS::HDUType | , |
FitsKeywordList & | |||
) |
|
inline |
|
inline |
Definition at line 261 of file hdu.h.
References casacore::C::c, casacore::FitsKeywordList::history(), kwlist_, and posEnd().
|
protected |
for write required keywords only to use.
|
inline |
|
inline |
|
inline |
|
inline |
Definition at line 129 of file hdu.h.
References kwlist_.
Referenced by casacore::MSPrimaryTableHolder::kw(), and casacore::MSPrimaryGroupHolder::kw().
|
inline |
Operations on the HDU's keyword list.
Definition at line 120 of file hdu.h.
References constkwlist_.
Referenced by casacore::MSPrimaryTableHolder::kwlist(), and casacore::MSPrimaryGroupHolder::kwlist().
return the header of the chdu as a vector of String.
You can force the strings to be length 80 (padded with spaces)
|
inline |
Definition at line 125 of file hdu.h.
References kwlist_, and casacore::FitsKeywordList::last().
|
inline |
Definition at line 81 of file hdu.h.
References local_item_size.
|
inline |
Definition at line 241 of file hdu.h.
References casacore::C::c, kwlist_, casacore::FitsKeywordList::mk(), and posEnd().
|
inline |
Definition at line 243 of file hdu.h.
References casacore::C::c, kwlist_, casacore::FitsKeywordList::mk(), and posEnd().
|
inline |
Definition at line 255 of file hdu.h.
References casacore::C::c, kwlist_, casacore::FitsKeywordList::mk(), and posEnd().
|
inline |
Definition at line 249 of file hdu.h.
References casacore::C::c, kwlist_, casacore::FitsKeywordList::mk(), and posEnd().
|
inline |
Definition at line 253 of file hdu.h.
References casacore::C::c, kwlist_, casacore::FitsKeywordList::mk(), and posEnd().
|
inline |
Definition at line 247 of file hdu.h.
References casacore::C::c, kwlist_, casacore::FitsKeywordList::mk(), and posEnd().
Definition at line 251 of file hdu.h.
References casacore::C::c, kwlist_, casacore::FitsKeywordList::mk(), and posEnd().
|
inline |
Definition at line 245 of file hdu.h.
References casacore::C::c, kwlist_, casacore::FitsKeywordList::mk(), and posEnd().
|
inline |
Definition at line 225 of file hdu.h.
References casacore::C::c, kwlist_, casacore::FitsKeywordList::mk(), and posEnd().
|
inline |
Definition at line 227 of file hdu.h.
References casacore::C::c, kwlist_, casacore::FitsKeywordList::mk(), and posEnd().
|
inline |
Definition at line 231 of file hdu.h.
References casacore::C::c, kwlist_, casacore::FitsKeywordList::mk(), and posEnd().
|
inline |
Definition at line 229 of file hdu.h.
References casacore::C::c, kwlist_, casacore::FitsKeywordList::mk(), and posEnd().
|
inline |
Definition at line 233 of file hdu.h.
References casacore::C::c, kwlist_, casacore::FitsKeywordList::mk(), and posEnd().
|
inline |
Definition at line 235 of file hdu.h.
References casacore::C::c, kwlist_, casacore::FitsKeywordList::mk(), and posEnd().
|
inline |
Definition at line 239 of file hdu.h.
References casacore::C::c, kwlist_, casacore::FitsKeywordList::mk(), and posEnd().
|
inline |
Definition at line 237 of file hdu.h.
References casacore::C::c, kwlist_, casacore::FitsKeywordList::mk(), and posEnd().
|
inline |
Definition at line 126 of file hdu.h.
References kwlist_, and casacore::FitsKeywordList::next().
Referenced by casacore::MSPrimaryTableHolder::nextkw(), and casacore::MSPrimaryGroupHolder::nextkw().
|
inline |
Definition at line 140 of file hdu.h.
References kwlist_, and casacore::FitsKeywordList::next().
|
inline |
Definition at line 133 of file hdu.h.
References kwlist_, and casacore::FitsKeywordList::next().
|
inline |
Definition at line 137 of file hdu.h.
References kwlist_, and casacore::FitsKeywordList::next().
|
inline |
Definition at line 163 of file hdu.h.
References casacore::False, and casacore::True.
|
inline |
Definition at line 162 of file hdu.h.
References double_null, casacore::False, and casacore::True.
Definition at line 164 of file hdu.h.
References casacore::False, Int_null, and casacore::True.
|
protected |
|
inline |
Definition at line 127 of file hdu.h.
References kwlist_, and casacore::FitsKeywordList::prev().
OFF_T casacore::HeaderDataUnit::read_all_data | ( | char * | ) |
int casacore::HeaderDataUnit::read_data | ( | char * | , |
Int | |||
) |
Referenced by casacore::ExtensionHeaderDataUnit::read().
int casacore::HeaderDataUnit::skip | ( | ) |
int casacore::HeaderDataUnit::skip | ( | uInt | n | ) |
skipping one or more HDU's
|
inline |
Definition at line 257 of file hdu.h.
References casacore::C::c, kwlist_, posEnd(), and casacore::FitsKeywordList::spaces().
int casacore::HeaderDataUnit::write_all_data | ( | FitsOutput & | , |
char * | |||
) |
int casacore::HeaderDataUnit::write_data | ( | FitsOutput & | , |
char * | , | ||
Int | |||
) |
Referenced by casacore::ExtensionHeaderDataUnit::write().
int casacore::HeaderDataUnit::write_hdr | ( | FitsOutput & | ) |
write the current header
|
friend |
|
protected |
|
protected |
Definition at line 199 of file hdu.h.
Referenced by datatype().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
uInt fits_data_size; // size in bytes of total amount of data
Definition at line 198 of file hdu.h.
Referenced by fitsdatasize().
|
protected |
Definition at line 200 of file hdu.h.
Referenced by fitsitemsize().
|
protected |
|
protected |
|
protected |
|
protected |
Definition at line 201 of file hdu.h.
Referenced by localitemsize().
|
protected |