casacore::FITS Class Reference

static functions and enumerations More...

#include <fits.h>

List of all members.

Public Types

enum  ValueType {
  NOVALUE,
  LOGICAL,
  BIT,
  CHAR,
  BYTE,
  SHORT,
  LONG,
  FLOAT,
  DOUBLE,
  COMPLEX,
  ICOMPLEX,
  DCOMPLEX,
  VADESC,
  STRING,
  FSTRING,
  REAL
}
 

FITS I/O Error message types.

More...
enum  ReservedName {
  USER_DEF,
  AUTHOR,
  BITPIX,
  BLANK,
  BLOCKED,
  BSCALE,
  BUNIT,
  BZERO,
  CDELT,
  COMMENT,
  CROTA,
  CRPIX,
  CRVAL,
  CTYPE,
  DATAMAX,
  DATAMIN,
  DATE,
  DATE_OBS,
  END,
  EPOCH,
  EQUINOX,
  EXTEND,
  EXTLEVEL,
  EXTNAME,
  EXTVER,
  GCOUNT,
  GROUPS,
  HISTORY,
  INSTRUME,
  NAXIS,
  OBJECT,
  OBSERVER,
  ORIGIN,
  PCOUNT,
  PSCAL,
  PTYPE,
  PZERO_FITS,
  REFERENC,
  SIMPLE,
  SPACES,
  TBCOL,
  TDIM,
  TDISP,
  TELESCOP,
  TFIELDS,
  TFORM,
  THEAP,
  TNULL,
  TSCAL,
  TTYPE,
  TUNIT,
  TZERO,
  XTENSION,
  ERRWORD,
  ALTRPIX,
  DATE_MAP
}
 

FITS Reserved Names.

More...
enum  FitsRecType {
  InitialState,
  BadBeginningRecord,
  HDURecord,
  UnrecognizableRecord,
  SpecialRecord,
  EndOfFile
}
 

Types of FITS Records.

More...
enum  FitsDevice {
  Disk,
  Std,
  Tape9
}
 

Supported FITS Physical Devices.

More...
enum  HDUType {
  NotAHDU,
  PrimaryArrayHDU,
  PrimaryGroupHDU,
  AsciiTableHDU,
  BinaryTableHDU,
  ImageExtensionHDU,
  UnknownExtensionHDU,
  PrimaryTableHDU
}
 

Types of FITS Header-Data Units.

More...
enum  FitsArrayOption {
  NoOpt,
  CtoF,
  FtoC
}
 

Options on FITS array manipulations.

More...

Static Public Member Functions

static FITS::ValueType getfitstype (NoConvert< FitsLogical > x)
 STRING and FSTRING are used internally in parsing keywords.
static FITS::ValueType getfitstype (NoConvert< FitsBit > x)
static FITS::ValueType getfitstype (NoConvert< char > x)
static FITS::ValueType getfitstype (NoConvert< unsigned char > x)
static FITS::ValueType getfitstype (NoConvert< short > x)
static FITS::ValueType getfitstype (NoConvert< Int > x)
static FITS::ValueType getfitstype (NoConvert< long > x)
static FITS::ValueType getfitstype (NoConvert< float > x)
static FITS::ValueType getfitstype (NoConvert< double > x)
static FITS::ValueType getfitstype (NoConvert< Complex > x)
static FITS::ValueType getfitstype (NoConvert< IComplex > x)
static FITS::ValueType getfitstype (NoConvert< DComplex > x)
static FITS::ValueType getfitstype (NoConvert< FitsVADesc > x)
static int fitssize (FITS::ValueType t)
static int localsize (FITS::ValueType t)
static void f2l (FitsLogical *, void *, int)
 data conversion routines: FITS - local
static void l2f (void *, FitsLogical *, int)
static void f2l (FitsBit *, void *, int)
static void l2f (void *, FitsBit *, int)
static void f2l (char *, void *, int)
static void l2f (void *, char *, int)
static void f2l (unsigned char *, void *, int)
static void l2f (void *, unsigned char *, int)
static void f2l (short *, void *, int)
static void l2f (void *, short *, int)
static void f2l (Int *, void *, int)
static void l2f (void *, Int *, int)
static void f2l (long *, void *, int)
static void l2f (void *, long *, int)
static void f2l (float *, void *, int)
static void l2f (void *, float *, int)
static void f2l (double *, void *, int)
static void l2f (void *, double *, int)
static void f2l (Complex *, void *, int)
static void l2f (void *, Complex *, int)
static void f2l (IComplex *, void *, int)
static void l2f (void *, IComplex *, int)
static void f2l (DComplex *, void *, int)
static void l2f (void *, DComplex *, int)
static void f2l (FitsVADesc *, void *, int)
static void l2f (void *, FitsVADesc *, int)
static void swap2 (void *, void *, int)
static void swap4 (void *, void *, int)
static void swap8 (void *, void *, int)
static void valstr (ostream &o, const ValueType &ty, const void *val)
static Bool isa_digit (char c)
static int digit2bin (char c)
static Bool isa_text (char c)
static Bool isa_letter (char)
static int letter2bin (char)
static void fstr2str (char *, const char *, int)
static int str2fstr (char *, const char *, int)
static void get_name (const char *s, int len, FitsNameResult &result)
static int get_value_id (const char *s, int l, int &pos)
static void get_value (const char *s, int len, FitsValueResult &result)
static int trim_comment (const char *s, int len)
static int chk_comment (const char *s, int len)
static int get_comment (const char *s, int len, int &begpos)
static void get_numeric (const char *s, int len, FitsValueResult &result)
static void parse_vatform (const char *s, FITS::ValueType &valType, int &maxelem)
 utility function to parse the binary table variable array column (i.e.

Static Public Attributes

static
ReservedFitsKeywordCollection & 		ResWord
static const Int minInt
static const Int maxInt
static const float minfloat
static const float maxfloat
static const double mindouble
static const double maxdouble

Private Member Functions

 FITS ()

Static Private Member Functions

static double tenD (Int, int)
static float tenF (Int, int)
static int ckaccum (double &, Int, int)
static int ckaccum (float &, Int, int)

Static Private Attributes

static double tenpowerD [309]
static float tenpowerF [39]
static const int minfltexp
static const int maxfltexp
static const int mindblexp
static const int maxdblexp
static const int maxsigdigits
static const int maxdigl
static const int maxexpdig

Detailed Description

static functions and enumerations

Review Status

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

Synopsis

Many of the static functions are utility functions used internally in the implementation of the member functions of the FITS classes. They are placed in a single class to encapsulate them and to avoid adding many names to the global name space. More important, from the user's perspective, are the enumerations. They form the basic vocabulary of a FITS application. For example, instead of referring to the FITS NAXIS keyword, FITS::NAXIS should be used

Definition at line 170 of file fits.h.

Member Enumeration Documentation

enum casacore::FITS::FitsArrayOption

Options on FITS array manipulations.

Enumerator:
NoOpt 
CtoF 
FtoC 

Definition at line 279 of file fits.h.

enum casacore::FITS::FitsDevice

Supported FITS Physical Devices.

Enumerator:
Disk 
Std 
Tape9 

Definition at line 267 of file fits.h.

enum casacore::FITS::FitsRecType

Types of FITS Records.

Enumerator:
InitialState 
BadBeginningRecord 
HDURecord 
UnrecognizableRecord 
SpecialRecord 
EndOfFile 

Definition at line 261 of file fits.h.

enum casacore::FITS::HDUType

Types of FITS Header-Data Units.

Enumerator:
NotAHDU 
PrimaryArrayHDU 
PrimaryGroupHDU 
AsciiTableHDU 
BinaryTableHDU 
ImageExtensionHDU 
UnknownExtensionHDU 
PrimaryTableHDU 

Definition at line 272 of file fits.h.

enum casacore::FITS::ReservedName

FITS Reserved Names.

PZERO is named strangely because it can conflict with a standard #define in sys/param.h.

Enumerator:
USER_DEF 
AUTHOR 
BITPIX 
BLANK 
BLOCKED 
BSCALE 
BUNIT 
BZERO 
CDELT 
COMMENT 
CROTA 
CRPIX 
CRVAL 
CTYPE 
DATAMAX 
DATAMIN 
DATE 
DATE_OBS 
END 
EPOCH 
EQUINOX 
EXTEND 
EXTLEVEL 
EXTNAME 
EXTVER 
GCOUNT 
GROUPS 
HISTORY 
INSTRUME 
NAXIS 
OBJECT 
OBSERVER 
ORIGIN 
PCOUNT 
PSCAL 
PTYPE 
PZERO_FITS 
REFERENC 
SIMPLE 
SPACES 
TBCOL 
TDIM 
TDISP 
TELESCOP 
TFIELDS 
TFORM 
THEAP 
TNULL 
TSCAL 
TTYPE 
TUNIT 
TZERO 
XTENSION 
ERRWORD 
ALTRPIX 
DATE_MAP 

Definition at line 247 of file fits.h.

enum casacore::FITS::ValueType

FITS I/O Error message types.

Basic FITS Data Types for keywords and data

Enumerator:
NOVALUE 
LOGICAL 
BIT 
CHAR 
BYTE 
SHORT 
LONG 
FLOAT 
DOUBLE 
COMPLEX 
ICOMPLEX 
DCOMPLEX 
VADESC 
STRING 
FSTRING 
REAL 

Definition at line 176 of file fits.h.

Constructor & Destructor Documentation

casacore::FITS::FITS (  )  [inline, private]

Definition at line 330 of file fits.h.

Member Function Documentation

static int casacore::FITS::chk_comment ( const char *  s,
int  len 
) [static]
static int casacore::FITS::ckaccum ( float &  ,
Int  ,
int   
) [static, private]
static int casacore::FITS::ckaccum ( double &  ,
Int  ,
int   
) [static, private]
int casacore::FITS::digit2bin ( char  c  )  [inline, static]

Definition at line 332 of file fits.h.

static void casacore::FITS::f2l ( FitsVADesc *  ,
void *  ,
int   
) [static]
static void casacore::FITS::f2l ( DComplex *  ,
void *  ,
int   
) [static]
static void casacore::FITS::f2l ( IComplex *  ,
void *  ,
int   
) [static]
static void casacore::FITS::f2l ( Complex *  ,
void *  ,
int   
) [static]
static void casacore::FITS::f2l ( double *  ,
void *  ,
int   
) [static]
static void casacore::FITS::f2l ( float *  ,
void *  ,
int   
) [static]
static void casacore::FITS::f2l ( long *  ,
void *  ,
int   
) [static]
static void casacore::FITS::f2l ( Int *  ,
void *  ,
int   
) [static]
static void casacore::FITS::f2l ( short *  ,
void *  ,
int   
) [static]
static void casacore::FITS::f2l ( unsigned char *  ,
void *  ,
int   
) [static]
static void casacore::FITS::f2l ( char *  ,
void *  ,
int   
) [static]
static void casacore::FITS::f2l ( FitsBit *  ,
void *  ,
int   
) [static]
static void casacore::FITS::f2l ( FitsLogical *  ,
void *  ,
int   
) [static]

data conversion routines: FITS - local

static int casacore::FITS::fitssize ( FITS::ValueType  t  )  [static]
static void casacore::FITS::fstr2str ( char *  ,
const char *  ,
int   
) [static]
static int casacore::FITS::get_comment ( const char *  s,
int  len,
int &  begpos 
) [static]
static void casacore::FITS::get_name ( const char *  s,
int  len,
FitsNameResult &  result 
) [static]
static void casacore::FITS::get_numeric ( const char *  s,
int  len,
FitsValueResult &  result 
) [static]
static void casacore::FITS::get_value ( const char *  s,
int  len,
FitsValueResult &  result 
) [static]
static int casacore::FITS::get_value_id ( const char *  s,
int  l,
int &  pos 
) [static]
static FITS::ValueType casacore::FITS::getfitstype ( NoConvert< FitsVADesc >  x  )  [inline, static]

Definition at line 208 of file fits.h.

References VADESC.

static FITS::ValueType casacore::FITS::getfitstype ( NoConvert< DComplex >  x  )  [inline, static]

Definition at line 206 of file fits.h.

References DCOMPLEX.

static FITS::ValueType casacore::FITS::getfitstype ( NoConvert< IComplex >  x  )  [inline, static]

Definition at line 204 of file fits.h.

References ICOMPLEX.

static FITS::ValueType casacore::FITS::getfitstype ( NoConvert< Complex >  x  )  [inline, static]

Definition at line 202 of file fits.h.

References COMPLEX.

static FITS::ValueType casacore::FITS::getfitstype ( NoConvert< double >  x  )  [inline, static]

Definition at line 200 of file fits.h.

References DOUBLE.

static FITS::ValueType casacore::FITS::getfitstype ( NoConvert< float >  x  )  [inline, static]

Definition at line 198 of file fits.h.

References FLOAT.

static FITS::ValueType casacore::FITS::getfitstype ( NoConvert< long >  x  )  [inline, static]

Definition at line 196 of file fits.h.

References LONG.

static FITS::ValueType casacore::FITS::getfitstype ( NoConvert< Int >  x  )  [inline, static]

Definition at line 194 of file fits.h.

References LONG.

static FITS::ValueType casacore::FITS::getfitstype ( NoConvert< short >  x  )  [inline, static]

Definition at line 192 of file fits.h.

References SHORT.

static FITS::ValueType casacore::FITS::getfitstype ( NoConvert< unsigned char >  x  )  [inline, static]

Definition at line 190 of file fits.h.

References BYTE.

static FITS::ValueType casacore::FITS::getfitstype ( NoConvert< char >  x  )  [inline, static]

Definition at line 188 of file fits.h.

References CHAR.

static FITS::ValueType casacore::FITS::getfitstype ( NoConvert< FitsBit >  x  )  [inline, static]

Definition at line 186 of file fits.h.

References BIT.

static FITS::ValueType casacore::FITS::getfitstype ( NoConvert< FitsLogical >  x  )  [inline, static]

STRING and FSTRING are used internally in parsing keywords.

Definition at line 184 of file fits.h.

References LOGICAL.

Bool casacore::FITS::isa_digit ( char  c  )  [inline, static]

Definition at line 331 of file fits.h.

References casacore::False, and casacore::True.

Bool casacore::FITS::isa_letter ( char  c  )  [inline, static]

Definition at line 334 of file fits.h.

References casacore::False, and casacore::True.

Bool casacore::FITS::isa_text ( char  c  )  [inline, static]

Definition at line 333 of file fits.h.

References casacore::False, and casacore::True.

static void casacore::FITS::l2f ( void *  ,
FitsVADesc *  ,
int   
) [static]
static void casacore::FITS::l2f ( void *  ,
DComplex *  ,
int   
) [static]
static void casacore::FITS::l2f ( void *  ,
IComplex *  ,
int   
) [static]
static void casacore::FITS::l2f ( void *  ,
Complex *  ,
int   
) [static]
static void casacore::FITS::l2f ( void *  ,
double *  ,
int   
) [static]
static void casacore::FITS::l2f ( void *  ,
float *  ,
int   
) [static]
static void casacore::FITS::l2f ( void *  ,
long *  ,
int   
) [static]
static void casacore::FITS::l2f ( void *  ,
Int *  ,
int   
) [static]
static void casacore::FITS::l2f ( void *  ,
short *  ,
int   
) [static]
static void casacore::FITS::l2f ( void *  ,
unsigned char *  ,
int   
) [static]
static void casacore::FITS::l2f ( void *  ,
char *  ,
int   
) [static]
static void casacore::FITS::l2f ( void *  ,
FitsBit *  ,
int   
) [static]
static void casacore::FITS::l2f ( void *  ,
FitsLogical *  ,
int   
) [static]
int casacore::FITS::letter2bin ( char  c  )  [inline, static]

Definition at line 335 of file fits.h.

static int casacore::FITS::localsize ( FITS::ValueType  t  )  [static]
static void casacore::FITS::parse_vatform ( const char *  s,
FITS::ValueType &  valType,
int &  maxelem 
) [static]

utility function to parse the binary table variable array column (i.e.

uses the heap) of the form nPt(dddd) where n is either 0 or 1, t is one of the standard FITS binary table column types and dddd is the maximum number of elements used by this column. If there is a format error in the input string (*s), then valType will have the value NOVALUE and maxelem will be -1.

static int casacore::FITS::str2fstr ( char *  ,
const char *  ,
int   
) [static]
static void casacore::FITS::swap2 ( void *  ,
void *  ,
int   
) [static]
static void casacore::FITS::swap4 ( void *  ,
void *  ,
int   
) [static]
static void casacore::FITS::swap8 ( void *  ,
void *  ,
int   
) [static]
double casacore::FITS::tenD ( Int  numb,
int  pow 
) [inline, static, private]

Definition at line 339 of file fits.h.

References tenpowerD.

float casacore::FITS::tenF ( Int  numb,
int  pow 
) [inline, static, private]

Definition at line 343 of file fits.h.

References tenpowerF.

static int casacore::FITS::trim_comment ( const char *  s,
int  len 
) [static]
static void casacore::FITS::valstr ( ostream &  o,
const ValueType &  ty,
const void *  val 
) [static]

Member Data Documentation

const int casacore::FITS::maxdblexp [static, private]

Definition at line 320 of file fits.h.

const int casacore::FITS::maxdigl [static, private]

Definition at line 322 of file fits.h.

const double casacore::FITS::maxdouble [static]

Definition at line 311 of file fits.h.

const int casacore::FITS::maxexpdig [static, private]

Definition at line 323 of file fits.h.

const float casacore::FITS::maxfloat [static]

Definition at line 309 of file fits.h.

const int casacore::FITS::maxfltexp [static, private]

Definition at line 318 of file fits.h.

const Int casacore::FITS::maxInt [static]

Definition at line 307 of file fits.h.

const int casacore::FITS::maxsigdigits [static, private]

Definition at line 321 of file fits.h.

const int casacore::FITS::mindblexp [static, private]

Definition at line 319 of file fits.h.

const double casacore::FITS::mindouble [static]

Definition at line 310 of file fits.h.

const float casacore::FITS::minfloat [static]

Definition at line 308 of file fits.h.

const int casacore::FITS::minfltexp [static, private]

Definition at line 317 of file fits.h.

const Int casacore::FITS::minInt [static]

Definition at line 306 of file fits.h.

ReservedFitsKeywordCollection& casacore::FITS::ResWord [static]

Definition at line 281 of file fits.h.

double casacore::FITS::tenpowerD[309] [static, private]

Definition at line 315 of file fits.h.

Referenced by tenD().

float casacore::FITS::tenpowerF[39] [static, private]

Definition at line 316 of file fits.h.

Referenced by tenF().

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on 31 Aug 2016 for casa by  doxygen 1.6.1