next up previous contents Back To Software Index
Next: Parameter Definitions Up: No Title Previous: General Utility Routines

Summary of all CFITSIO User-Interface Routines

FITS File Open and Close Routines: page gif

  int ffopen(fitsfile **fptr, const char *filename, int iomode, > int *status)
  int ffinit(fitsfile **fptr, const char *filename, > int *status)
  int ffflus(fitsfile *fptr, > int *status)
  int ffclos(fitsfile *fptr, > int *status)
  int ffdelt(fitsfile *fptr, > int *status)
  int ffsbuf(fitsfile **fptr, void **memptr, size_t *mem_size,
       size_t delta_size, void *(*mem_realloc)(void *p, int newsize),
      > int *status);
  int ffwbuf(void *memptr, size_t mem_size, char *filename, > int *status)
HDU-Level Operations: page gif

  int ffmahd(fitsfile *fptr, int hdunum, > int *hdutype, int *status)
  int ffmrhd(fitsfile *fptr, int nmove, > int *hdutype, int *status)
  int ffghdn(fitsfile *fptr, > int *hdunum)
  int ffghad(fitsfile *fptr, > long *chduaddr, long *nextaddr)
  int ffcrim(fitsfile *fptr, int bitpix, int naxis, long *naxes, > int *status)
  int ffcrtb(fitsfile *fptr, int tbltype, long naxis2, int tfields,
      char **ttype, char **tform, char **tunit, char *extname, int *status)
  int ffcrhd(fitsfile *fptr, > int *status)
  int ffiimg(fitsfile *fptr, int bitpix, int naxis, long *naxes, > int *status)
  int ffitab(fitsfile *fptr, long rowlen, long nrows, int tfields, char **ttype,
         long *tbcol, char **tform, char **tunit, char *extname, > int *status)
  int ffibin(fitsfile *fptr, long nrows, int tfields, char **ttype,
       char **tform, char **tunit, char *extname, long pcount, > int *status)
  int ffdhdu(fitsfile *fptr, > int *hdutype, int *status)
  int ffcopy(fitsfile *infptr, fitsfile *outfptr, int morekeys, > int *status)
  int ffcpdt(fitsfile *infptr, fitsfile *outfptr, > int *status)
  int ffrdef(fitsfile *fptr, > int *status)   (DEPRECATED)
Header Space and Position Routines: page gif

  int ffhdef(fitsfile *fptr, int morekeys, > int *status)
  int ffghsp(fitsfile *fptr, > int *keysexist, int *morekeys, int *status)
  int ffghps(fitsfile *fptr, > int *keysexist, int *keynum, int *status)
Read or Write Standard Header Routines: page gif

  int ffphps( fitsfile *fptr, int bitpix, int naxis, long *naxes, > int *status)
  int ffphpr( fitsfile *fptr, int simple, int bitpix, int naxis, long *naxes,
            long pcount, long gcount, int extend, > int *status)
  int ffghpr(fitsfile *fptr, int maxdim, > int *simple, int *bitpix, int *naxis,
          long *naxes, long *pcount, long *gcount, int *extend, int *status)
  int ffphtb(fitsfile *fptr, long rowlen, long nrows, int tfields, char **ttype,
          long *tbcol, char **tform, char **tunit, char *extname, > int *status)
  int ffghtb(fitsfile *fptr,int maxdim, > long *rowlen, long *nrows,
           int *tfields, char **ttype, long *tbcol, char **tform, char **tunit,
           char *extname,  int *status)
  int ffphbn(fitsfile *fptr, long nrows, int tfields, char **ttype,
          char **tform, char **tunit, char *extname, long pcount, > int *status)
  int ffghbn(fitsfile *fptr, int maxdim, > long *nrows, int *tfields,
           char **ttype, char **tform, char **tunit, char *extname,
           long *pcount, int *status)
Write Keyword Routines: page gif

  int ffprec(fitsfile *fptr, char *card, > int *status)
  int ffpcom(fitsfile *fptr, char *comment, > int *status)
  int ffphis(fitsfile *fptr, char *history, > int *status)
  int ffpdat(fitsfile *fptr, > int *status)
  int ffpky(fitsfile *fptr, int datatype, char *keyname, DTYPE *value,
          char *comment, > int *status)
  int ffpkys(fitsfile *fptr, char *keyname, char *value, char *comment,
             > int *status)
  int ffpky[lj](fitsfile *fptr, char *keyname, DTYPE numval, char *comment,
                 > int *status)
  int ffpky[edfg](fitsfile *fptr, char *keyname, DTYPE numval, int decimals,
                  char *comment, > int *status)
  int ffpkls(fitsfile *fptr, char *keyname, char *longstr,
             char *comment, > int *status)
  int ffplsw(fitsfile *fptr, > int *status)
  int ffpkyu(fitsfile *fptr, char *keyname, char *comment, > int *status)
  int ffpkns(fitsfile *fptr, char *keyroot, int nstart, int nkeys,
             char **value, char **comment, > int *status)
  int ffpkn[lj](fitsfile *fptr, char *keyroot, int nstart, int nkeys,
             DTYPE *numval, char **comment, int *status)
  int ffpkne[edfg](fitsfile *fptr, char *keyroot, int nstart, int nkey,
                DTYPE *numval, int decimals, char **comment, > int *status)
  int ffpkyt(fitsfile *fptr, char *keyname, long intval, double frac,
             char *comment, > int *status)
  int ffpunt(fitsfile *fptr, char *keyname, char *unit, > int *status)
Insert Keyword Routines: page gif

  int ffirec(fitsfile *fptr, int keynum, char *card, > int *status)
  int ffikys(fitsfile *fptr, char *keyname, char *value, char *comment,
             > int *status)
  int ffiky[lj](fitsfile *fptr, char *keyname, DTYPE numval, char *comment,
              > int *status)
  int ffiky[edfg](fitsfile *fptr, char *keyname, DTYPE numval, int decimals,
                  char *comment, > int *status)
  int ffikyu(fitsfile *fptr, char *keyname, char *comment, > int *status)
Read Keyword Routines: page gif

  int ffgrec(fitsfile *fptr, int keynum, > char *card, int *status)
  int ffgkyn(fitsfile *fptr, int keynum, > char *keyname, char *value,
             char *comment, int *status)
  int ffgcrd(fitsfile *fptr, char *keyname, > char *card, int *status)
  int ffgnxk(fitsfile *fptr, char **inclist, int ninc, char **exclist,
             int nexc,  > char *card, int  *status)
  int ffgkey(fitsfile *fptr, char *keyname, > char *value, char *comment,
             int *status)
  int ffgky(fitsfile *fptr, int datatype, char *keyname, > DTYPE *value,
       char *comment, int *status)
  int ffgkys(fitsfile *fptr, char *keyname, > char *value, char *comment,
             int *status);
  int ffgkls(fitsfile *fptr, char *keyname, > char **longstr, char *comment,
             int *status)
  int ffgky[ljed](fitsfile *fptr, char *keyname, > DTYPE *numval, char *comment,
             int *status)
  int ffgkns(fitsfile *fptr, char *keyname, int nstart, int nkeys,
             > char **value, int *nfound,  int *status)
  int ffgkn[ljed](fitsfile *fptr, char *keyname, int nstart, int nkeys,
                  > DTYPE *numval, int *nfound, int *status)
  int ffgkyt(fitsfile *fptr, char *keyname, > long *intval, double *frac,
             char *comment, int *status)
  int ffgunt(fitsfile *fptr, char *keyname, > char *unit, int *status)
Modify Keyword Routines: page gif

  int ffmrec(fitsfile *fptr, int keynum, char *card, > int *status)
  int ffmcrd(fitsfile *fptr, char *keyname, char *card, > int *status)
  int ffmnam(fitsfile *fptr, char *oldname, char *newname, > int *status)
  int ffmcom(fitsfile *fptr, char *keyname, char *comment, > int *status)
  int ffmkys(fitsfile *fptr, char *keyname, char *value, char *comment,
             > int *status);
  int ffmky[lj](fitsfile *fptr, char *keyname, DTYPE numval, char *comment,
               > int *status)
  int ffmky[edfg](fitsfile *fptr, char *keyname, DTYPE numval, int decimals,
                  char *comment, > int *status)
  int ffmkyu(fitsfile *fptr, char *keyname, char *comment, > int *status)
Update Keyword Routines: page gif

  int ffucrd(fitsfile *fptr, char *keyname, char *card, > int *status)
  int ffukys(fitsfile *fptr, char *keyname, char *value, char *comment,
             > int *status)
  int ffuky[lj](fitsfile *fptr, char *keyname, DTYPE numval, char *comment,
               > int *status)
  int ffuky[edfg](fitsfile *fptr, char *keyname, DTYPE numval, int decimals,
                  char *comment, > int *status)
  int ffukyu(fitsfile *fptr, char *keyname, char *comment, > int *status)
Delete Keyword Routines: page gif

  int ffdrec(fitsfile *fptr, int   keynum,  > int *status)
  int ffdkey(fitsfile *fptr, char *keyname, > int *status)
Define Data Scaling Parameters and Undefined Pixel Flags: page gif

  int ffpscl(fitsfile *fptr, double scale, double zero, > int *status)
  int fftscl(fitsfile *fptr, int colnum, double scale, double zero,
             > int *status)
  int ffpnul(fitsfile *fptr, long nulval, > int *status)
  int ffsnul(fitsfile *fptr, int colnum, char *nulstr, > int *status)
  int fftnul(fitsfile *fptr, int colnum, long nulval, > int *status)
Write Image Data Routines: page gif

  int ffppr(fitsfile *fptr, int datatype, long firstelem, long nelements,
           DTYPE *array, int *status);
  int ffppr[b,i,ui,j,uj,k,e,d](fitsfile *fptr, long group, long firstelem,
           long nelements, DTYPE *array, > int *status);
  int ffppn[b,i,ui,j,uj,k,e,d](fitsfile *fptr, long group, long firstelem,
           long nelements, DTYPE *array, DTYPE nulval, > int *status);
  int ffpgp[b,i,ui,j,uj,k,e,d](fitsfile *fptr, long group, long firstelem,
           long nelements, > DTYPE *array, int *status)
  int ffppru(fitsfile *fptr, long group, long firstelem,
           long nelements, > int *status)
  int ffp2d[b,i,ui,j,uj,k,e,d](fitsfile *fptr, long group, long dim1, long naxis1,
           long naxis2, DTYPE *array, > int *status)
  int ffp3d[b,i,ui,j,uj,k,e,d](fitsfile *fptr, long group, long dim1, long dim2,
           long naxis1, long naxis2, long naxis3, DTYPE *array, > int *status)
  int ffpss[b,i,ui,j,uj,k,e,d](fitsfile *fptr, long group, long naxis, long *naxes,
           long *fpixel, long *lpixel, DTYPE *array, > int *status)
Read Image Data Routines: page gif

  int ffgpv(fitsfile *fptr, int  datatype, long firstelem, long nelements,
           DTYPE *nulval, > DTYPE *array, int *anynul, int *status)
  int ffgpv[b,i,ui,j,uj,k,e,d](fitsfile *fptr, long group, long firstelem,
           long nelements, DTYPE nulval, > DTYPE *array, int *anynul, int *status)
  int ffgpf[b,i,ui,j,uj,k,e,d](fitsfile *fptr, long group, long firstelem,
           long nelements, > DTYPE *array, char *nularray, int *anynul, int *status)
  int ffggp[b,i,ui,j,uj,k,e,d](fitsfile *fptr, long group, long firstelem,
           long nelements, > DTYPE *array, int *status)
  int ffg2d[b,i,ui,j,uj,k,e,d](fitsfile *fptr, long group, DTYPE nulval, long dim1,
           long naxis1, long naxis2, > DTYPE *array,
           int *anynul, int *status)
  int ffg3d[b,i,ui,j,uj,k,e,d](fitsfile *fptr, long group, DTYPE nulval, long dim1,
           long dim2, long naxis1, long naxis2, long naxis3,
           > DTYPE *array, int *anynul, int *status)
  int ffgsv[b,i,ui,j,uj,k,e,d](fitsfile *fptr, int group, int naxis, long *naxes,
           long *fpixels, long *lpixels, long *inc, DTYPE nulval,
           > DTYPE *array, int *anynul, int *status)
  int ffgsf[b,i,ui,j,uj,k,e,d](fitsfile *fptr, int group, int naxis, long *naxes,
           long *fpixels, long *lpixels, long *inc, > DTYPE *array,
           char *nularray, int *anynul, int *status)
Table Column Information Routines: page gif

  int ffgcno(fitsfile *fptr, int casesen, char *templt, > int *colnum,
           int *status)
  int ffgcnn(fitsfile *fptr, int casesen, char *templt, > char *colname,
           int *colnum, int *status)
  int ffgtcl(fitsfile *fptr, int colnum, > int *typecode, long *repeat,
           long *width, int *status)
  int ffgacl(fitsfile *fptr, int colnum, > char *ttype, long *tbcol,
           char *tunit, char *tform, double *scale, double *zero,
           char *nulstr, char *tdisp, int *status)
  int ffgbcl(fitsfile *fptr, int colnum, > char *ttype, char *tunit,
           char *typechar, long *repeat, double *scale, double *zero,
           long *nulval, char *tdisp, int  *status)
  int ffptdm( fitsfile *fptr, int colnum, int naxis, long *naxes,
            >  int *status)
  int ffgtdm(fitsfile *fptr, int colnum, int maxdim, > int *naxis,
           long *naxes, int *status)
  int ffgrsz(fitsfile *fptr, long *nrows, *status)
Low-Level Table Access Routines: page gif

  int ffgtbb(fitsfile *fptr, long firstrow, long firstchar, long nchars,
           > unsigned char *values, int *status)
  int ffptbb(fitsfile *fptr, long firstrow, long firstchar, long nchars,
           unsigned char *values, > int *status)
Insert or Delete Rows and Columns Routines: page gif

  int ffirow(fitsfile *fptr, long firstrow, long nrows, > int *status)
  int ffdrow(fitsfile *fptr, long firstrow, long nrows, > int *status)
  int fficol(fitsfile *fptr, int colnum, char *ttype, char *tform,
            > int *status)
  int fficls(fitsfile *fptr, int colnum, int ncols, char **ttype,
           char **tform, > int *status)
  int ffdcol(fitsfile *fptr, int colnum, > int *status)
Write Column Data Routines: page gif

  int ffpcl(fitsfile *fptr, int datatype, int colnum, long firstrow,
           long firstelem, long nelements, char **array, > int *status)
  int ffpcls(fitsfile *fptr, int colnum, long firstrow, long firstelem,
           long nelements, char **array, > int *status)
  int ffpcl[lb,i,ui,j,uj,k,e,d,c,m](fitsfile *fptr, int colnum, long firstrow,
           long firstelem, long nelements, DTYPE *array, > int *status)
  int ffpcn[b,i,ui,j,uj,k,e,d](fitsfile *fptr, int colnum, long firstrow,
           long firstelem, long nelements, DTYPE *array, DTYPE nulval,
           > int *status)
  int ffpclx(fitsfile *fptr, int colnum, long firstrow, long firstbit,
           long nbits, char *larray, > int *status)
  int ffpclu(fitsfile *fptr, int colnum, long firstrow, long firstelem,
           long nelements, > int *status)
  int ffpdes(fitsfile *fptr, int colnum, long rownum, long repeat,
           long offset, > int *status)
  int ffpthp(fitsfile *fptr, long theap, > int *status)
Read Column Data Routines: page gif

  int ffgcv(fitsfile *fptr, int datatype, int colnum, long firstrow,
           long firstelem, long nelements, DTYPE *nulval, DTYPE *array,
           int *anynul, int *status)
  int ffgcl (fitsfile *fptr, int colnum, long firstrow, long firstelem,
           long nelements, > char *array, int  *status)
  int ffgcvs(fitsfile *fptr, int colnum, long firstrow, long firstelem,
           long nelements, char *nulstr, > char **array, int *anynul,
           int *status)
  int ffgcv[b,i,ui,j,uj,k,e,d,c,m](fitsfile *fptr, int colnum, long firstrow,
           long firstelem, long nelements, DTYPE nulval, > DTYPE *array,
           int *anynul, int *status)
  int ffgcfs(fitsfile *fptr, int colnum, long firstrow, long firstelem,
           long nelements, > char **array, char *nularray, int *anynul,
           int *status)
  int ffgcfl(fitsfile *fptr, int colnum, long firstrow, long firstelem,
           long nelements, > char *array, char *nularray, int *anynul,
           int *status)
  int ffgcf[b,i,ui,j,uj,k,e,d,c,m](fitsfile *fptr, int colnum, long firstrow,
           long firstelem, long nelements, > DTYPE *array,
           char *nularray, int *anynul, int *status)
  int ffgsv[b,i,ui,j,uj,k,e,d](fitsfile *fptr, int colnum, int naxis, long *naxes,
            long *fpixels, long *lpixels, long *inc, DTYPE nulval,
            > DTYPE *array, int *anynul, int *status)
  int ffgsf[b,i,ui,j,uj,k,e,d](fitsfile *fptr, int colnum, int naxis, long *naxes,
            long *fpixels, long *lpixels, long *inc, > DTYPE *array,
            char *nularray, int *anynul, int *status)
  int ffgcx(fitsfile *fptr, int colnum, long firstrow, long firstbit,
            long nbits, > char *larray, int *status)
  int ffgdes(fitsfile *fptr, int colnum, long rownum, > long *repeat,
           long *offset, int *status)
Celestial Coordinate System Routines: page gif

  int  ffgics (fitsfile *fptr, > double *xrefval, double *yrefval,
       double *xrefpix, double *yrefpix, double *xinc, double *yinc,
       double *rot, char *coordtype, int *status)
  int ffgtcs(fitsfile *fptr, int xcol, int ycol, > double *xrefval,
       double *yrefval, double *xrefpix, double *yrefpix, double *xinc,
       double *yinc, double *rot, char *coordtype, int *status)
  int ffwldp(double xpix, double ypix, double xrefval, double yrefval,
       double xrefpix, double yrefpix, double xinc, double yinc,
       double rot, char *coordtype, > double *xpos, double *ypos,
       int *status)
  int ffxypx(double xpos, double ypos, double xrefval, double yrefval,
       double xrefpix, double yrefpix, double xinc, double yinc,
       double rot, char *coordtype, double *xpix, double *ypix,
       int *status)
File Checksum Routines: page gif

  int ffpcks(fitsfile *fptr, > int *status)
  int ffupck(fitsfile *fptr, > int *status)
  int ffvcks(fitsfile *fptr, > int *dataok, int *hduok, int *status)
  int ffgcks(fitsfile *fptr, > unsigned long *datasum, unsigned long *hdusum,
      int *status)
  int ffesum(unsigned long sum, int complm, > char *ascii)
  unsigned long ffdsum(char *ascii, int complm, > unsigned long *sum)
General Utility Routines: page gif

  float ffvers( > float *version)
  void ffgerr(int status, > char *err_text)
  int  ffgmsg(char *err_msg)
  void ffpmsg(char *err_msg)
  void ffcmsg(void)
  void ffupch(char *string)
  void ffcmps(char *templt, char *string, int casesen, > int *match, int *exact)
  int fftkey(char *keyname, > int *status)
  int ffpsvc(char *card, > char *value, char *comment, int *status)
  int ffkeyn(char *keyroot, int value, > char *keyname, int *status)
  int ffnkey(int value, char *keyroot, > char *keyname, int *status)
  int ffdtyp(char *value, > char *dtype, int *status)
  int ffbnfm(char *tform, > int *typecode, long *repeat, long *width,
                int *status)
  int ffasfm(char *tform, > int *typecode, long *width, int *decimals,
             int *status)
  int ffgabc(int tfields, char **tform, int space, > long *rowlen,
            long *tbcol, int *status)
  int ffgthd(char *templt, > char *card, int *keytype, int *status)