funcolumnlookup(3) [debian man page]

funcolumnlookup(3)						SAORD Documentation						funcolumnlookup(3)

NAME

       FunColumnLookup - lookup a Funtools column

SYNOPSIS

	 #include <funtools.h>

	 int FunColumnLookup(Fun fun, char *s, int which,
			     char **name, int *type, int *mode,
			     int *offset, int *n, int *width)

DESCRIPTION

       The FunColumnLookup() routine returns information about a named (or indexed) column.  The first argument is the Fun handle associated with
       this set of columns. The second argument is the name of the column to look up.  If the name argument is NULL, the argument that follows is
       the zero-based index into the column array of the column for which information should be returned.  The next argument is a pointer to a
       char *, which will contain the name of the column. The arguments that follow are the addresses of int values into which the following
       information will be returned:

       o   type: data type of column:

	   o   A: ASCII characters

	   o   B: unsigned 8-bit char

	   o   I: signed 16-bit int

	   o   U: unsigned 16-bit int (not standard FITS)

	   o   J: signed 32-bit int

	   o   V: unsigned 32-bit int (not standard FITS)

	   o   E: 32-bit float

	   o   D: 64-bit float

       o   mode: bit flag status of column, including:

	   o   COL_ACTIVE      1 is column activated?

	   o   COL_IBUF        2 is column in the raw input data?

	   o   COL_PTR	       4 is column a pointer to an array?

	   o   COL_READ      010 is read mode selected?

	   o   COL_WRITE     020 is write mode selected?

	   o   COL_REPLACEME 040 is this column being replaced by user data?

       o   offset: byte offset in struct

       o   n: number of elements (i.e. size of vector) in this column

       o   width: size in bytes of this column

       If the named column exists, the routine returns a positive integer, otherwise zero is returned. (The positive integer is the index+1 into
       the column array where this column was located.)

       If NULL is passed as the return address of one (or more) of these values, no data is passed back for that information.  For example:

	 if( !FunColumnLookup(fun, "phas", 0, NULL NULL, NULL, NULL, &npha, NULL) )
	   gerror(stderr, "can't find phas column
");

       only returns information about the size of the phas vector.

SEE ALSO

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

version 1.4.2							  January 2, 2008						funcolumnlookup(3)

Check Out this Related Man Page

funindex(1)							SAORD Documentation						       funindex(1)

NAME

       funindex - create an index for a column of a FITS binary table

SYNOPSIS

       funindex <switches>  <iname> [oname]

OPTIONS

	 NB: these options are not compatible with Funtools processing. Please
	 use the defaults instead.
	 -c	   # compress output using gzip"
	 -a	   # ASCII output, ignore -c (default: FITS table)"
	 -f	   # FITS table output (default: FITS table)"
	 -l	   # long output, i.e. with key value(s) (default: long)"
	 -s	   # short output, i.e. no key value(s) (default: long)"

DESCRIPTION

       The funindex script creates an index for the specified column (key) by running funtable -s (sort) and then saving the column value and the
       record number for each sorted row. This index will be used automatically
	by funtools filtering of that column, provided the index file's modification date is later than that of the data file.

       The first required argument is the name of the FITS binary table to index. Please note that text files cannot be indexed at this time.  The
       second required argument is the column (key) name to index. While multiple keys can be specified in principle, the funtools index process-
       ing assume a single key and will not recognize files containing multiple keys.

       By default, the output index file name is [root]_[key].idx, where [root] is the root of the input file. Funtools looks for this specific
       file name when deciding whether to use an index for faster filtering. Therefore, the optional third argument (output file name) should not
       be used for funtools processing.

       For example, to create an index on column Y for a given FITS file, use:

	 funindex foo.fits Y

       This will generate an index named foo_y.idx, which will be used by funtools for filters involving the Y column.

SEE ALSO

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

version 1.4.2							  January 2, 2008						       funindex(1)

Linux and UNIX Man Pages

funcolumnlookup(3) [debian man page]

Check Out this Related Man Page