File: cfitsio.toc

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