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

ObitFITS.c File Reference

ObitFITS class function definitions. More...

#include <math.h>
#include <string.h>
#include "Obit.h"
#include "ObitFITS.h"
#include "ObitHistory.h"

Functions

void ObitFITSClassInit (gint number, gchar *dir[])
 Public: Class initializer.
void ObitFITSShutdown (void)
 Public: Shutdown.
gint ObitFITSAddDir (gchar *dir, ObitErr *err)
 Public: Add FITS data directory.
gchar * ObitFITSFilename (gint disk, gchar *fileName, ObitErr *err)
 Public: Generate name of FITS file.
gchar * ObitFITSDirname (gint disk, ObitErr *err)
 Public: Get directory string.
void ObitFITSAssign (gchar *pgmName, gint pgmNumber, gint disk, gint scrNo, ObitInfoList *info, ObitErr *err)
 Public: Assign a scratch file info.
void ObitFITSRename (ObitIO *in, ObitInfoList *info, ObitErr *err)
 Public: Rename a FITS file.


Detailed Description

ObitFITS class function definitions.


Function Documentation

gint ObitFITSAddDir gchar *  dir,
ObitErr err
 

Public: Add FITS data directory.

Parameters:
dir names of the directories with terminal '/'
err Error stack for any error messages.
Returns:
new 1-rel disk number, -1 on failure

void ObitFITSAssign gchar *  pgmName,
gint  pgmNumber,
gint  disk,
gint  scrNo,
ObitInfoList info,
ObitErr err
 

Public: Assign a scratch file info.

void ObitFITSClassInit gint  number,
gchar *  dir[]
 

Public: Class initializer.

Parameters:
number of disks defined [0,MAXFITSDISK], >=0 -> none
dir the names of the directories If NULL then look for environment variables FITS, FITS01, FITS02...

gchar* ObitFITSDirname gint  disk,
ObitErr err
 

Public: Get directory string.

Parameters:
disk FITS disk number.
err Error stack for any error messages.
Returns:
directory name string, this is a pointer into a global class structure and should not be g_freeed.

gchar* ObitFITSFilename gint  disk,
gchar *  fileName,
ObitErr err
 

Public: Generate name of FITS file.

ObitFITSClassInit must have been used to initialize.

Parameters:
disk FITS "disk" number. 1-rel, =0 => ignore directory
fileName name
err Error stack for any error messages.
Returns:
full path name string, should be deallocated when done

void ObitFITSRename ObitIO in,
ObitInfoList info,
ObitErr err
 

Public: Rename a FITS file.

Parameters:
in ObitIO on FITS file
info Associated ObitInfoList
  • "newFileName" OBIT_string (?,1,1) New Name of disk file.
  • "FileName" OBIT_string (?,1,1) Old Name of disk file.
  • "Disk" OBIT_int (1,1,1) Disk number
err Error stack for any error messages.

void ObitFITSShutdown void   ) 
 

Public: Shutdown.


Generated on Fri Aug 31 22:13:05 2007 for Obit by  doxygen 1.3.9.1