Main Page | Class List | Directories | File List | Class Members | File Members
include

ObitIOUVAIPS.h File Reference

ObitIOUVAIPS class definition. More...

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

Go to the source code of this file.

Classes

struct  ObitIOUVAIPS
 ObitIOUVAIPS Class structure. More...
struct  ObitIOUVAIPSClassInfo
 ClassInfo Structure. More...

Defines

#define ObitIOUVAIPSUnref(in)   ObitUnref (in)
 Macro to unreference (and possibly destroy) an ObitIOUVAIPS returns a ObitIOUVUVAIPS* (NULL).
#define ObitIOUVAIPSRef(in)   ObitRef (in)
 Macro to reference (update reference count) an ObitIOUVAIPS.
#define ObitIOUVAIPSIsA(in)   ObitIsA (in, ObitIOUVAIPSGetClass())
 Macro to determine if an object is the member of this or a derived class.

Functions

void ObitIOUVAIPSClassInit (void)
 Public: Class initializer.
ObitIOUVAIPS * newObitIOUVAIPS (gchar *name, ObitInfoList *info, ObitErr *err)
 Public: Constructor.
gconstpointer ObitIOUVAIPSGetClass (void)
 Public: ClassInfo pointer.
gboolean ObitIOUVAIPSSame (ObitIO *in, ObitInfoList *in1, ObitInfoList *in2, ObitErr *err)
 Public: Are underlying structures the same.
void ObitIOUVAIPSRename (ObitIO *in, ObitInfoList *info, ObitErr *err)
 Public: Rename underlying structures.
void ObitIOUVAIPSZap (ObitIOUVAIPS *in, ObitErr *err)
 Public: Delete underlying structures.
ObitIOUVAIPS * ObitIOUVAIPSCopy (ObitIOUVAIPS *in, ObitIOUVAIPS *out, ObitErr *err)
 Public: Copy constructor.
ObitIOCode ObitIOUVAIPSOpen (ObitIOUVAIPS *in, ObitIOAccess access, ObitInfoList *info, ObitErr *err)
 Public: Open.
ObitIOCode ObitIOUVAIPSClose (ObitIOUVAIPS *in, ObitErr *err)
 Public: Close.
ObitIOCode ObitIOUVAIPSSet (ObitIOUVAIPS *in, ObitInfoList *info, ObitErr *err)
 Public: Init I/O.
ObitIOCode ObitIOUVAIPSRead (ObitIOUVAIPS *in, gfloat *data, ObitErr *err)
 Public: Read.
ObitIOCode ObitIOUVAIPSWrite (ObitIOUVAIPS *in, gfloat *data, ObitErr *err)
 Public: Write.
ObitIOCode ObitIOUVAIPSFlush (ObitIOUVAIPS *in, ObitErr *err)
 Public: Flush.
ObitIOCode ObitIOUVAIPSReadDescriptor (ObitIOUVAIPS *in, ObitErr *err)
 Public: Read Descriptor.
ObitIOCode ObitIOUVAIPSWriteDescriptor (ObitIOUVAIPS *in, ObitErr *err)
 Public: Write Descriptor.
void ObitIOUVAIPSCreateBuffer (gfloat **data, glong *size, ObitIOUVAIPS *in, ObitInfoList *info, ObitErr *err)
 Public: Create buffer.
Obit * newObitIOUVAIPSTable (ObitIOUVAIPS *in, ObitIOAccess access, gchar *tabType, glong *tabver, ObitErr *err)
 Public: Create an associated Table Typed as base class to avoid problems.
ObitIOCode ObitIOUVAIPSUpdateTables (ObitIOUVAIPS *in, ObitInfoList *info, ObitErr *err)
 Public: Update disk resident tables information.

Detailed Description

ObitIOUVAIPS class definition.

This class is derived from the ObitIO class.

Usage

Instances of this class are for access to AIPS uv data files. The ObitAIPS class must be initialized before accessing AIPS files; this uses ObitAIPSClassInit. Instances can be made using the newObitIOUVAIPS constructor, or the ObitIOUVAIPSCopy 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:

Define Documentation

#define ObitIOUVAIPSIsA (  in   )     ObitIsA (in, ObitIOUVAIPSGetClass())
 

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 ObitIOUVAIPSRef (  in   )     ObitRef (in)
 

Macro to reference (update reference count) an ObitIOUVAIPS.

returns a ObitIOUVAIPS*. in = object to reference

#define ObitIOUVAIPSUnref (  in   )     ObitUnref (in)
 

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

  • in = object to unreference.

Function Documentation

ObitIOUVAIPS* newObitIOUVAIPS (  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* newObitIOUVAIPSTable (  ObitIOUVAIPS *  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 ObitIOUVAIPSClassInit (  void   ) 
 

Public: Class initializer.

ObitIOCode ObitIOUVAIPSClose (  ObitIOUVAIPS *  in,
ObitErr *  err
) 
 

Public: Close.

Parameters:
in Pointer to object to be closed.
err ObitErr for reporting errors.
Returns:
error code, 0=> OK

ObitIOUVAIPS* ObitIOUVAIPSCopy (  ObitIOUVAIPS *  in,
ObitIOUVAIPS *  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 ObitIOUVAIPSCreateBuffer (  gfloat **  data,
glong *  size,
ObitIOUVAIPS *  in,
ObitInfoList *  info,
ObitErr *  err
) 
 

Public: Create buffer.

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 ObitIOUVAIPSFlush (  ObitIOUVAIPS *  in,
ObitErr *  err
) 
 

Public: Flush.

Parameters:
in Pointer to object to be accessed.
err ObitErr for reporting errors.
Returns:
return code, 0=> OK

gconstpointer ObitIOUVAIPSGetClass (  void   ) 
 

Public: ClassInfo pointer.

Initializes class if needed on first call.

Returns:
pointer to the class structure.

ObitIOCode ObitIOUVAIPSOpen (  ObitIOUVAIPS *  in,
ObitIOAccess  access,
ObitInfoList *  info,
ObitErr *  err
) 
 

Public: Open.

The file etc. info should have been stored in the ObitInfoList.

Parameters:
in Pointer to object to be opened.
access access (OBIT_IO_ReadOnly,OBIT_IO_ReadWrite, OBIT_IO_ReadCal).
info ObitInfoList with instructions for opening
err ObitErr for reporting errors.
Returns:
return code, 0=> OK

ObitIOCode ObitIOUVAIPSRead (  ObitIOUVAIPS *  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 ObitIOUVAIPSReadDescriptor (  ObitIOUVAIPS *  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 ObitIOUVAIPSRename (  ObitIO *  in,
ObitInfoList *  info,
ObitErr *  err
) 
 

Public: Rename underlying structures.

New name information is given on the info member:

  • "newName" OBIT_string (12,1,1) New AIPS Name absent or Blank = don't change
  • "newClass" OBIT_string (6,1,1) New AIPS Class absent or Blank = don't changeO
  • "newSeq" OBIT_int (1,1,1) New AIPS Sequence 0 => unique value
    Parameters:
    in Pointer to object to be zapped.
    info Associated ObitInfoList
  • "Disk" OBIT_int (1,1,1) Disk number
  • "CNO" OBIT_int (1,1,1) Catalog slot number
  • "newName" OBIT_string (12,1,1) New AIPS Name absent or Blank = don't change
  • "newClass" OBIT_string (6,1,1) New AIPS Class absent or Blank = don't changeO
  • "newSeq" OBIT_int (1,1,1) New AIPS Sequence 0 => unique value
    Parameters:
    err ObitErr for reporting errors.

gboolean ObitIOUVAIPSSame (  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 ObitIOUVAIPSSet (  ObitIOUVAIPS *  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 ObitIOUVAIPSUpdateTables (  ObitIOUVAIPS *  in,
ObitInfoList *  info,
ObitErr *  err
) 
 

Public: Update disk resident tables information.

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 ObitIOUVAIPSWrite (  ObitIOUVAIPS *  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 ObitIOUVAIPSWriteDescriptor (  ObitIOUVAIPS *  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 ObitIOUVAIPSZap (  ObitIOUVAIPS *  in,
ObitErr *  err
) 
 

Public: Delete underlying structures.

Parameters:
in Pointer to object to be zapped.
err ObitErr for reporting errors.

Generated on Fri Aug 31 22:13:06 2007 for Obit by  doxygen 1.3.9.1