ObitTableIDI_FREQUENCY.h File Reference

ObitTableIDI_FREQUENCY 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	ObitTableIDI_FREQUENCY
	ObitTableIDI_FREQUENCY Class structure. More...
struct	ObitTableIDI_FREQUENCYRow
	ObitTableIDI_FREQUENCYRow Class structure. More...
struct	ObitTableIDI_FREQUENCYClassInfo
	ClassInfo Structure. More...
struct	ObitTableIDI_FREQUENCYRowClassInfo
	ClassInfo Structure For TableIDI_FREQUENCYRow. More...
Defines
#define	MAXKEYCHARTABLEIDI_FREQUENCY   24
	Number of characters for Table keyword.
#define	ObitTableIDI_FREQUENCYUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitTableIDI_FREQUENCY returns an ObitTableIDI_FREQUENCY*.
#define	ObitTableIDI_FREQUENCYRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitTableIDI_FREQUENCY.
#define	ObitTableIDI_FREQUENCYIsA(in)   ObitIsA (in, ObitTableIDI_FREQUENCYGetClass())
	Macro to determine if an object is the member of this or a derived class.
#define	ObitTableIDI_FREQUENCYRowUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitTableIDI_FREQUENCYRow returns an ObitTableIDI_FREQUENCYRow*.
#define	ObitTableIDI_FREQUENCYRowRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitTableIDI_FREQUENCYRow.
#define	ObitTableIDI_FREQUENCYRowIsA(in)   ObitIsA (in, ObitTableIDI_FREQUENCYRowGetClass())
	Macro to determine if an object is the member of this or a derived class.
Functions
void	ObitTableIDI_FREQUENCYRowClassInit (void)
	Public: Row Class initializer.
ObitTableIDI_FREQUENCYRow *	newObitTableIDI_FREQUENCYRow (ObitTableIDI_FREQUENCY *table)
	Public: Constructor.
gconstpointer	ObitTableIDI_FREQUENCYRowGetClass (void)
	Public: ClassInfo pointer.
void	ObitTableIDI_FREQUENCYClassInit (void)
	Public: Class initializer.
ObitTableIDI_FREQUENCY *	newObitTableIDI_FREQUENCY (gchar *name)
	Public: Constructor.
ObitTableIDI_FREQUENCY *	newObitTableIDI_FREQUENCYValue (gchar *name, ObitData *file, glong *ver, ObitIOAccess access, oint no_band, ObitErr *err)
	Public: Constructor from values.
gconstpointer	ObitTableIDI_FREQUENCYGetClass (void)
	Public: ClassInfo pointer.
ObitTableIDI_FREQUENCY *	ObitTableIDI_FREQUENCYCopy (ObitTableIDI_FREQUENCY *in, ObitTableIDI_FREQUENCY *out, ObitErr *err)
	Public: Copy (deep) constructor.
ObitTableIDI_FREQUENCY *	ObitTableIDI_FREQUENCYClone (ObitTableIDI_FREQUENCY *in, ObitTableIDI_FREQUENCY *out)
	Public: Copy (shallow) constructor.
ObitTableIDI_FREQUENCY *	ObitTableIDI_FREQUENCYConvert (ObitTable *in)
	Public: Convert an ObitTable to an ObitTableIDI_FREQUENCY.
ObitIOCode	ObitTableIDI_FREQUENCYOpen (ObitTableIDI_FREQUENCY *in, ObitIOAccess access, ObitErr *err)
	Public: Create ObitIO structures and open file.
ObitIOCode	ObitTableIDI_FREQUENCYReadRow (ObitTableIDI_FREQUENCY *in, glong iIDI_FREQUENCYRow, ObitTableIDI_FREQUENCYRow *row, ObitErr *err)
	Public: Read a table row.
void	ObitTableIDI_FREQUENCYSetRow (ObitTableIDI_FREQUENCY *in, ObitTableIDI_FREQUENCYRow *row, ObitErr *err)
	Public: Init a table row for write.
ObitIOCode	ObitTableIDI_FREQUENCYWriteRow (ObitTableIDI_FREQUENCY *in, glong iIDI_FREQUENCYRow, ObitTableIDI_FREQUENCYRow *row, ObitErr *err)
	Public: Write a table row.
ObitIOCode	ObitTableIDI_FREQUENCYClose (ObitTableIDI_FREQUENCY *in, ObitErr *err)
	Public: Close file and become inactive.

---

Detailed Description

ObitTableIDI_FREQUENCY class definition.

This class is derived from the ObitTable class.

This class contains tabular data and allows access. This table is part of the IDI uv data format. "IDI\_FREQUENCY" contains frequency related information for ``IF'' in uv data. An ``IF'' is a construct that allows sets of arbitrarily spaced frequencies. An ObitTableIDI 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. "IDI_FREQUENCY" table An ObitTableIDI_FREQUENCY is the front end to a persistent disk resident structure. Only FITS (as Tables) 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 #ObitTableIDI_FREQUENCYDesc.

In addition to the normal tabular data, a table will have a "_status" column to indicate the status of each row.

Specifying desired data transfer parameters

The desired data transfers are specified in the member ObitInfoList. 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).

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 #ObitTableIDI_FREQUENCYSetFITS 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 ObitTableIDI_FREQUENCY can be created using newObitTableIDI_FREQUENCYValue which attaches the table to an ObitData for the object. If the output ObitTableIDI_FREQUENCY has previously been specified, including file information, then ObitTableIDI_FREQUENCYCopy will copy the disk resident as well as the memory resident information.

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

---

Define Documentation

#define MAXKEYCHARTABLEIDI_FREQUENCY   24

Number of characters for Table keyword.

#define ObitTableIDI_FREQUENCYIsA (  in   )     ObitIsA (in, ObitTableIDI_FREQUENCYGetClass())

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

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

#define ObitTableIDI_FREQUENCYRowIsA (  in   )     ObitIsA (in, ObitTableIDI_FREQUENCYRowGetClass())

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

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

#define ObitTableIDI_FREQUENCYRowUnref (  in   )     ObitUnref (in)

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

#define ObitTableIDI_FREQUENCYUnref (  in   )     ObitUnref (in)

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

---

Function Documentation

ObitTableIDI_FREQUENCY* newObitTableIDI_FREQUENCY (  gchar *  name  )

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

ObitTableIDI_FREQUENCYRow* newObitTableIDI_FREQUENCYRow (  ObitTableIDI_FREQUENCY *  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.

ObitTableIDI_FREQUENCY* newObitTableIDI_FREQUENCYValue (  gchar *  name, ObitData *  file, glong *  ver, ObitIOAccess  access, oint  no_band, 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. no_band  Number of frequency bands (IF) err  Error stack, returns if not empty. Returns: the new object, NULL on failure.

void ObitTableIDI_FREQUENCYClassInit (  void   )

Public: Class initializer.

ObitTableIDI_FREQUENCY* ObitTableIDI_FREQUENCYClone (  ObitTableIDI_FREQUENCY *  in, ObitTableIDI_FREQUENCY *  out )

Public: Copy (shallow) constructor.

ObitIOCode ObitTableIDI_FREQUENCYClose (  ObitTableIDI_FREQUENCY *  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

ObitTableIDI_FREQUENCY* ObitTableIDI_FREQUENCYConvert (  ObitTable *  in  )

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

ObitTableIDI_FREQUENCY* ObitTableIDI_FREQUENCYCopy (  ObitTableIDI_FREQUENCY *  in, ObitTableIDI_FREQUENCY *  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 ObitTableIDI_FREQUENCYGetClass (  void   )

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

ObitIOCode ObitTableIDI_FREQUENCYOpen (  ObitTableIDI_FREQUENCY *  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 (AIPS not allowed) 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 ObitTableIDI_FREQUENCYReadRow (  ObitTableIDI_FREQUENCY *  in, glong  iIDI_FREQUENCYRow, ObitTableIDI_FREQUENCYRow *  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 iIDI_FREQUENCYRow  Row number, -1 -> next row  Table Row structure to receive data err  ObitErr for reporting errors. Returns: return code, OBIT_IO_OK=> OK

void ObitTableIDI_FREQUENCYRowClassInit (  void   )

Public: Row Class initializer.

gconstpointer ObitTableIDI_FREQUENCYRowGetClass (  void   )

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

void ObitTableIDI_FREQUENCYSetRow (  ObitTableIDI_FREQUENCY *  in, ObitTableIDI_FREQUENCYRow *  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 ObitTableIDI_FREQUENCYWriteRow (  ObitTableIDI_FREQUENCY *  in, glong  iIDI_FREQUENCYRow, ObitTableIDI_FREQUENCYRow *  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 ObitTableIDI_FREQUENCYSetRow Parameters: in  Table to read iIDI_FREQUENCYRow  Row number, -1 -> next row  Table Row structure containing data err  ObitErr for reporting errors. Returns: return code, OBIT_IO_OK=> OK

---