1funindex(1)                   SAORD Documentation                  funindex(1)
2
3
4

NAME

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

SYNOPSIS

9       funindex <switches>  <iname> [oname]
10

OPTIONS

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

DESCRIPTION

21       The funindex script creates an index for the specified column (key) by
22       running funtable -s (sort) and then saving the column value and the
23       record number for each sorted row. This index will be used automati‐
24       cally
25        by funtools filtering of that column, provided the index file's modi‐
26       fication date is later than that of the data file.
27
28       The first required argument is the name of the FITS binary table to
29       index. Please note that text files cannot be indexed at this time.  The
30       second required argument is the column (key) name to index. While mul‐
31       tiple keys can be specified in principle, the funtools index processing
32       assume a single key and will not recognize files containing multiple
33       keys.
34
35       By default, the output index file name is [root]_[key].idx, where
36       [root] is the root of the input file. Funtools looks for this specific
37       file name when deciding whether to use an index for faster filtering.
38       Therefore, the optional third argument (output file name) should not be
39       used for funtools processing.
40
41       For example, to create an index on column Y for a given FITS file, use:
42
43         funindex foo.fits Y
44
45       This will generate an index named foo_y.idx, which will be used by fun‐
46       tools for filters involving the Y column.
47

SEE ALSO

49       See funtools(n) for a list of Funtools help pages
50
51
52
53version 1.4.0                   August 15, 2007                    funindex(1)
Impressum