These options are to do with the input and outputs of the various programs.
The name or number of the desired Header Data Unit, or HDU, in the FITS
image. A FITS file can store multiple HDUs or extensions, each with either
an image or a table or nothing at all (only a header). Note that counting
of the extensions starts from 0(zero), not 1(one). Counting from 0 is
forced on us by CFITSIO which directly reads the value you give with this
option (see CFITSIO). When specifying the name, case is not important
ImAgE are equivalent.
CFITSIO has many capabilities to help you find the extension you want, far
beyond the simple extension number and name. See CFITSIO manual’s “HDU
Location Specification” section for a very complete explanation with
several examples. A
# is appended to the string you specify for the
and the result is put in square brackets and appended to the FITS file name
before calling CFITSIO to read the contents of the HDU for all the programs
Where to match/search for columns when the column identifier wasn’t a
number, see Selecting table columns. The acceptable values are
comment. This option is only
relevant for programs that take table columns as input.
Ignore case while matching/searching column meta-data (in the field specified by the --searchin). The FITS standard suggests to treat the column names as case insensitive, which is strongly recommended here also but is not enforced. This option is only relevant for programs that take table columns as input.
This option is not relevant to BuildProgram, hence in that program the short option -I is used for include directories, not to ignore case.
The name of the output file or directory. With this option the automatic output names explained in Automatic output are ignored.
The data type of the output depending on the program context. This option isn’t applicable to some programs like Fits and will be ignored by them. The different acceptable values to this option are fully described in Numeric data types.
By default, if the output file already exists, Gnuastro’s programs will silently delete it and put their own outputs in its place. When this option is activated, if the output file already exists, the programs will not delete it, will warn you, and will abort.
In automatic output names, don’t remove the directory information of the input file names. As explained in Automatic output, if no output name is specified (with --output), then the output name will be made in the existing directory based on your input’s file name (ignoring the directory of the input). If you call this option, the directory information of the input will be kept and the automatically generated output name will be in the same directory as the input (usually with a suffix added). Note that his is only relevant if you are running the program in a different directory than the input data.
The output table’s type. This option is only relevant when the output is a table and its format cannot be deduced from its filename. For example, if a name ending in .fits was given to --output, then the program knows you want a FITS table. But there are two types of FITS tables: FITS ASCII, and FITS binary. Thus, with this option, the program is able to identify which type you want. The currently recognized values to this option are:
A plain text table with white-space characters between the columns (see Gnuastro text table format).
A FITS ASCII table (see Recognized table formats).
A FITS binary table (see Recognized table formats).
# character, CFITSIO will only read the
desired HDU into your memory, not all the existing HDUs in the fits file.