casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Protected Attributes
FITSreader Class Reference

ATNF single-dish FITS reader. More...

#include <FITSreader.h>

Inheritance diagram for FITSreader:
GBTFITSreader MBFITSreader SDFITSreader

List of all members.

Public Member Functions

virtual ~FITSreader ()
 Destructor.
virtual int open (char *FITSname, int &nBeam, int *&beams, int &nIF, int *&IFs, int *&nChan, int *&nPol, int *&haveXPol, int &haveBase, int &haveSpectra, int &extraSysCal)=0
 Open the FITS file for reading.
virtual int getHeader (char observer[32], char project[32], char telescope[32], double antPos[3], char obsType[32], char bunit[32], float &equinox, char radecsys[32], char dopplerFrame[32], char datobs[32], double &utc, double &refFreq, double &bandwidth)=0
 Get metadata.
virtual int getFreqInfo (int &nIF, double *&startFreq, double *&endFreq)=0
 Get frequency parameters for each IF.
int select (const int startChan[], const int endChan[], const int refChan[], const int getSpectra=1, const int getXPol=0, const int getFeedPos=0, const int getPointing=0, const int coordSys=0)
 Set data selection criteria.
virtual int findRange (int &nRow, int &nSel, char dateSpan[2][32], double utcSpan[2], double *&positions)=0
 Find the range in time and position of the data selected.
virtual int read (MBrecord &record)=0
 Read the next data record.
virtual void close (void)=0
 Close the RPFITS file.

Protected Attributes

int * cBeams
int * cEndChan
int cGetFeedPos
int cCoordSys
int cGetSpectra
int cGetXPol
int cHaveBase
int cHaveSpectra
int * cHaveXPol
int * cIFs
int cNBeam
int * cNChan
int cNIF
int * cNPol
int * cRefChan
int * cStartChan
char cMsg [256]
 For use in constructing messages.

Detailed Description

ATNF single-dish FITS reader.

class FITSreader

Definition at line 52 of file FITSreader.h.


Constructor & Destructor Documentation

virtual FITSreader::~FITSreader ( ) [inline, virtual]

Destructor.

Definition at line 56 of file FITSreader.h.


Member Function Documentation

virtual void FITSreader::close ( void  ) [pure virtual]

Close the RPFITS file.

Implemented in GBTFITSreader, SDFITSreader, and MBFITSreader.

virtual int FITSreader::findRange ( int &  nRow,
int &  nSel,
char  dateSpan[2][32],
double  utcSpan[2],
double *&  positions 
) [pure virtual]

Find the range in time and position of the data selected.

Implemented in GBTFITSreader, SDFITSreader, and MBFITSreader.

virtual int FITSreader::getFreqInfo ( int &  nIF,
double *&  startFreq,
double *&  endFreq 
) [pure virtual]

Get frequency parameters for each IF.

Implemented in GBTFITSreader, SDFITSreader, and MBFITSreader.

virtual int FITSreader::getHeader ( char  observer[32],
char  project[32],
char  telescope[32],
double  antPos[3],
char  obsType[32],
char  bunit[32],
float &  equinox,
char  radecsys[32],
char  dopplerFrame[32],
char  datobs[32],
double &  utc,
double &  refFreq,
double &  bandwidth 
) [pure virtual]

Get metadata.

Implemented in GBTFITSreader, SDFITSreader, and MBFITSreader.

virtual int FITSreader::open ( char *  FITSname,
int &  nBeam,
int *&  beams,
int &  nIF,
int *&  IFs,
int *&  nChan,
int *&  nPol,
int *&  haveXPol,
int &  haveBase,
int &  haveSpectra,
int &  extraSysCal 
) [pure virtual]

Open the FITS file for reading.

Returns a pointer, beams, to an array of length nBeam that indicates which beams are present in the data. Beam selection is done by zeroing the unwanted elements of this array. Likewise for IF selection (e.g. for frequency-switched data).

Implemented in GBTFITSreader, SDFITSreader, and MBFITSreader.

virtual int FITSreader::read ( MBrecord record) [pure virtual]

Read the next data record.

Parameters:
recordPKSMBrecord &record) = 0;

Implemented in GBTFITSreader, SDFITSreader, and MBFITSreader.

int FITSreader::select ( const int  startChan[],
const int  endChan[],
const int  refChan[],
const int  getSpectra = 1,
const int  getXPol = 0,
const int  getFeedPos = 0,
const int  getPointing = 0,
const int  coordSys = 0 
)

Set data selection criteria.

Channel numbering is 1-relative, zero or negative channel numbers are taken to be offsets from the last channel. Coordinate systems are 0: equatorial (RA,Dec), 1: horizontal (Az,El), 2: feed-plane, 3: zenithal position angle of feed and elevation, (ZPA,El).


Member Data Documentation

int* FITSreader::cBeams [protected]

Definition at line 132 of file FITSreader.h.

int FITSreader::cCoordSys [protected]

Definition at line 132 of file FITSreader.h.

int * FITSreader::cEndChan [protected]

Definition at line 132 of file FITSreader.h.

int FITSreader::cGetFeedPos [protected]

Definition at line 132 of file FITSreader.h.

int FITSreader::cGetSpectra [protected]

Definition at line 132 of file FITSreader.h.

int FITSreader::cGetXPol [protected]

Definition at line 132 of file FITSreader.h.

int FITSreader::cHaveBase [protected]

Definition at line 132 of file FITSreader.h.

int FITSreader::cHaveSpectra [protected]

Definition at line 132 of file FITSreader.h.

int * FITSreader::cHaveXPol [protected]

Definition at line 132 of file FITSreader.h.

int * FITSreader::cIFs [protected]

Definition at line 132 of file FITSreader.h.

char FITSreader::cMsg[256] [protected]

For use in constructing messages.

Definition at line 137 of file FITSreader.h.

int FITSreader::cNBeam [protected]

Definition at line 132 of file FITSreader.h.

int * FITSreader::cNChan [protected]

Definition at line 132 of file FITSreader.h.

int FITSreader::cNIF [protected]

Definition at line 132 of file FITSreader.h.

int * FITSreader::cNPol [protected]

Definition at line 132 of file FITSreader.h.

int * FITSreader::cRefChan [protected]

Definition at line 132 of file FITSreader.h.

int * FITSreader::cStartChan [protected]

Definition at line 132 of file FITSreader.h.


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