ObitFITS.h File Reference

ObitFITS class definition. More...

#include <glib.h>
#include "ObitImageDesc.h"
#include "ObitFile.h"
#include "ObitIO.h"

Go to the source code of this file.

Classes
struct	ObitFITS
	ObitFITS Class Structure. More...
Defines
#define	MAXFITSDISK   20
	The maximum number of FITS "disks".
Typedefs
typedef gint32	FITSint
	Typedef for INTEGER in FITS structures - should be size of float.
Functions
void	ObitFITSClassInit (gint number, gchar *dir[])
	Public: Class initializer.
ObitFITS *	newObitFITS (void)
	Public: Constructor.
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 definition.

This is a Utility class to handle the interface with FITS. This class is non-derivable and only one instance is allowed. Information regarding FITS is stored in a file static structure and is available from function calls. The structure must be initialized by a call to ObitFITSClassInit.

---

Define Documentation

#define MAXFITSDISK   20

The maximum number of FITS "disks".

---

Typedef Documentation

typedef gint32 FITSint

Typedef for INTEGER in FITS structures - should be size of float.

---

Function Documentation

ObitFITS* newObitFITS (  void   )

Public: Constructor.

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.

---