ObitTableOTFScanData.h File Reference

ObitTableOTFScanData class definition. More...

#include <string.h>
#include <stdio.h>
#include <stdlib.h>
#include <math.h>
#include <glib.h>
#include "Obit.h"
#include "ObitErr.h"
#include "ObitTable.h"

Go to the source code of this file.

Classes
struct	ObitTableOTFScanData
	ObitTableOTFScanData Class structure. More...
struct	ObitTableOTFScanDataRow
	ObitTableOTFScanDataRow Class structure. More...
struct	ObitTableOTFScanDataClassInfo
	ClassInfo Structure. More...
struct	ObitTableOTFScanDataRowClassInfo
	ClassInfo Structure For TableObitTableOTFScanDataRow. More...
Defines
#define	MAXKEYCHARTABLEOTFScanData   24
	Number of characters for Table keyword.
#define	ObitTableOTFScanDataUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitTableOTFScanData returns an ObitTableOTFScanData*.
#define	ObitTableOTFScanDataRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitTableOTFScanData.
#define	ObitTableOTFScanDataIsA(in)   ObitIsA (in, ObitTableOTFScanDataGetClass())
	Macro to determine if an object is the member of this or a derived class.
#define	ObitTableOTFScanDataRowUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitTableOTFScanDataRow returns an ObitTableOTFScanDataRow*.
#define	ObitTableOTFScanDataRowRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitTableOTFScanDataRow.
#define	ObitTableOTFScanDataRowIsA(in)   ObitIsA (in, ObitTableOTFScanDataRowGetClass())
	Macro to determine if an object is the member of this or a derived class.
Functions
void	ObitTableOTFScanDataRowClassInit (void)
	Public: Row Class initializer.
ObitTableOTFScanDataRow *	newObitTableOTFScanDataRow (ObitTableOTFScanData *table)
	Public: Constructor.
gconstpointer	ObitTableOTFScanDataRowGetClass (void)
	Public: ClassInfo pointer.
void	ObitTableOTFScanDataClassInit (void)
	Public: Class initializer.
ObitTableOTFScanData *	newObitTableOTFScanData (gchar *name)
	Public: Constructor.
ObitTableOTFScanData *	newObitTableOTFScanDataValue (gchar *name, Obit *file, glong *ver, ObitIOAccess access, oint numDet, ObitErr *err)
	Public: Constructor from values.
gconstpointer	ObitTableOTFScanDataGetClass (void)
	Public: ClassInfo pointer.
ObitTableOTFScanData *	ObitTableOTFScanDataCopy (ObitTableOTFScanData *in, ObitTableOTFScanData *out, ObitErr *err)
	Public: Copy (deep) constructor.
ObitTableOTFScanData *	ObitTableOTFScanDataClone (ObitTableOTFScanData *in, ObitTableOTFScanData *out)
	Public: Copy (shallow) constructor.
ObitTableOTFScanData *	ObitTableOTFScanDataConvert (ObitTable *in)
	Public: Convert an ObitTable to an ObitTableOTFScanData.
ObitIOCode	ObitTableOTFScanDataOpen (ObitTableOTFScanData *in, ObitIOAccess access, ObitErr *err)
	Public: Create ObitIO structures and open file.
ObitIOCode	ObitTableOTFScanDataReadRow (ObitTableOTFScanData *in, glong iOTFScanDataRow, ObitTableOTFScanDataRow *row, ObitErr *err)
	Public: Read a table row.
void	ObitTableOTFScanDataSetRow (ObitTableOTFScanData *in, ObitTableOTFScanDataRow *row, ObitErr *err)
	Public: Init a table row for write.
ObitIOCode	ObitTableOTFScanDataWriteRow (ObitTableOTFScanData *in, glong iOTFScanDataRow, ObitTableOTFScanDataRow *row, ObitErr *err)
	Public: Write a table row.
ObitIOCode	ObitTableOTFScanDataClose (ObitTableOTFScanData *in, ObitErr *err)
	Public: Close file and become inactive.

---

Detailed Description

ObitTableOTFScanData class definition.

This class contains tabular data and allows access. An OTFScanData table has ``on the fly'' mode observational data from the bolometer array.

This class contains tabular data and allows access. ObitTableOTFScanData" An ObitTableOTFScanData is the front end to a persistent disk resident structure. This class is derived from the ObitTable class.

Table 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 #ObitTableOTFScanDataDesc.

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 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

• "FileType" OBIT_int (1,1,1) OBIT_IO_FITS 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 #ObitTableOTFScanDataSetFITS 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

Creators and Destructors

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

A copy of a pointer to an ObitTableOTFScanData should always be made using the ObitTableOTFScanDataRef function which updates the reference count in the object. Then whenever freeing an ObitTableOTFScanData or changing a pointer, the function ObitTableOTFScanDataUnref 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 ObitTableOTFScanData or some external location. To Write an ObitTableOTFScanData, create it, open it, and write. The object should be closed to ensure all data is flushed to disk. Deletion of an ObitTableOTFScanData after its final unreferencing will automatically close it.

---

Define Documentation

#define MAXKEYCHARTABLEOTFScanData   24

Number of characters for Table keyword.

#define ObitTableOTFScanDataIsA (  in   )     ObitIsA (in, ObitTableOTFScanDataGetClass())

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

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

#define ObitTableOTFScanDataRowIsA (  in   )     ObitIsA (in, ObitTableOTFScanDataRowGetClass())

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

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

#define ObitTableOTFScanDataRowUnref (  in   )     ObitUnref (in)

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

#define ObitTableOTFScanDataUnref (  in   )     ObitUnref (in)

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

---

Function Documentation

ObitTableOTFScanData* newObitTableOTFScanData (  gchar *  name  )

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

ObitTableOTFScanDataRow* newObitTableOTFScanDataRow (  ObitTableOTFScanData *  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.

ObitTableOTFScanData* newObitTableOTFScanDataValue (  gchar *  name, Obit *  file, glong *  ver, ObitIOAccess  access, oint  numDet, 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. numDet  The number of detectors. err  Error stack, returns if not empty. Returns: the new object, NULL on failure.

void ObitTableOTFScanDataClassInit (  void   )

Public: Class initializer.

ObitTableOTFScanData* ObitTableOTFScanDataClone (  ObitTableOTFScanData *  in, ObitTableOTFScanData *  out )

Public: Copy (shallow) constructor.

ObitIOCode ObitTableOTFScanDataClose (  ObitTableOTFScanData *  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

ObitTableOTFScanData* ObitTableOTFScanDataConvert (  ObitTable *  in  )

Public: Convert an ObitTable to an ObitTableOTFScanData. 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.

ObitTableOTFScanData* ObitTableOTFScanDataCopy (  ObitTableOTFScanData *  in, ObitTableOTFScanData *  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 ObitTableOTFScanDataGetClass (  void   )

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

ObitIOCode ObitTableOTFScanDataOpen (  ObitTableOTFScanData *  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 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 ObitTableOTFScanDataReadRow (  ObitTableOTFScanData *  in, glong  iOTFScanDataRow, ObitTableOTFScanDataRow *  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 iOTFScanDataRow  Row number, -1 -> next row  Table Row structure to receive data err  ObitErr for reporting errors. Returns: return code, OBIT_IO_OK=> OK

void ObitTableOTFScanDataRowClassInit (  void   )

Public: Row Class initializer.

gconstpointer ObitTableOTFScanDataRowGetClass (  void   )

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

void ObitTableOTFScanDataSetRow (  ObitTableOTFScanData *  in, ObitTableOTFScanDataRow *  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 ObitTableOTFScanDataWriteRow (  ObitTableOTFScanData *  in, glong  iOTFScanDataRow, ObitTableOTFScanDataRow *  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 ObitTableOTFScanDataSetRow Parameters: in  Table to read iOTFScanDataRow  Row number, -1 -> next row  Table Row structure containing data err  ObitErr for reporting errors. Returns: return code, OBIT_IO_OK=> OK

---