"Fossies" - the Fresh Open Source Software Archive

Member "cfitsio-4.0.0/docs/fitsio.toc" (20 May 2021, 7342 Bytes) of package /linux/misc/cfitsio-4.0.0.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 \contentsline {chapter}{\numberline {1}Introduction }{1}
    2 \contentsline {chapter}{\numberline {2} Creating FITSIO/CFITSIO }{3}
    3 \contentsline {section}{\numberline {2.1}Building the Library}{3}
    4 \contentsline {section}{\numberline {2.2}Testing the Library}{6}
    5 \contentsline {section}{\numberline {2.3}Linking Programs with FITSIO}{7}
    6 \contentsline {section}{\numberline {2.4}Getting Started with FITSIO}{7}
    7 \contentsline {section}{\numberline {2.5}Example Program}{8}
    8 \contentsline {section}{\numberline {2.6}Legal Stuff}{9}
    9 \contentsline {section}{\numberline {2.7}Acknowledgments}{10}
   10 \contentsline {chapter}{\numberline {3} A FITS Primer }{13}
   11 \contentsline {chapter}{\numberline {4}FITSIO Conventions and Guidelines }{15}
   12 \contentsline {section}{\numberline {4.1}CFITSIO Size Limitations}{15}
   13 \contentsline {section}{\numberline {4.2}Multiple Access to the Same FITS File}{16}
   14 \contentsline {section}{\numberline {4.3}Current Header Data Unit (CHDU)}{16}
   15 \contentsline {section}{\numberline {4.4}Subroutine Names}{16}
   16 \contentsline {section}{\numberline {4.5}Subroutine Families and Datatypes}{17}
   17 \contentsline {section}{\numberline {4.6}Implicit Data Type Conversion}{17}
   18 \contentsline {section}{\numberline {4.7}Data Scaling}{18}
   19 \contentsline {section}{\numberline {4.8}Error Status Values and the Error Message Stack}{18}
   20 \contentsline {section}{\numberline {4.9}Variable-Length Array Facility in Binary Tables}{19}
   21 \contentsline {section}{\numberline {4.10}Support for IEEE Special Values}{20}
   22 \contentsline {section}{\numberline {4.11}When the Final Size of the FITS HDU is Unknown}{21}
   23 \contentsline {section}{\numberline {4.12}Local FITS Conventions supported by FITSIO}{21}
   24 \contentsline {subsection}{\numberline {4.12.1}Support for Long String Keyword Values.}{21}
   25 \contentsline {subsection}{\numberline {4.12.2}Arrays of Fixed-Length Strings in Binary Tables}{22}
   26 \contentsline {subsection}{\numberline {4.12.3}Keyword Units Strings}{23}
   27 \contentsline {subsection}{\numberline {4.12.4}HIERARCH Convention for Extended Keyword Names}{23}
   28 \contentsline {section}{\numberline {4.13}Optimizing Code for Maximum Processing Speed}{24}
   29 \contentsline {subsection}{\numberline {4.13.1}Background Information: How CFITSIO Manages Data I/O}{24}
   30 \contentsline {subsection}{\numberline {4.13.2}Optimization Strategies}{25}
   31 \contentsline {chapter}{\numberline {5} Basic Interface Routines }{29}
   32 \contentsline {section}{\numberline {5.1}FITSIO Error Status Routines }{29}
   33 \contentsline {section}{\numberline {5.2}File I/O Routines}{30}
   34 \contentsline {section}{\numberline {5.3}Keyword I/O Routines}{32}
   35 \contentsline {section}{\numberline {5.4}Data I/O Routines}{33}
   36 \contentsline {chapter}{\numberline {6} Advanced Interface Subroutines }{35}
   37 \contentsline {section}{\numberline {6.1}FITS File Open and Close Subroutines: }{35}
   38 \contentsline {section}{\numberline {6.2}HDU-Level Operations }{38}
   39 \contentsline {section}{\numberline {6.3}Define or Redefine the structure of the CHDU }{41}
   40 \contentsline {section}{\numberline {6.4}FITS Header I/O Subroutines}{43}
   41 \contentsline {subsection}{\numberline {6.4.1}Header Space and Position Routines }{43}
   42 \contentsline {subsection}{\numberline {6.4.2}Read or Write Standard Header Routines }{43}
   43 \contentsline {subsection}{\numberline {6.4.3}Write Keyword Subroutines }{45}
   44 \contentsline {subsection}{\numberline {6.4.4}Insert Keyword Subroutines }{47}
   45 \contentsline {subsection}{\numberline {6.4.5}Read Keyword Subroutines }{47}
   46 \contentsline {subsection}{\numberline {6.4.6}Modify Keyword Subroutines }{49}
   47 \contentsline {subsection}{\numberline {6.4.7}Update Keyword Subroutines }{50}
   48 \contentsline {subsection}{\numberline {6.4.8}Delete Keyword Subroutines }{51}
   49 \contentsline {section}{\numberline {6.5}Data Scaling and Undefined Pixel Parameters }{51}
   50 \contentsline {section}{\numberline {6.6}FITS Primary Array or IMAGE Extension I/O Subroutines }{52}
   51 \contentsline {section}{\numberline {6.7}FITS ASCII and Binary Table Data I/O Subroutines}{55}
   52 \contentsline {subsection}{\numberline {6.7.1}Column Information Subroutines }{55}
   53 \contentsline {subsection}{\numberline {6.7.2}Low-Level Table Access Subroutines }{58}
   54 \contentsline {subsection}{\numberline {6.7.3}Edit Rows or Columns }{59}
   55 \contentsline {subsection}{\numberline {6.7.4}Read and Write Column Data Routines }{60}
   56 \contentsline {section}{\numberline {6.8}Row Selection and Calculator Routines }{64}
   57 \contentsline {section}{\numberline {6.9}Celestial Coordinate System Subroutines }{65}
   58 \contentsline {section}{\numberline {6.10}File Checksum Subroutines }{67}
   59 \contentsline {section}{\numberline {6.11} Date and Time Utility Routines }{68}
   60 \contentsline {section}{\numberline {6.12}General Utility Subroutines }{69}
   61 \contentsline {chapter}{\numberline {7} The CFITSIO Iterator Function }{77}
   62 \contentsline {chapter}{\numberline {8} Extended File Name Syntax }{79}
   63 \contentsline {section}{\numberline {8.1}Overview}{79}
   64 \contentsline {section}{\numberline {8.2}Filetype}{82}
   65 \contentsline {subsection}{\numberline {8.2.1}Notes about HTTP proxy servers}{82}
   66 \contentsline {subsection}{\numberline {8.2.2}Notes about the stream filetype driver}{83}
   67 \contentsline {subsection}{\numberline {8.2.3}Notes about the gsiftp filetype}{84}
   68 \contentsline {subsection}{\numberline {8.2.4}Notes about the root filetype}{84}
   69 \contentsline {subsection}{\numberline {8.2.5}Notes about the shmem filetype:}{86}
   70 \contentsline {section}{\numberline {8.3}Base Filename}{86}
   71 \contentsline {section}{\numberline {8.4}Output File Name when Opening an Existing File}{88}
   72 \contentsline {section}{\numberline {8.5}Template File Name when Creating a New File}{90}
   73 \contentsline {section}{\numberline {8.6}Image Tile-Compression Specification}{90}
   74 \contentsline {section}{\numberline {8.7}HDU Location Specification}{90}
   75 \contentsline {section}{\numberline {8.8}Image Section}{91}
   76 \contentsline {section}{\numberline {8.9}Image Transform Filters}{92}
   77 \contentsline {section}{\numberline {8.10}Column and Keyword Filtering Specification}{94}
   78 \contentsline {section}{\numberline {8.11}Row Filtering Specification}{97}
   79 \contentsline {subsection}{\numberline {8.11.1}General Syntax}{97}
   80 \contentsline {subsection}{\numberline {8.11.2}Bit Masks}{100}
   81 \contentsline {subsection}{\numberline {8.11.3}Vector Columns}{101}
   82 \contentsline {subsection}{\numberline {8.11.4}Good Time Interval Filtering and Calculation}{103}
   83 \contentsline {subsection}{\numberline {8.11.5}Spatial Region Filtering}{104}
   84 \contentsline {subsection}{\numberline {8.11.6}Example Row Filters}{107}
   85 \contentsline {section}{\numberline {8.12} Binning or Histogramming Specification}{108}
   86 \contentsline {chapter}{\numberline {9}Template Files }{111}
   87 \contentsline {section}{\numberline {9.1}Detailed Template Line Format}{111}
   88 \contentsline {section}{\numberline {9.2}Auto-indexing of Keywords}{112}
   89 \contentsline {section}{\numberline {9.3}Template Parser Directives}{113}
   90 \contentsline {section}{\numberline {9.4}Formal Template Syntax}{114}
   91 \contentsline {section}{\numberline {9.5}Errors}{114}
   92 \contentsline {section}{\numberline {9.6}Examples}{114}
   93 \contentsline {chapter}{\numberline {10} Summary of all FITSIO User-Interface Subroutines }{117}
   94 \contentsline {chapter}{\numberline {11} Parameter Definitions }{125}
   95 \contentsline {chapter}{\numberline {12} FITSIO Error Status Codes }{131}