funinfoget(3)							SAORD Documentation						     funinfoget(3)

NAME

       FunInfoGet - get information from Funtools struct

SYNOPSIS

	 #include <funtools.h>

	 int FunInfoGet(Fun fun, int type, char *addr, ...)

DESCRIPTION

       The FunInfoGet() routine returns information culled from the Funtools structure.  The first argument is the Fun handle from which informa-
       tion is to be retrieved.  This first required argument is followed by a variable length list of pairs of arguments. Each pair consists of
       an integer representing the type of information to retrieve and the address where the information is to be stored. The list is terminated
       by a 0.	The routine returns the number of get actions performed.

       The full list of available information is described below.  Please note that only a few of these will be useful to most application devel-
       opers.  For imaging applications, the most important types are:

	 FUN_SECT_DIM1	 int  /* dim1 for section */
	 FUN_SECT_DIM2	 int  /* dim2 for section */
	 FUN_SECT_BITPIX int  /* bitpix for section */

       These would be used to determine the dimensions and data type of image data retrieved using the FunImageGet() routine. For example:

	 /* extract and bin the data section into an image buffer */
	 buf = FunImageGet(fun, NULL, NULL);
	 /* get required information from funtools structure.
	    this should come after the FunImageGet() call, in case the call
	    changed sect_bitpix */
	 FunInfoGet(fun,
		    FUN_SECT_BITPIX,  &bitpix,
		    FUN_SECT_DIM1,    &dim1,
		    FUN_SECT_DIM2,    &dim2,
		    0);
	 /* loop through pixels and reset values below limit to value */
	 for(i=0; i<dim1*dim2; i++){
	   switch(bitpix){
	   case 8:
	     if( cbuf[i] <= blimit ) cbuf[i] = bvalue;
	   ...
	 }

       It is important to bear in mind that the call to FunImageGet() can change the value of FUN_SECT_BITPIX (e.g. if "bitpix=n" is passed in the
       param list).  Therefore, a call to FunInfoGet() should be made after the call to FunImageGet(), in order to retrieve the updated bitpix
       value.  See the imblank example code for more details.

       It also can be useful to retrieve the World Coordinate System information from the Funtools structure. Funtools uses the the WCS Library
       developed by Doug Mink at SAO, which is available here.	(More information about the WCSTools project in general can be found here.)  The
       FunOpen() routine initializes two WCS structures that can be used with this WCS Library.  Applications can retrieve either of these two WCS
       structures using FunInfoGet():

	 FUN_WCS  struct WorldCoor * /* wcs structure, for image coordinates*/
	 FUN_WCS0 struct WorldCoor * /* wcs structure, for physical coordinates */

       The structure retrieved by FUN_WCS is a WCS library handle containing parameters suitable for use with image coordinates, regardless of
       whether the data are images or tables. For this structure, the WCS reference point (CRPIX) has been converted to image coordinates if the
       underlying file is a table (and therefore in physical coordinates). You therefore must ensure that the positions being passed to a routine
       like pix2wcs are in image coordinates. The FUN_WCS0 structure has not had its WCS reference point converted to image coordinates. It there-
       fore is useful when passing processing physical coordinates from a table.

       Once a WCS structure has been retrieved, it can be used as the first argument to the WCS library routines. (If the structure is NULL, no
       WCS information was contained in the file.) The two important WCS routines that Funtools uses are:

	 #include <wcs.h&gt
	 void pix2wcs (wcs,xpix,ypix,xpos,ypos)
	   struct WorldCoor *wcs; /* World coordinate system structure */
	   double xpix,ypix;	  /* x and y coordinates in pixels */
	   double *xpos,*ypos;	  /* RA and Dec in degrees (returned) */

       which converts pixel coordinates to sky coordinates, and:

	 void wcs2pix (wcs, xpos, ypos, xpix, ypix, offscl)
	   struct WorldCoor *wcs; /* World coordinate system structure */
	   double xpos,ypos;	  /* World coordinates in degrees */
	   double *xpix,*ypix;	  /* coordinates in pixels */
	   int *offscl; 	  /* 0 if within bounds, else off scale */

       which converts sky coordinates to pixel coordinates. Again, please note that the wcs structure returned by FUN_WCS assumes that image coor-
       dinates are passed to the pix2wcs routine, while FUN_WCS0 assumes that physical coordinates are passed.

       Note that funtools.h file automatically includes wcs.h.	An example program that utilizes these WCS structure to call WCS Library routines
       is twcs.c.

       The following is the complete list of information that can be returned:

	 name		 type		 comment
	 ---------	 --------	 ---------------------------------------------
	 FUN_FNAME     char *		 /* file name */
	 FUN_GIO       GIO		 /* gio handle */
	 FUN_HEADER    FITSHead 	 /* fitsy header struct */
	 FUN_TYPE      int		 /* TY_TABLE,TY_IMAGE,TY_EVENTS,TY_ARRAY */
	 FUN_BITPIX    int		 /* bits/pixel in file */
	 FUN_MIN1      int		 /* tlmin of axis1 -- tables */
	 FUN_MAX1      int		 /* tlmax of axis1 -- tables */
	 FUN_MIN2      int		 /* tlmin of axis2 -- tables */
	 FUN_MAX2      int		 /* tlmax of axis2 -- tables */
	 FUN_DIM1      int		 /* dimension of axis1 */
	 FUN_DIM2      int		 /* dimension of axis2 */
	 FUN_ENDIAN    int		 /* 0=little, 1=big endian */
	 FUN_FILTER    char *		 /* supplied filter */
	 FUN_IFUN      FITSHead 	 /* pointer to reference header */
	 FUN_IFUN0     FITSHead 	 /* same as above, but no reset performed */
	 /* image information */
	 FUN_DTYPE     int		 /* data type for images */
	 FUN_DLEN      int		 /* length of image in bytes */
	 FUN_DPAD      int		 /* padding to end of extension */
	 FUN_DOBLANK   int		 /* was blank keyword defined? */
	 FUN_BLANK     int		 /* value for blank */
	 FUN_SCALED    int		 /* was bscale/bzero defined? */
	 FUN_BSCALE    double		 /* bscale value */
	 FUN_BZERO     double		 /* bzero value */
	 /* table information */
	 FUN_NROWS     int		 /* number of rows in file (naxis2) */
	 FUN_ROWSIZE   int		 /* size of user row struct */
	 FUN_BINCOLS   char *		 /* specified binning columns */
	 FUN_OVERFLOW  int		 /* overflow detected during binning? */
	 /* array information */
	 FUN_SKIP      int		 /* bytes to skip in array header */
	 /* section information */
	 FUN_SECT_X0   int		 /* low dim1 value of section */
	 FUN_SECT_X1   int		 /* hi dim1 value of section */
	 FUN_SECT_Y0   int		 /* low dim2 value of section */
	 FUN_SECT_Y1   int		 /* hi dim2 value of section */
	 FUN_SECT_BLOCK int		 /* section block factor */
	 FUN_SECT_BTYPE int		 /* 's' (sum), 'a' (average) for binning */
	 FUN_SECT_DIM1 int		 /* dim1 for section */
	 FUN_SECT_DIM2 int		 /* dim2 for section */
	 FUN_SECT_BITPIX int		 /* bitpix for section */
	 FUN_SECT_DTYPE int		 /* data type for section */
	 FUN_RAWBUF    char *		 /* pointer to raw row buffer */
	 FUN_RAWSIZE   int		 /* byte size of raw row records */
	 /* column  information */
	 FUN_NCOL      int		 /* number of row columns defined */
	 FUN_COLS      FunCol		 /* array of row columns */
	 /* WCS information */
	 FUN_WCS       struct WorldCoor * /* wcs structure, converted for images*/
	 FUN_WCS0      struct WorldCoor * /* wcs structure, not converted */

       Row applications would not normally need any of this information.  An example of how these values can be used in more complex programs is
       the evnext example code. In this program, the time value for each row is changed to be the value of the succeeding row. The program thus
       reads the time values for a batch of rows, changes the time values to be the value for the succeeding row, and then merges these changed
       time values back with the other columns to the output file. It then reads the next batch, etc.

       This does not work for the last row read in each batch, since there is no succeeding row until the next batch is read. Therefore, the pro-
       gram saves that last row until it has read the next batch, then processes the former before starting on the new batch. In order to merge
       the last row successfully, the code uses FUN_RAWBUF to save and restore the raw input data associated with each batch of rows. Clearly,
       this requires some information about how funtools works internally. We are happy to help you write such programs as the need arises.

SEE ALSO

       See funtools(7) for a list of Funtools help pages

version 1.4.2							  January 2, 2008						     funinfoget(3)