ObitIOUVFITS.h File Reference

#include "fitsio.h"
#include "Obit.h"
#include "ObitIO.h"
#include "ObitUVDesc.h"
#include "ObitUVSel.h"
#include "ObitIOUVFITSDef.h"

Go to the source code of this file.

Classes

struct ObitIOUVFITS

ObitIOUVFITS Class structure. More...

struct ObitIOUVFITSClassInfo

ClassInfo Structure. More...

Defines

#define ObitIOUVFITSUnref(in)   ObitUnref (in)

Macro to unreference (and possibly destroy) an ObitIOUVFITS returns a ObitIOUVFITS* (NULL).

#define ObitIOUVFITSRef(in)   ObitRef (in)

Macro to reference (update reference count) an ObitIOUVFITS.

#define ObitIOUVFITSIsA(in)   ObitIsA (in, ObitIOUVFITSGetClass())

Macro to determine if an object is the member of this or a derived class.

Functions

void ObitIOUVFITSClassInit (void)

Public: Class initializer.

ObitIOUVFITS * newObitIOUVFITS (gchar *name, ObitInfoList *info, ObitErr *err)

Public: Constructor.

gconstpointer ObitIOUVFITSGetClass (void)

Public: ClassInfo pointer.

ObitIOUVFITS * ObitIOUVFITSCopy (ObitIOUVFITS *in, ObitIOUVFITS *out, ObitErr *err)

Public: Copy constructor.

gboolean ObitIOUVFITSSame (ObitIO *in, ObitInfoList *in1, ObitInfoList *in2, ObitErr *err)

Public: Are underlying structures the same.

void ObitIOUVFITSRename (ObitIO *in, ObitInfoList *info, ObitErr *err)

Public: Rename underlying structures.

void ObitIOUVFITSZap (ObitIOUVFITS *in, ObitErr *err)

Public: Delete underlying structures.

ObitIOCode ObitIOUVFITSOpen (ObitIOUVFITS *in, ObitIOAccess access, ObitInfoList *info, ObitErr *err)

Public: Open.

ObitIOCode ObitIOUVFITSClose (ObitIOUVFITS *in, ObitErr *err)

Public: Close.

ObitIOCode ObitIOUVFITSSet (ObitIOUVFITS *in, ObitInfoList *info, ObitErr *err)

Public: Init I/O.

ObitIOCode ObitIOUVFITSRead (ObitIOUVFITS *in, gfloat *data, ObitErr *err)

Public: Read.

ObitIOCode ObitIOUVFITSWrite (ObitIOUVFITS *in, gfloat *data, ObitErr *err)

Public: Write.

ObitIOCode ObitIOUVFITSFlush (ObitIOUVFITS *in, ObitErr *err)

Public: Flush.

ObitIOCode ObitIOUVFITSReadDescriptor (ObitIOUVFITS *in, ObitErr *err)

Public: Read Descriptor.

ObitIOCode ObitIOUVFITSWriteDescriptor (ObitIOUVFITS *in, ObitErr *err)

Public: Write Descriptor.

void ObitIOUVFITSCreateBuffer (gfloat **data, glong *size, ObitIOUVFITS *in, ObitInfoList *info, ObitErr *err)

Public: Create buffer.

Obit * newObitIOUVFITSTable (ObitIOUVFITS *in, ObitIOAccess access, gchar *tabType, glong *tabVer, ObitErr *err)

Public: Create an associated Table Typed as base class to avoid problems.

ObitIOCode ObitIOUVFITSUpdateTables (ObitIOUVFITS *in, ObitInfoList *info, ObitErr *err)

Public: Update disk resident tables information.

Detailed Description

ObitIOUVFITS class definition.

This class provides an interface to the cfitsio package for FITS uv data.

This class is derived from the ObitIO class.

Usage

Instances of this class are for access to FITS uv data files using the cfitsio package. Instances can be made using the newObitIOUVFITS constructor, or the ObitIOUVFITSCopy copy constructor and pointers copied (with reference pointer update) using ObitIORef. The destructor (when reference count goes to zero) is ObitIOUnref. This class should seldom need be accessed directly outside of the ObitIO class. Parameters needed (passed via ObitInfoList) are:

"IOBy" OBIT_int (1,1,1) an ObitIOSize enum defined in ObitIO.h giving values OBIT_IO_byRow or OBIT_IO_byPlane to specify if the data transfers are to be by row or plane at a time.
"FileName" OBIT_string (?,1,1) Name of disk file.

Define Documentation

#define ObitIOUVFITSIsA ( in ) ObitIsA (in, ObitIOUVFITSGetClass())

Macro to determine if an object is the member of this or a derived class.
Returns TRUE if a member, else FALSE in = object to reference

#define ObitIOUVFITSRef ( in ) ObitRef (in)

Macro to reference (update reference count) an ObitIOUVFITS.
returns a ObitIOUVFITS*. in = object to reference

#define ObitIOUVFITSUnref ( in ) ObitUnref (in)

Macro to unreference (and possibly destroy) an ObitIOUVFITS returns a ObitIOUVFITS* (NULL).
in = object to unreference.

Function Documentation

ObitIOUVFITS* newObitIOUVFITS ( gchar * name,

ObitInfoList * info,

ObitErr * err

)

Public: Constructor.
Initializes class on the first call.
Parameters:

name An optional name for the object.

info if non-NULL it is used to initialize the new object.

err ObitErr for error messages.

Returns:
the new object.

Obit* newObitIOUVFITSTable ( ObitIOUVFITS * in,

ObitIOAccess access,

gchar * tabType,

glong * tabVer,

ObitErr * err

)

Public: Create an associated Table Typed as base class to avoid problems.
If such an object exists, a reference to it is returned, else a new object is created and entered in the ObitTableList. Returned object is typed an Obit to prevent circular definitions between the ObitTable and the ObitIO classes.
Parameters:

in Pointer to object with associated tables. This MUST have been opened before this call.

access access (OBIT_IO_ReadOnly,OBIT_IO_ReadWrite, or OBIT_IO_WriteOnly). This is used to determine defaulted version number and a different value may be used for the actual Open.

tabType The table type (e.g. "AIPS CC").

tabVer Desired version number, may be zero in which case the highest extant version is returned for read and the highest+1 for OBIT_IO_WriteOnly.

err ObitErr for reporting errors.

Returns:
pointer to created ObitTable, NULL on failure.

void ObitIOUVFITSClassInit ( void )

Public: Class initializer.

ObitIOCode ObitIOUVFITSClose ( ObitIOUVFITS * in,

ObitErr * err

)

Public: Close.

Parameters:

in Pointer to object to be closed.

err ObitErr for reporting errors.

Returns:
error code, 0=> OK

ObitIOUVFITS* ObitIOUVFITSCopy ( ObitIOUVFITS * in,

ObitIOUVFITS * out,

ObitErr * err

)

Public: Copy constructor.
The result will have pointers to the more complex members. Parent class members are included but any derived class info is ignored.
Parameters:

in The object to copy

out An existing object pointer for output or NULL if none exists.

err Obit error stack object.

Returns:
pointer to the new object.

void ObitIOUVFITSCreateBuffer ( gfloat ** data,

glong * size,

ObitIOUVFITS * in,

ObitInfoList * info,

ObitErr * err

)

Public: Create buffer.
Should be called after ObitIO is opened.
Parameters:

data (output) pointer to data array

size (output) size of data array in floats.

in Pointer to object to be accessed.

info ObitInfoList with instructions

err ObitErr for reporting errors.

ObitIOCode ObitIOUVFITSFlush ( ObitIOUVFITS * in,

ObitErr * err

)

Public: Flush.

Parameters:

in Pointer to object to be accessed.

err ObitErr for reporting errors.

Returns:
return code, 0=> OK

gconstpointer ObitIOUVFITSGetClass ( void )

Public: ClassInfo pointer.
Initializes class if needed on first call.
Returns:
pointer to the class structure.

ObitIOCode ObitIOUVFITSOpen ( ObitIOUVFITS * in,

ObitIOAccess access,

ObitInfoList * info,

ObitErr * err

)

Public: Open.
The file etc. info should have been stored in the ObitInfoList. The image descriptor is read if ReadOnly or ReadOnly and written to disk if opened WriteOnly. For accessing FITS files the following entries in the ObitInfoList are used:

"Disk" OBIT_int (1,1,1) FITS "disk" number.

"FileName" OBIT_string (?,1,1) FITS file name.
Parameters:

in Pointer to object to be opened.

access access (OBIT_IO_ReadOnly,OBIT_IO_ReadWrite)

info ObitInfoList with instructions for opening

err ObitErr for reporting errors.

Returns:
return code, 0=> OK

ObitIOCode ObitIOUVFITSRead ( ObitIOUVFITS * in,

gfloat * data,

ObitErr * err

)

Public: Read.
The number read will be mySel->nVisPIO (until the end of the selected range of visibilities in which case it will be smaller). The first visibility number after a read is myDesc->firstVis and the number of visibilities attempted is mySel->numVisRead; actual value saved as myDesc->numVisBuff. When OBIT_IO_EOF is returned all data has been read (then is no new data in data) and the I/O has been closed.
Parameters:

in Pointer to object to be read.

data pointer to buffer to write results.

err ObitErr for reporting errors.

Returns:
return code, 0=> OK

ObitIOCode ObitIOUVFITSReadDescriptor ( ObitIOUVFITS * in,

ObitErr * err

)

Public: Read Descriptor.

Parameters:

in Pointer to object with ObitUVDesc to be read.

err ObitErr for reporting errors.

Returns:
return code, 0=> OK

void ObitIOUVFITSRename ( ObitIO * in,

ObitInfoList * info,

ObitErr * err

)

Public: Rename underlying structures.
New name information is given on the info member:

"newFileName" OBIT_string (?,1,1) New Name of disk file.
Parameters:

in Pointer to object to be renamed

info Associated ObitInfoList

err ObitErr for reporting errors.

gboolean ObitIOUVFITSSame ( ObitIO * in,

ObitInfoList * in1,

ObitInfoList * in2,

ObitErr * err

)

Public: Are underlying structures the same.
This test is done using values entered into the ObitInfoList in case the object has not yet been opened.
Parameters:

in ObitIO for test

in1 ObitInfoList for first object to be tested

in2 ObitInfoList for second object to be tested

err ObitErr for reporting errors.

Returns:
TRUE if to objects have the same underlying structures else FALSE

ObitIOCode ObitIOUVFITSSet ( ObitIOUVFITS * in,

ObitInfoList * info,

ObitErr * err

)

Public: Init I/O.

Parameters:

in Pointer to object to be accessed.

info ObitInfoList with instructions

err ObitErr for reporting errors.

Returns:
return code, 0=> OK

ObitIOCode ObitIOUVFITSUpdateTables ( ObitIOUVFITS * in,

ObitInfoList * info,

ObitErr * err

)

Public: Update disk resident tables information.
Nothing is needed for FITS files.
Parameters:

in Pointer to object to be updated.

info ObitInfoList of parent object (not used here).

err ObitErr for reporting errors.

Returns:
return code, OBIT_IO_OK=> OK

ObitIOCode ObitIOUVFITSWrite ( ObitIOUVFITS * in,

gfloat * data,

ObitErr * err

)

Public: Write.
The data in the buffer will be written starting at visibility myDesc->firstVis and the number written will be myDesc->numVisBuff which should not exceed mySel->nVisPIO if the internal buffer is used. myDesc->firstVis will be maintained and need not be changed for sequential writing.
Parameters:

in Pointer to object to be written.

data pointer to buffer containing input data.

err ObitErr for reporting errors.

Returns:
return code, 0=> OK

ObitIOCode ObitIOUVFITSWriteDescriptor ( ObitIOUVFITS * in,

ObitErr * err

)

Public: Write Descriptor.

Parameters:

in Pointer to object with ObitUVDesc to be written.

err ObitErr for reporting errors.

Returns:
return code, 0=> OK

void ObitIOUVFITSZap ( ObitIOUVFITS * in,

ObitErr * err

)

Public: Delete underlying structures.
Delete the whole FITS file.
Parameters:

in Pointer to object to be zapped.

err ObitErr for reporting errors.

Generated on Fri Aug 31 22:13:07 2007 for Obit by

1.3.9.1


Classes
struct	ObitIOUVFITS
	ObitIOUVFITS Class structure. More...
struct	ObitIOUVFITSClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitIOUVFITSUnref(in) ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitIOUVFITS returns a ObitIOUVFITS* (NULL).
#define	ObitIOUVFITSRef(in) ObitRef (in)
	Macro to reference (update reference count) an ObitIOUVFITS.
#define	ObitIOUVFITSIsA(in) ObitIsA (in, ObitIOUVFITSGetClass())
	Macro to determine if an object is the member of this or a derived class.
Functions
void	ObitIOUVFITSClassInit (void)
	Public: Class initializer.
ObitIOUVFITS *	newObitIOUVFITS (gchar name, ObitInfoList info, ObitErr *err)
	Public: Constructor.
gconstpointer	ObitIOUVFITSGetClass (void)
	Public: ClassInfo pointer.
ObitIOUVFITS *	ObitIOUVFITSCopy (ObitIOUVFITS in, ObitIOUVFITS out, ObitErr *err)
	Public: Copy constructor.
gboolean	ObitIOUVFITSSame (ObitIO in, ObitInfoList in1, ObitInfoList in2, ObitErr err)
	Public: Are underlying structures the same.
void	ObitIOUVFITSRename (ObitIO in, ObitInfoList info, ObitErr *err)
	Public: Rename underlying structures.
void	ObitIOUVFITSZap (ObitIOUVFITS in, ObitErr err)
	Public: Delete underlying structures.
ObitIOCode	ObitIOUVFITSOpen (ObitIOUVFITS in, ObitIOAccess access, ObitInfoList info, ObitErr *err)
	Public: Open.
ObitIOCode	ObitIOUVFITSClose (ObitIOUVFITS in, ObitErr err)
	Public: Close.
ObitIOCode	ObitIOUVFITSSet (ObitIOUVFITS in, ObitInfoList info, ObitErr *err)
	Public: Init I/O.
ObitIOCode	ObitIOUVFITSRead (ObitIOUVFITS in, gfloat data, ObitErr *err)
	Public: Read.
ObitIOCode	ObitIOUVFITSWrite (ObitIOUVFITS in, gfloat data, ObitErr *err)
	Public: Write.
ObitIOCode	ObitIOUVFITSFlush (ObitIOUVFITS in, ObitErr err)
	Public: Flush.
ObitIOCode	ObitIOUVFITSReadDescriptor (ObitIOUVFITS in, ObitErr err)
	Public: Read Descriptor.
ObitIOCode	ObitIOUVFITSWriteDescriptor (ObitIOUVFITS in, ObitErr err)
	Public: Write Descriptor.
void	ObitIOUVFITSCreateBuffer (gfloat *data, glong size, ObitIOUVFITS in, ObitInfoList info, ObitErr *err)
	Public: Create buffer.
Obit *	newObitIOUVFITSTable (ObitIOUVFITS in, ObitIOAccess access, gchar tabType, glong tabVer, ObitErr err)
	Public: Create an associated Table Typed as base class to avoid problems.
ObitIOCode	ObitIOUVFITSUpdateTables (ObitIOUVFITS in, ObitInfoList info, ObitErr *err)
	Public: Update disk resident tables information.