File: README

package info (click to toggle)
fitsverify 4.20-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 288 kB
  • sloc: ansic: 4,868; sh: 14; makefile: 9
file content (142 lines) | stat: -rw-r--r-- 7,240 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
This package contains the source code for the fitsverify FITS file
conformance verification program.  It is maintained by the HEASARC
at NASA/GSFC (http://heasarc.gsfc.nasa.gov).  This is a stand-alone
version of the fverify task in the FTOOLS package.

The CFITSIO library, also available from the HEASARC, is required
to compile and build fitsverify.  In particular, the fitsio.h, and
longnam.h include files are needed to compile the program, which
must then be linked  with the CFITSIO library itself (i.e., the file
libcfitsio.a on unix systems).

fitsverify can be built on most unix machines with a command similar
to the following:

gcc -o fitsverify ftverify.c fvrf_data.c fvrf_file.c fvrf_head.c
       fvrf_key.c fvrf_misc.c -DSTANDALONE -I/path/to/my/cfitsio 
       -L/path/to/my/cfitsio -lcfitsio -lm -lnsl -lsocket

Where you should substitute "/path/to/my/cfitsio" with the location
of the cfitsio header files and library on your system.  Note also
that the '-lm', '-lnsl' and '-lsocket' library directives may not be
required on all platforms.

Optionally, one may add the -DERR2OUT flag to force all the error
messages to go to stdout rather than stderr (usually only useful
if the output of fitsverify is being piped to another file or task).

To build fitsverify with Visual C++ on Windows PCs, first execute the 
vcvars32.bat file that is distributed with vcc,  unpack the fitverify
.zip file, then excute the following command:

cl /MD ftverify.c fvrf_data.c fvrf_file.c fvrf_head.c fvrf_key.c
    fvrf_misc.c -DSTANDALONE /link setargv.obj cfitsio.lib

(The "/link setargv.obj" is optional and just enables support
for wildcard characters (like *) in the input file names).

A help file describing the features of fitsverify can be produced
by entering the command 'fitsverify -h'.  The help file
is reproduced below:

----------------------------------------------------------------
fitsverify -- Verify that the input files conform to the FITS Standard.

USAGE:   fitsverify filename ...  - verify one or more FITS files
                                    (may use wildcard characters)
   or    fitsverify @filelist.txt - verify a list of FITS files
      
   Optional flags:
          -l  list all header keywords
          -q  quiet; print one-line pass/fail summary per file
          -e  only test for error conditions (ignore warnings)
 
   fitsverify exits with a status equal to the number of errors + warnings.
        
EXAMPLES:
     fitsverify -l m101.fits    - produce a detailed verificaton report of
                                  a single file, including a keyword listing
     fitsverify -q *.fits *.fit - verify all files with .fits or .fit
                                  extensions, writing a 1-line pass/fail
                                  message for each file
 
DESCRIPTION:
    
    This task reads one or more input FITS files and verifies that the
    files conform to the specifications of the FITS Standard, Definition
    of the Flexible Image Transport System (FITS), Version 3.0, available
    online  at http://fits.gsfc.nasa.gov/.  The input filename template may
    contain wildcard characters, in which case all matching files will be 
    tested.  Alternatively, the name of an ASCII text file containing a list
    of file names, one per line, may be entered preceded by an '@' character.
    The following error or warning conditions will be reported:
    
    ERROR CONDITIONS
    
     - Mandatory keyword not present or out of order
     - Mandatory keyword has wrong datatype or illegal value
     - END header keyword is not present
     - Sum of table column widths is inconsistent with NAXIS1 value
     - BLANK keyword present in image with floating-point datatype
     - TNULLn keyword present for floating-point binary table column
     - Bit column has non-zero fill bits or is not left adjusted 
     - ASCII TABLE column contains illegal value inconsistent with TFORMn
     - Address to a variable length array not within the data heap 
     - Extraneous bytes in the FITS file following the last HDU    
     - Mandatory keyword values not expressed in fixed format
     - Mandatory keyword duplicated elsewhere in the header
     - Header contains illegal ASCII character (not ASCII 32 - 126)
     - Keyword name contains illegal character
     - Keyword value field has illegal format
     - Value and comment fields not separated by a slash character
     - END keyword not filled with blanks in columns 9 - 80
     - Reserved keyword with wrong datatype or illegal value
     - XTENSION keyword in the primary array
     - Column related keyword (TFIELDS, TTYPEn,TFORMn, etc.) in an image
     - SIMPLE, EXTEND, or BLOCKED keyword in any extension
     - BSCALE, BZERO, BUNIT, BLANK, DATAMAX, DATAMIN keywords in a table
     - Table WCS keywords (TCTYPn, TCRPXn, TCRVLn, etc.) in an image
     - TDIMn or THEAP keyword in an ASCII table 
     - TBCOLn keyword in a Binary table
     - THEAP keyword in a binary table that has PCOUNT = 0 
     - XTENSION, TFORMn, TDISPn or TDIMn value contains leading space(s)
     - WCSAXES keyword appears after other WCS keywords
     - Index of any WCS keyword (CRPIXn, CRVALn, etc.) greater than 
       value of WCSAXES
     - Index of any table column descriptor keyword (TTYPEn, TFORMn,
       etc.) greater than value of TFIELDS
     - TSCALn or TZEROn present for an ASCII, logical, or Bit column
     - TDISPn value is inconsistent with the column datatype 
     - Length of a variable length array greater than the maximum 
       length as given by the TFORMn keyword
     - ASCII table floating-point column value does not have decimal point(*)
     - ASCII table numeric column value has embedded space character
     - Logical column contains illegal value not equal to 'T', 'F', or 0
     - Character string column contains non-ASCII text character
     - Header fill bytes not all blanks
     - Data fill bytes not all blanks in ASCII tables or all zeros 
       in any other type of HDU 
     - Gaps between defined ASCII table columns contain characters with
       ASCII value > 127
    
    WARNING CONDITIONS
    
     - SIMPLE = F
     - Presence of deprecated keywords BLOCKED or EPOCH
     - 2 HDUs have identical EXTNAME, EXTVER, and EXTLEVEL values
     - BSCALE or TSCALn value = 0.
     - BLANK OR TNULLn value exceeds the legal range
     - TFORMn has 'rAw' format and r is not a multiple of w
     - DATE = 'dd/mm/yy' and yy is less than 10 (Y2K problem?)
     - Index of any WCS keyword (CRPIXn, CRVALn, etc.) greater than
       value of NAXIS, if the WCSAXES keyword is not present
     - Duplicated keyword (except COMMENT, HISTORY, blank, etc.)
     - Column name (TTYPEn) does not exist or contains characters 
       other than letter, digit and underscore
     - Calculated checksum inconsistent with CHECKSUM or DATASUM keyword
     - Row length or heap offset greater than signed int max for
        'P' format variable length columns.
        
    This is the stand alone version of the FTOOLS 'fverify' program.  It is
    maintained by the HEASARC at NASA/GSFC.  Any comments about this program
    should be submitted to http://heasarc.gsfc.nasa.gov/cgi-bin/ftoolshelp