ObitFileFITS.h

Go to the documentation of this file.

/* $Id: ObitFileFITS.h,v 1.7 2007/08/31 17:24:48 bcotton Exp $    */
/*--------------------------------------------------------------------*/
/*;  Copyright (C) 2004-2007                                          */
/*;  Associated Universities, Inc. Washington DC, USA.                */
/*;                                                                   */
/*;  This program is free software; you can redistribute it and/or    */
/*;  modify it under the terms of the GNU General Public License as   */
/*;  published by the Free Software Foundation; either version 2 of   */
/*;  the License, or (at your option) any later version.              */
/*;                                                                   */
/*;  This program is distributed in the hope that it will be useful,  */
/*;  but WITHOUT ANY WARRANTY; without even the implied warranty of   */
/*;  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    */
/*;  GNU General Public License for more details.                     */
/*;                                                                   */
/*;  You should have received a copy of the GNU General Public        */
/*;  License along with this program; if not, write to the Free       */
/*;  Software Foundation, Inc., 675 Massachusetts Ave, Cambridge,     */
/*;  MA 02139, USA.                                                   */
/*;                                                                   */
/*; Correspondence about this software should be addressed as follows:*/
/*;         Internet email: bcotton@nrao.edu.                         */
/*;         Postal address: William Cotton                            */
/*;                         National Radio Astronomy Observatory      */
/*;                         520 Edgemont Road                         */
/*;                         Charlottesville, VA 22903-2475 USA        */
/*--------------------------------------------------------------------*/
#ifndef OBITFILEFITS_H 
#define OBITFILEFITS_H 
#include "fitsio.h"
#include "Obit.h"
#include "ObitErr.h"
#include "ObitThread.h"
#include "ObitInfoList.h"
#include "ObitFile.h"

/*-------- Obit: Software for the recently deceased ------------------*/
/*----------------- typedefs ---------------------------*/
/*---------------Class Structure---------------------------*/
typedef struct {
#include "ObitFileFITSDef.h"   /* actual definition */
} ObitFileFITS;

/*----------------- Macroes ---------------------------*/

#define ObitFileFITSUnref(in) ObitUnref (in)

#define ObitFileFITSRef(in) ObitRef (in)

#define ObitFileFITSIsA(in) ObitIsA (in, ObitFileFITSGetClass())

/* Private functions are only defined in the .c file */

/*---------------Public functions---------------------------*/
void ObitFileFITSClassInit (void);

ObitFileFITS* newObitFileFITS (gchar* name);

gconstpointer ObitFileFITSGetClass (void);

ObitFileFITS* ObitFileFITSZap (ObitFileFITS *in, ObitErr *err);

ObitIOCode ObitFileFITSZapHDU (ObitFileFITS *in, ObitErr *err);

ObitFileFITS* ObitFileFITSCopy  (ObitFileFITS *in, ObitFileFITS *out, ObitErr *err);

ObitIOCode 
ObitFileFITSOpen (ObitFileFITS *in, gchar *fileName, gint disk, 
                  ObitIOAccess access,  ObitErr *err);

ObitIOCode ObitFileFITSClose (ObitFileFITS *in, ObitErr *err);

gboolean ObitFileFITSExist (gchar *fileName, ObitErr *err);

ObitIOCode ObitFileFITSNum (ObitFileFITS *in, gint hdunum, gint *hdutype, 
                            ObitErr *err);

ObitIOCode ObitFileFITSName (ObitFileFITS *in, gint hdutype, gchar *extname, 
                            gint extver, ObitErr *err);

ObitIOCode 
ObitFileFITSReadKeyStr (ObitFileFITS *in, gchar *Name, 
                        gchar *Value, gchar *Comment, ObitErr *err);

ObitIOCode 
ObitFileFITSReadKeyFlt (ObitFileFITS *in, gchar *Name, 
                        gfloat *Value, gchar *Comment, ObitErr *err);

ObitIOCode 
ObitFileFITSReadKeyDbl (ObitFileFITS *in, gchar *Name, 
                        gdouble *Value, gchar *Comment, ObitErr *err);

ObitIOCode 
ObitFileFITSReadKeyLng (ObitFileFITS *in, gchar *Name, 
                        glong *Value, gchar *Comment, ObitErr *err);

ObitIOCode 
ObitFileFITSReadHistory (ObitFileFITS *in, gchar *hiCard, ObitErr *err);

ObitIOCode 
ObitFileFITSWriteKeyStr (ObitFileFITS *in, gchar *Name, gboolean update,
                        gchar *Value, gchar *Comment, ObitErr *err);

ObitIOCode 
ObitFileFITSWriteKeyFlt (ObitFileFITS *in, gchar *Name, gboolean update,
                        gfloat Value, gchar *Comment, ObitErr *err);

ObitIOCode 
ObitFileFITSWriteKeyDbl (ObitFileFITS *in, gchar *Name, gboolean update,
                        gdouble Value, gchar *Comment, ObitErr *err);

ObitIOCode 
ObitFileFITSWriteKeyLng (ObitFileFITS *in, gchar *Name, gboolean update,
                        glong Value, gchar *Comment, ObitErr *err);

ObitIOCode 
ObitFileFITSWriteHisKeyStr (fitsfile *inFptr, gchar *Name, gchar *Value, 
                            gchar *Comment, ObitErr *err);

ObitIOCode 
ObitFileFITSWriteHisKeyFlt (fitsfile *inFptr, gchar *Name, gfloat Value, 
                            gchar *Comment, ObitErr *err);

ObitIOCode 
ObitFileFITSWriteHisKeyDbl (fitsfile *inFptr, gchar *Name, gdouble Value, 
                            gchar *Comment, ObitErr *err);

ObitIOCode 
ObitFileFITSWriteHisKeyLng (fitsfile *inFptr, gchar *Name, glong Value, 
                            gchar *Comment, ObitErr *err);

ObitIOCode 
ObitFileFITSWriteDate (ObitFileFITS *in, ObitErr *err);

ObitIOCode 
ObitFileFITSWriteHistory (ObitFileFITS *in, gchar *hiCard, ObitErr *err);

ObitIOCode 
ObitFileFITSAddKeys (ObitFileFITS *in, gint morekeys, ObitErr *err);

/*-------------------Class Info--------------------------*/
typedef struct  {
#include "ObitFileFITSClassDef.h" /* Actual definition */
} ObitFileFITSClassInfo; 


#endif /* OBITFILEFITS_H */ 

---