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

ObitTableGBTCCBDATA.h File Reference

ObitTableGBTCCBDATA 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  ObitTableGBTCCBDATA
 ObitTableGBTCCBDATA Class structure. More...
struct  ObitTableGBTCCBDATARow
 ObitTableGBTCCBDATARow Class structure. More...
struct  ObitTableGBTCCBDATAClassInfo
 ClassInfo Structure. More...
struct  ObitTableGBTCCBDATARowClassInfo
 ClassInfo Structure For TableObitTableGBTCCBDATARow. More...

Defines

#define MAXKEYCHARTABLEDATA   24
 Number of characters for Table keyword.
#define ObitTableGBTCCBDATAUnref(in)   ObitUnref (in)
 Macro to unreference (and possibly destroy) an ObitTableGBTCCBDATA returns an ObitTableGBTCCBDATA*.
#define ObitTableGBTCCBDATARef(in)   ObitRef (in)
 Macro to reference (update reference count) an ObitTableGBTCCBDATA.
#define ObitTableGBTCCBDATAIsA(in)   ObitIsA (in, ObitTableGBTCCBDATAGetClass())
 Macro to determine if an object is the member of this or a derived class.
#define ObitTableGBTCCBDATARowUnref(in)   ObitUnref (in)
 Macro to unreference (and possibly destroy) an ObitTableGBTCCBDATARow returns an ObitTableGBTCCBDATARow*.
#define ObitTableGBTCCBDATARowRef(in)   ObitRef (in)
 Macro to reference (update reference count) an ObitTableGBTCCBDATARow.
#define ObitTableGBTCCBDATARowIsA(in)   ObitIsA (in, ObitTableGBTCCBDATARowGetClass())
 Macro to determine if an object is the member of this or a derived class.

Functions

void ObitTableGBTCCBDATARowClassInit (void)
 Public: Row Class initializer.
ObitTableGBTCCBDATARownewObitTableGBTCCBDATARow (ObitTableGBTCCBDATA *table)
 Public: Constructor.
gconstpointer ObitTableGBTCCBDATARowGetClass (void)
 Public: ClassInfo pointer.
void ObitTableGBTCCBDATAClassInit (void)
 Public: Class initializer.
ObitTableGBTCCBDATAnewObitTableGBTCCBDATA (gchar *name)
 Public: Constructor.
ObitTableGBTCCBDATAnewObitTableGBTCCBDATAValue (gchar *name, Obit *file, glong *ver, ObitIOAccess access, ObitErr *err)
 Public: Constructor from values.
gconstpointer ObitTableGBTCCBDATAGetClass (void)
 Public: ClassInfo pointer.
ObitTableGBTCCBDATAObitTableGBTCCBDATACopy (ObitTableGBTCCBDATA *in, ObitTableGBTCCBDATA *out, ObitErr *err)
 Public: Copy (deep) constructor.
ObitTableGBTCCBDATAObitTableGBTCCBDATAClone (ObitTableGBTCCBDATA *in, ObitTableGBTCCBDATA *out)
 Public: Copy (shallow) constructor.
ObitTableGBTCCBDATAObitTableGBTCCBDATAConvert (ObitTable *in)
 Public: Convert an ObitTable to an ObitTableGBTCCBDATA.
ObitIOCode ObitTableGBTCCBDATAOpen (ObitTableGBTCCBDATA *in, ObitIOAccess access, ObitErr *err)
 Public: Create ObitIO structures and open file.
ObitIOCode ObitTableGBTCCBDATAReadRow (ObitTableGBTCCBDATA *in, glong iDATARow, ObitTableGBTCCBDATARow *row, ObitErr *err)
 Public: Read a table row.
void ObitTableGBTCCBDATASetRow (ObitTableGBTCCBDATA *in, ObitTableGBTCCBDATARow *row, ObitErr *err)
 Public: Init a table row for write.
ObitIOCode ObitTableGBTCCBDATAWriteRow (ObitTableGBTCCBDATA *in, glong iDATARow, ObitTableGBTCCBDATARow *row, ObitErr *err)
 Public: Write a table row.
ObitIOCode ObitTableGBTCCBDATAClose (ObitTableGBTCCBDATA *in, ObitErr *err)
 Public: Close file and become inactive.


Detailed Description

ObitTableGBTCCBDATA class definition.

Table in GBT archive/CCB file. This class contains tabular data and allows access. This class is derived from the ObitTable class.

This class contains tabular data and allows access. ObitTableGBTCCBDATA" An ObitTableGBTCCBDATA 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 #ObitTableGBTCCBDATADesc.

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:

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 The following apply to both types of files:

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 #ObitTableGBTCCBDATASetFITS 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:

Creators and Destructors

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

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

Define Documentation

#define MAXKEYCHARTABLEDATA   24
 

Number of characters for Table keyword.

#define ObitTableGBTCCBDATAIsA in   )     ObitIsA (in, ObitTableGBTCCBDATAGetClass())
 

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

Macro to reference (update reference count) an ObitTableGBTCCBDATA.

returns an ObitTableGBTCCBDATA*. in = object to reference

#define ObitTableGBTCCBDATARowIsA in   )     ObitIsA (in, ObitTableGBTCCBDATARowGetClass())
 

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

Macro to reference (update reference count) an ObitTableGBTCCBDATARow.

returns an ObitTableGBTCCBDATARow*. in = object to reference

#define ObitTableGBTCCBDATARowUnref in   )     ObitUnref (in)
 

Macro to unreference (and possibly destroy) an ObitTableGBTCCBDATARow returns an ObitTableGBTCCBDATARow*.

in = object to unreference

#define ObitTableGBTCCBDATAUnref in   )     ObitUnref (in)
 

Macro to unreference (and possibly destroy) an ObitTableGBTCCBDATA returns an ObitTableGBTCCBDATA*.

in = object to unreference


Function Documentation

ObitTableGBTCCBDATA* newObitTableGBTCCBDATA gchar *  name  ) 
 

Public: Constructor.

Initializes class if needed on first call.

Parameters:
name An optional name for the object.
Returns:
the new object.

ObitTableGBTCCBDATARow* newObitTableGBTCCBDATARow ObitTableGBTCCBDATA 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.

ObitTableGBTCCBDATA* newObitTableGBTCCBDATAValue gchar *  name,
Obit *  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 ObitTableGBTCCBDATAClassInit void   ) 
 

Public: Class initializer.

ObitTableGBTCCBDATA* ObitTableGBTCCBDATAClone ObitTableGBTCCBDATA in,
ObitTableGBTCCBDATA out
 

Public: Copy (shallow) constructor.

ObitIOCode ObitTableGBTCCBDATAClose ObitTableGBTCCBDATA 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

ObitTableGBTCCBDATA* ObitTableGBTCCBDATAConvert ObitTable *  in  ) 
 

Public: Convert an ObitTable to an ObitTableGBTCCBDATA.

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.

ObitTableGBTCCBDATA* ObitTableGBTCCBDATACopy ObitTableGBTCCBDATA in,
ObitTableGBTCCBDATA 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 ObitTableGBTCCBDATAGetClass void   ) 
 

Public: ClassInfo pointer.

Returns:
pointer to the class structure.

ObitIOCode ObitTableGBTCCBDATAOpen ObitTableGBTCCBDATA 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 ObitTableGBTCCBDATAReadRow ObitTableGBTCCBDATA in,
glong  iDATARow,
ObitTableGBTCCBDATARow 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
iDATARow Row number, -1 -> next
row Table Row structure to receive data
err ObitErr for reporting errors.
Returns:
return code, OBIT_IO_OK=> OK

void ObitTableGBTCCBDATARowClassInit void   ) 
 

Public: Row Class initializer.

gconstpointer ObitTableGBTCCBDATARowGetClass void   ) 
 

Public: ClassInfo pointer.

Returns:
pointer to the Row class structure.

void ObitTableGBTCCBDATASetRow ObitTableGBTCCBDATA in,
ObitTableGBTCCBDATARow 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 ObitTableGBTCCBDATAWriteRow ObitTableGBTCCBDATA in,
glong  iDATARow,
ObitTableGBTCCBDATARow 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 ObitTableGBTCCBDATASetRow

Parameters:
in Table to read
iDATARow Row number, -1 -> next
row Table Row structure containing data
err ObitErr for reporting errors.
Returns:
return code, OBIT_IO_OK=> OK


Generated on Mon Sep 3 20:43:54 2007 by  doxygen 1.3.9.1