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

ObitIOImageAIPS.c File Reference

ObitIOImageAIPS class function definitions. More...

#include <stdio.h>
#include "Obit.h"
#include "ObitAIPS.h"
#include "ObitIOImageAIPS.h"
#include "ObitAIPSCat.h"
#include "ObitImageSel.h"
#include "ObitTableList.h"
#include "ObitMem.h"

Functions

void ObitIOImageAIPSInit (gpointer in)
 Private: Initialize newly instantiated object.
void ObitIOImageAIPSClear (gpointer in)
 Private: Deallocate members.
ObitIOImageAIPS * newObitIOImageAIPS (gchar *name, ObitInfoList *info, ObitErr *err)
 Public: Constructor.
gconstpointer ObitIOImageAIPSGetClass (void)
 Public: ClassInfo pointer.
gboolean ObitIOImageAIPSSame (ObitIO *in, ObitInfoList *in1, ObitInfoList *in2, ObitErr *err)
 Public: Are underlying structures the same.
void ObitIOImageAIPSRename (ObitIO *in, ObitInfoList *info, ObitErr *err)
 Public: Rename underlying structures.
void ObitIOImageAIPSZap (ObitIOImageAIPS *in, ObitErr *err)
 Public: Delete underlying structures.
ObitIOImageAIPS * ObitIOImageAIPSCopy (ObitIOImageAIPS *in, ObitIOImageAIPS *out, ObitErr *err)
 Public: Copy constructor.
ObitIOCode ObitIOImageAIPSOpen (ObitIOImageAIPS *in, ObitIOAccess access, ObitInfoList *info, ObitErr *err)
 Public: Open.
ObitIOCode ObitIOImageAIPSClose (ObitIOImageAIPS *in, ObitErr *err)
 Public: Close.
ObitIOCode ObitIOImageAIPSSet (ObitIOImageAIPS *in, ObitInfoList *info, ObitErr *err)
 Public: Init I/O.
ObitIOCode ObitIOImageAIPSRead (ObitIOImageAIPS *in, gfloat *data, ObitErr *err)
 Public: Read.
ObitIOCode ObitIOImageAIPSWrite (ObitIOImageAIPS *in, gfloat *data, ObitErr *err)
 Public: Write.
ObitIOCode ObitIOImageAIPSReadDescriptor (ObitIOImageAIPS *in, ObitErr *err)
 Public: Read Descriptor.
ObitIOCode ObitIOImageAIPSWriteDescriptor (ObitIOImageAIPS *in, ObitErr *err)
 Public: Write Descriptor.
ObitIOCode ObitIOImageAIPSFlush (ObitIOImageAIPS *in, ObitErr *err)
 Public: Flush.
void ObitIOImageAIPSCreateBuffer (gfloat **data, glong *size, ObitIOImageAIPS *in, ObitInfoList *info, ObitErr *err)
 Public: Create buffer.
Obit * newObitIOImageAIPSTable (ObitIOImageAIPS *in, ObitIOAccess access, gchar *tabType, glong *tabVer, ObitErr *err)
 Public: Create an associated Table Typed as base class to avoid problems.
ObitIOCode ObitIOImageAIPSUpdateTables (ObitIOImageAIPS *in, ObitInfoList *info, ObitErr *err)
 Public: Update disk resident tables information.
void ObitIOImageAIPSClassInit (void)
 Public: Class initializer.

Detailed Description

ObitIOImageAIPS class function definitions.

Function Documentation

ObitIOImageAIPS* newObitIOImageAIPS (  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* newObitIOImageAIPSTable (  ObitIOImageAIPS *  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 ObitIOImageAIPSClassInit (  void   ) 
 

Public: Class initializer.

void ObitIOImageAIPSClear (  gpointer  inn  ) 
 

Private: Deallocate members.

Does (recursive) deallocation of parent class members.

Parameters:
inn Pointer to the object to deallocate.

ObitIOCode ObitIOImageAIPSClose (  ObitIOImageAIPS *  in,
ObitErr *  err
) 
 

Public: Close.

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

ObitIOImageAIPS* ObitIOImageAIPSCopy (  ObitIOImageAIPS *  in,
ObitIOImageAIPS *  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 ObitIOImageAIPSCreateBuffer (  gfloat **  data,
glong *  size,
ObitIOImageAIPS *  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 ObitIOImageAIPSFlush (  ObitIOImageAIPS *  in,
ObitErr *  err
) 
 

Public: Flush.

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

gconstpointer ObitIOImageAIPSGetClass (  void   ) 
 

Public: ClassInfo pointer.

Initializes class if needed on first call.

Returns:
pointer to the class structure.

void ObitIOImageAIPSInit (  gpointer  inn  ) 
 

Private: Initialize newly instantiated object.

for each parent class.

Parameters:
inn Pointer to the object to initialize.

ObitIOCode ObitIOImageAIPSOpen (  ObitIOImageAIPS *  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)
info ObitInfoList with instructions for opening
err ObitErr for reporting errors.
Returns:
return code, 0=> OK

ObitIOCode ObitIOImageAIPSRead (  ObitIOImageAIPS *  in,
gfloat *  data,
ObitErr *  err
) 
 

Public: Read.

Reads row in->myDesc->row + 1; plane in->myDesc->plane + 1

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 ObitIOImageAIPSReadDescriptor (  ObitIOImageAIPS *  in,
ObitErr *  err
) 
 

Public: Read Descriptor.

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

void ObitIOImageAIPSRename (  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 ObitIOImageAIPSSame (  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 ObitIOImageAIPSSet (  ObitIOImageAIPS *  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 ObitIOImageAIPSUpdateTables (  ObitIOImageAIPS *  in,
ObitInfoList *  info,
ObitErr *  err
) 
 

Public: Update disk resident tables information.

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

ObitIOCode ObitIOImageAIPSWrite (  ObitIOImageAIPS *  in,
gfloat *  data,
ObitErr *  err
) 
 

Public: Write.

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 ObitIOImageAIPSWriteDescriptor (  ObitIOImageAIPS *  in,
ObitErr *  err
) 
 

Public: Write Descriptor.

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

void ObitIOImageAIPSZap (  ObitIOImageAIPS *  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