ObitTableVL.h File Reference

ObitTableVL class definition. More...

#include "Obit.h"
#include "ObitErr.h"
#include "ObitTable.h"
#include "ObitData.h"

Go to the source code of this file.

Classes
struct	ObitTableVL
	ObitTableVL Class structure. More...
struct	ObitTableVLRow
	ObitTableVLRow Class structure. More...
struct	ObitTableVLClassInfo
	ClassInfo Structure. More...
struct	ObitTableVLRowClassInfo
	ClassInfo Structure For TableVLRow. More...
Defines
#define	MAXKEYCHARTABLEVL   24
	Number of characters for Table keyword.
#define	ObitTableVLUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitTableVL returns an ObitTableVL*.
#define	ObitTableVLRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitTableVL.
#define	ObitTableVLIsA(in)   ObitIsA (in, ObitTableVLGetClass())
	Macro to determine if an object is the member of this or a derived class.
#define	ObitTableVLRowUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitTableVLRow returns an ObitTableVLRow*.
#define	ObitTableVLRowRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitTableVLRow.
#define	ObitTableVLRowIsA(in)   ObitIsA (in, ObitTableVLRowGetClass())
	Macro to determine if an object is the member of this or a derived class.
Functions
void	ObitTableVLRowClassInit (void)
	Public: Row Class initializer.
ObitTableVLRow *	newObitTableVLRow (ObitTableVL *table)
	Public: Constructor.
gconstpointer	ObitTableVLRowGetClass (void)
	Public: ClassInfo pointer.
void	ObitTableVLClassInit (void)
	Public: Class initializer.
ObitTableVL *	newObitTableVL (gchar *name)
	Public: Constructor.
ObitTableVL *	newObitTableVLValue (gchar *name, ObitData *file, glong *ver, ObitIOAccess access, ObitErr *err)
	Public: Constructor from values.
gconstpointer	ObitTableVLGetClass (void)
	Public: ClassInfo pointer.
ObitTableVL *	ObitTableVLCopy (ObitTableVL *in, ObitTableVL *out, ObitErr *err)
	Public: Copy (deep) constructor.
ObitTableVL *	ObitTableVLClone (ObitTableVL *in, ObitTableVL *out)
	Public: Copy (shallow) constructor.
ObitTableVL *	ObitTableVLConvert (ObitTable *in)
	Public: Convert an ObitTable to an ObitTableVL.
ObitIOCode	ObitTableVLOpen (ObitTableVL *in, ObitIOAccess access, ObitErr *err)
	Public: Create ObitIO structures and open file.
ObitIOCode	ObitTableVLReadRow (ObitTableVL *in, glong iVLRow, ObitTableVLRow *row, ObitErr *err)
	Public: Read a table row.
void	ObitTableVLSetRow (ObitTableVL *in, ObitTableVLRow *row, ObitErr *err)
	Public: Init a table row for write.
ObitIOCode	ObitTableVLWriteRow (ObitTableVL *in, glong iVLRow, ObitTableVLRow *row, ObitErr *err)
	Public: Write a table row.
ObitIOCode	ObitTableVLClose (ObitTableVL *in, ObitErr *err)
	Public: Close file and become inactive.

---

Detailed Description

ObitTableVL class definition.

This class is derived from the ObitTable class.

This class contains tabular data and allows access. "AIPS VL" contains a catalog of sources in the format produced for the NVSS survey. The table contains an index in the INDEX?? keywords that give the first table row number (1-rel) for a given hour of RA. An ObitTableVL is the front end to a persistent disk resident structure. Both FITS and AIPS cataloged data are supported. This class is derived from the ObitTable class.

This class contains tabular data and allows access. "AIPS VL" table An ObitTableVL is the front end to a persistent disk resident structure. Both FITS (as Tables) and AIPS cataloged data are supported.

HistoryTable data storage

In memory tables are stored in a fashion similar to how they are stored on disk - in large blocks in memory rather than structures. Due to the word alignment requirements of some machines, they are stored by order of the decreasing element size: double, float long, int, short, char rather than the logical order. The details of the storage in the buffer are kept in the #ObitTableVLDesc.

In addition to the normal tabular data, a table will have a "_status" column to indicate the status of each row. The status value is read from and written to (some modification) AIPS tables but are not written to externally generated FITS tables which don't have these colummns. It will be written to Obit generated tables which will have these columns. Status values:

• status = 0 => normal
• status = 1 => row has been modified (or created) and needs to be written.
• status = -1 => row has been marked invalid.

Specifying desired data transfer parameters

The desired data transfers are specified in the member ObitInfoList. There are separate sets of parameters used to specify the FITS or AIPS data files. In the following an ObitInfoList entry is defined by the name in double quotes, the data type code as an #ObitInfoType enum and the dimensions of the array (? => depends on application). To specify whether the underlying data files are FITS or AIPS

• "FileType" OBIT_int (1,1,1) OBIT_IO_FITS or OBIT_IO_AIPS which are values of an #ObitIOType enum defined in ObitIO.h.

The following apply to both types of files:

• "nRowPIO", OBIT_int, Max. Number of visibilities per "Read" or "Write" operation. Default = 1.

FITS files

This implementation uses cfitsio which allows using, in addition to regular FITS images, gzip compressed files, pipes, shared memory and a number of other input forms. The convenience Macro #ObitTableVLSetFITS simplifies specifying the desired data. Binary tables are used for storing visibility data in FITS. For accessing FITS files the following entries in the ObitInfoList are used:

• "FileName" OBIT_string (?,1,1) FITS file name.
• "TabName" OBIT_string (?,1,1) Table name (e.g. "AIPS CC").
• "Ver" OBIT_int (1,1,1) Table version number

subsection ObitTableVLAIPS AIPS files The ObitAIPS class must be initialized before accessing AIPS files; this uses ObitAIPSClassInit. For accessing AIPS files the following entries in the ObitInfoList are used:

• "Disk" OBIT_int (1,1,1) AIPS "disk" number.
• "User" OBIT_int (1,1,1) user number.
• "CNO" OBIT_int (1,1,1) AIPS catalog slot number.
• "TableType" OBIT_string (2,1,1) AIPS Table type
• "Ver" OBIT_int (1,1,1) AIPS table version number.

Creators and Destructors

An ObitTableVL can be created using newObitTableVLValue which attaches the table to an ObitData for the object. If the output ObitTableVL has previously been specified, including file information, then ObitTableVLCopy will copy the disk resident as well as the memory resident information.

A copy of a pointer to an ObitTableVL should always be made using the ObitTableVLRef function which updates the reference count in the object. Then whenever freeing an ObitTableVL or changing a pointer, the function ObitTableVLUnref will decrement the reference count and destroy the object when the reference count hits 0.

I/O

Visibility data is available after an input object is "Opened" and "Read". I/O optionally uses a buffer attached to the ObitTableVL or some external location. To Write an ObitTableVL, create it, open it, and write. The object should be closed to ensure all data is flushed to disk. Deletion of an ObitTableVL after its final unreferencing will automatically close it.

---

Define Documentation

#define MAXKEYCHARTABLEVL   24

Number of characters for Table keyword.

#define ObitTableVLIsA (  in   )     ObitIsA (in, ObitTableVLGetClass())

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

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

#define ObitTableVLRowIsA (  in   )     ObitIsA (in, ObitTableVLRowGetClass())

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

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

#define ObitTableVLRowUnref (  in   )     ObitUnref (in)

Macro to unreference (and possibly destroy) an ObitTableVLRow returns an ObitTableVLRow*. in = object to unreference

#define ObitTableVLUnref (  in   )     ObitUnref (in)

Macro to unreference (and possibly destroy) an ObitTableVL returns an ObitTableVL*. in = object to unreference

---

Function Documentation

ObitTableVL* newObitTableVL (  gchar *  name  )

Public: Constructor. Initializes class if needed on first call. Parameters: name  An optional name for the object. Returns: the new object.

ObitTableVLRow* newObitTableVLRow (  ObitTableVL *  table  )

Public: Constructor. If table is open and for write, the row is attached to the buffer Initializes Row class if needed on first call. Parameters: name  An optional name for the object. Returns: the new object.

ObitTableVL* newObitTableVLValue (  gchar *  name, ObitData *  file, glong *  ver, ObitIOAccess  access, ObitErr *  err )

Public: Constructor from values. Creates a new table structure and attaches to the TableList of file. If the specified table already exists then it is returned. Initializes class if needed on first call. Forces an update of any disk resident structures (e.g. AIPS header). Parameters: name  An optional name for the object. file  ObitData which which the table is to be associated. ver  Table version number. 0=> add higher, value used returned access  access (OBIT_IO_ReadOnly, means do not create if it doesn't exist. err  Error stack, returns if not empty. Returns: the new object, NULL on failure.

void ObitTableVLClassInit (  void   )

Public: Class initializer.

ObitTableVL* ObitTableVLClone (  ObitTableVL *  in, ObitTableVL *  out )

Public: Copy (shallow) constructor.

ObitIOCode ObitTableVLClose (  ObitTableVL *  in, ObitErr *  err )

Public: Close file and become inactive. Parameters: in  Pointer to object to be closed. err  ObitErr for reporting errors. Returns: error code, OBIT_IO_OK=> OK

ObitTableVL* ObitTableVLConvert (  ObitTable *  in  )

Public: Convert an ObitTable to an ObitTableVL. New object will have references to members of in. Parameters: in  The object to copy, will still exist afterwards and should be Unrefed if not needed. Returns: pointer to the new object.

ObitTableVL* ObitTableVLCopy (  ObitTableVL *  in, ObitTableVL *  out, ObitErr *  err )

Public: Copy (deep) constructor. Copies are made of complex members including disk files; these will be copied applying whatever selection is associated with the input. Objects should be closed on input and will be closed on output. In order for the disk file structures to be copied, the output file must be sufficiently defined that it can be written. The copy will be attempted but no errors will be logged until both input and output have been successfully opened. ObitInfoList and ObitThread members are only copied if the output object didn't previously exist. 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  Error stack, returns if not empty. Returns: pointer to the new object.

gconstpointer ObitTableVLGetClass (  void   )

Public: ClassInfo pointer. Returns: pointer to the class structure.

ObitIOCode ObitTableVLOpen (  ObitTableVL *  in, ObitIOAccess  access, ObitErr *  err )

Public: Create ObitIO structures and open file. The image descriptor is read if OBIT_IO_ReadOnly or OBIT_IO_ReadWrite and written to disk if opened OBIT_IO_WriteOnly. After the file has been opened the member, buffer is initialized for reading/storing the table unless member bufferSize is <0. If the requested version ("Ver" in InfoList) is 0 then the highest numbered table of the same type is opened on Read or Read/Write, or a new table is created on on Write. The file etc. info should have been stored in the ObitInfoList: "FileType" OBIT_int scalar = OBIT_IO_FITS or OBIT_IO_AIPS for file type (see class documentation for details). "nRowPIO" OBIT_int scalar = Maximum number of table rows per transfer, this is the target size for Reads (may be fewer) and is used to create buffers. Parameters: in  Pointer to object to be opened. access  access (OBIT_IO_ReadOnly,OBIT_IO_ReadWrite, or OBIT_IO_WriteOnly). If OBIT_IO_WriteOnly any existing data in the output file will be lost. err  ObitErr for reporting errors. Returns: return code, OBIT_IO_OK=> OK

ObitIOCode ObitTableVLReadRow (  ObitTableVL *  in, glong  iVLRow, ObitTableVLRow *  row, ObitErr *  err )

Public: Read a table row. Scalar values are copied but for array values, pointers into the data array are returned. Parameters: in  Table to read iVLRow  Row number, -1 -> next row  Table Row structure to receive data err  ObitErr for reporting errors. Returns: return code, OBIT_IO_OK=> OK

void ObitTableVLRowClassInit (  void   )

Public: Row Class initializer.

gconstpointer ObitTableVLRowGetClass (  void   )

Public: ClassInfo pointer. Returns: pointer to the Row class structure.

void ObitTableVLSetRow (  ObitTableVL *  in, ObitTableVLRow *  row, ObitErr *  err )

Public: Init a table row for write. This is only useful prior to filling a row structure in preparation . for a WriteRow operation. Array members of the Row structure are . pointers to independently allocated memory, this routine allows using . the table IO buffer instead of allocating yet more memory.. This routine need only be called once to initialize a Row structure for write.. Parameters: in  Table with buffer to be written row  Table Row structure to attach err  ObitErr for reporting errors.

ObitIOCode ObitTableVLWriteRow (  ObitTableVL *  in, glong  iVLRow, ObitTableVLRow *  row, ObitErr *  err )

Public: Write a table row. Before calling this routine, the row structure needs to be initialized and filled with data. The array members of the row structure are pointers to independently allocated memory. These pointers can be set to the correct table buffer locations using ObitTableVLSetRow Parameters: in  Table to read iVLRow  Row number, -1 -> next row  Table Row structure containing data err  ObitErr for reporting errors. Returns: return code, OBIT_IO_OK=> OK

---