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
|
\contentsline {chapter}{\numberline {1}Introduction }{1}%
\contentsline {section}{\numberline {1.1} A Brief Overview}{1}%
\contentsline {section}{\numberline {1.2}Sources of FITS Software and Information}{1}%
\contentsline {section}{\numberline {1.3}Acknowledgments}{2}%
\contentsline {section}{\numberline {1.4}Legal Stuff}{4}%
\contentsline {chapter}{\numberline {2} Creating the CFITSIO Library }{5}%
\contentsline {section}{\numberline {2.1}Building the Library}{5}%
\contentsline {subsection}{\numberline {2.1.1}Unix Systems}{5}%
\contentsline {subsection}{\numberline {2.1.2}VMS}{7}%
\contentsline {subsection}{\numberline {2.1.3}Windows PCs}{7}%
\contentsline {subsection}{\numberline {2.1.4}Macintosh PCs}{7}%
\contentsline {section}{\numberline {2.2}Testing the Library}{7}%
\contentsline {section}{\numberline {2.3}Linking Programs with CFITSIO}{9}%
\contentsline {section}{\numberline {2.4}Using CFITSIO in Multi-threaded Environments}{9}%
\contentsline {section}{\numberline {2.5}Getting Started with CFITSIO}{9}%
\contentsline {section}{\numberline {2.6}Example Program}{10}%
\contentsline {chapter}{\numberline {3} A FITS Primer }{13}%
\contentsline {chapter}{\numberline {4} Programming Guidelines }{15}%
\contentsline {section}{\numberline {4.1}CFITSIO Definitions}{15}%
\contentsline {section}{\numberline {4.2}Current Header Data Unit (CHDU)}{18}%
\contentsline {section}{\numberline {4.3}Function Names and Variable Datatypes}{18}%
\contentsline {section}{\numberline {4.4}Support for Unsigned Integers and Signed Bytes}{20}%
\contentsline {section}{\numberline {4.5}Dealing with Character Strings }{22}%
\contentsline {section}{\numberline {4.6}Implicit Data Type Conversion}{23}%
\contentsline {section}{\numberline {4.7}Data Scaling}{23}%
\contentsline {section}{\numberline {4.8}Support for IEEE Special Values}{24}%
\contentsline {section}{\numberline {4.9}Error Status Values and the Error Message Stack}{25}%
\contentsline {section}{\numberline {4.10}Variable-Length Arrays in Binary Tables}{25}%
\contentsline {section}{\numberline {4.11}Multiple Access to the Same FITS File}{27}%
\contentsline {section}{\numberline {4.12}When the Final Size of the FITS HDU is Unknown}{28}%
\contentsline {section}{\numberline {4.13}CFITSIO Size Limitations}{28}%
\contentsline {chapter}{\numberline {5}Basic CFITSIO Interface Routines }{31}%
\contentsline {section}{\numberline {5.1}CFITSIO Error Status Routines}{31}%
\contentsline {section}{\numberline {5.2}FITS File Access Routines}{32}%
\contentsline {section}{\numberline {5.3}HDU Access Routines}{35}%
\contentsline {section}{\numberline {5.4}Header Keyword Read/Write Routines}{37}%
\contentsline {subsection}{\numberline {5.4.1}Keyword Reading Routines}{38}%
\contentsline {subsection}{\numberline {5.4.2}Keyword Writing Routines}{41}%
\contentsline {section}{\numberline {5.5}Primary Array or IMAGE Extension I/O Routines}{43}%
\contentsline {section}{\numberline {5.6}Image Compression}{47}%
\contentsline {section}{\numberline {5.7}ASCII and Binary Table Routines}{53}%
\contentsline {subsection}{\numberline {5.7.1}Create New Table}{53}%
\contentsline {subsection}{\numberline {5.7.2}Column Information Routines}{54}%
\contentsline {subsection}{\numberline {5.7.3}Routines to Edit Rows or Columns}{57}%
\contentsline {subsection}{\numberline {5.7.4}Read and Write Column Data Routines}{59}%
\contentsline {subsection}{\numberline {5.7.5}Row Selection and Calculator Routines}{61}%
\contentsline {subsection}{\numberline {5.7.6}Column Binning or Histogramming Routines}{63}%
\contentsline {section}{\numberline {5.8}Utility Routines}{65}%
\contentsline {subsection}{\numberline {5.8.1}File Checksum Routines}{65}%
\contentsline {subsection}{\numberline {5.8.2}Date and Time Utility Routines}{67}%
\contentsline {subsection}{\numberline {5.8.3}General Utility Routines}{68}%
\contentsline {chapter}{\numberline {6} The CFITSIO Iterator Function }{79}%
\contentsline {section}{\numberline {6.1}The Iterator Work Function}{80}%
\contentsline {section}{\numberline {6.2}The Iterator Driver Function}{82}%
\contentsline {section}{\numberline {6.3}Guidelines for Using the Iterator Function}{83}%
\contentsline {section}{\numberline {6.4}Complete List of Iterator Routines}{84}%
\contentsline {chapter}{\numberline {7} World Coordinate System Routines }{87}%
\contentsline {section}{\numberline {7.1} Self-contained WCS Routines}{88}%
\contentsline {chapter}{\numberline {8} Hierarchical Grouping Routines }{91}%
\contentsline {section}{\numberline {8.1}Grouping Table Routines}{92}%
\contentsline {section}{\numberline {8.2}Group Member Routines}{94}%
\contentsline {chapter}{\numberline {9} Specialized CFITSIO Interface Routines }{97}%
\contentsline {section}{\numberline {9.1}FITS File Access Routines}{97}%
\contentsline {subsection}{\numberline {9.1.1}File Access}{97}%
\contentsline {subsection}{\numberline {9.1.2}Download Utility Functions}{101}%
\contentsline {section}{\numberline {9.2}HDU Access Routines}{102}%
\contentsline {section}{\numberline {9.3}Specialized Header Keyword Routines}{104}%
\contentsline {subsection}{\numberline {9.3.1}Header Information Routines}{104}%
\contentsline {subsection}{\numberline {9.3.2}Read and Write the Required Keywords}{104}%
\contentsline {subsection}{\numberline {9.3.3}Write Keyword Routines}{106}%
\contentsline {subsection}{\numberline {9.3.4}Insert Keyword Routines}{108}%
\contentsline {subsection}{\numberline {9.3.5}Read Keyword Routines}{109}%
\contentsline {subsection}{\numberline {9.3.6}Modify Keyword Routines}{111}%
\contentsline {subsection}{\numberline {9.3.7}Update Keyword Routines}{112}%
\contentsline {section}{\numberline {9.4}Define Data Scaling and Undefined Pixel Parameters}{113}%
\contentsline {section}{\numberline {9.5}Specialized FITS Primary Array or IMAGE Extension I/O Routines}{114}%
\contentsline {section}{\numberline {9.6}Specialized FITS ASCII and Binary Table Routines}{117}%
\contentsline {subsection}{\numberline {9.6.1}General Column Routines}{117}%
\contentsline {subsection}{\numberline {9.6.2}Low-Level Table Access Routines}{119}%
\contentsline {subsection}{\numberline {9.6.3}Write Column Data Routines}{119}%
\contentsline {subsection}{\numberline {9.6.4}Read Column Data Routines }{120}%
\contentsline {chapter}{\numberline {10} Extended File Name Syntax }{125}%
\contentsline {section}{\numberline {10.1}Overview}{125}%
\contentsline {section}{\numberline {10.2}Filetype}{128}%
\contentsline {subsection}{\numberline {10.2.1}Notes about HTTP proxy servers}{129}%
\contentsline {subsection}{\numberline {10.2.2}Notes about HTTPS and FTPS file access}{129}%
\contentsline {subsection}{\numberline {10.2.3}Notes about the stream filetype driver}{130}%
\contentsline {subsection}{\numberline {10.2.4}Notes about the gsiftp filetype}{131}%
\contentsline {subsection}{\numberline {10.2.5}Notes about the root filetype}{131}%
\contentsline {subsection}{\numberline {10.2.6}Notes about the shmem filetype:}{133}%
\contentsline {section}{\numberline {10.3}Base Filename}{133}%
\contentsline {section}{\numberline {10.4}Output File Name when Opening an Existing File}{135}%
\contentsline {section}{\numberline {10.5}Template File Name when Creating a New File}{137}%
\contentsline {section}{\numberline {10.6}Image Tile-Compression Specification}{137}%
\contentsline {section}{\numberline {10.7}HDU Location Specification}{137}%
\contentsline {section}{\numberline {10.8}Image Section}{139}%
\contentsline {section}{\numberline {10.9}Image Transform Filters}{140}%
\contentsline {section}{\numberline {10.10}Column and Keyword Filtering Specification}{141}%
\contentsline {section}{\numberline {10.11}Row Filtering Specification}{145}%
\contentsline {subsection}{\numberline {10.11.1}General Syntax}{145}%
\contentsline {subsection}{\numberline {10.11.2}Bit Masks}{148}%
\contentsline {subsection}{\numberline {10.11.3}Vector Columns}{149}%
\contentsline {subsection}{\numberline {10.11.4}Row Access}{151}%
\contentsline {subsection}{\numberline {10.11.5}Good Time Interval Filtering and Calculation}{152}%
\contentsline {subsection}{\numberline {10.11.6}Spatial Region Filtering}{154}%
\contentsline {subsection}{\numberline {10.11.7}Example Row Filters}{156}%
\contentsline {section}{\numberline {10.12} Binning or Histogramming Specification}{157}%
\contentsline {chapter}{\numberline {11}Template Files }{161}%
\contentsline {section}{\numberline {11.1}Detailed Template Line Format}{161}%
\contentsline {section}{\numberline {11.2}Auto-indexing of Keywords}{162}%
\contentsline {section}{\numberline {11.3}Template Parser Directives}{163}%
\contentsline {section}{\numberline {11.4}Formal Template Syntax}{164}%
\contentsline {section}{\numberline {11.5}Errors}{164}%
\contentsline {section}{\numberline {11.6}Examples}{164}%
\contentsline {chapter}{\numberline {12} Local FITS Conventions }{167}%
\contentsline {section}{\numberline {12.1}64-Bit Long Integers}{167}%
\contentsline {section}{\numberline {12.2}Long String Keyword Values.}{167}%
\contentsline {section}{\numberline {12.3}Arrays of Fixed-Length Strings in Binary Tables}{169}%
\contentsline {section}{\numberline {12.4}Keyword Units Strings}{169}%
\contentsline {section}{\numberline {12.5}HIERARCH Convention for Extended Keyword Names}{169}%
\contentsline {section}{\numberline {12.6}Tile-Compressed Image Format}{170}%
\contentsline {chapter}{\numberline {13} Optimizing Programs }{173}%
\contentsline {section}{\numberline {13.1}How CFITSIO Manages Data I/O}{173}%
\contentsline {section}{\numberline {13.2}Optimization Strategies}{174}%
\contentsline {chapter}{\numberline {A}Index of Routines }{179}%
\contentsline {chapter}{\numberline {B}Parameter Definitions }{185}%
\contentsline {chapter}{\numberline {C}CFITSIO Error Status Codes }{191}%
|
