Changeset 16365 for trunk/psModules/src/camera/pmFPARead.h
- Timestamp:
- Feb 7, 2008, 5:16:12 PM (18 years ago)
- File:
-
- 1 edited
-
trunk/psModules/src/camera/pmFPARead.h (modified) (8 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/psModules/src/camera/pmFPARead.h
r13768 r16365 4 4 * @author Paul Price, IfA 5 5 * 6 * @version $Revision: 1. 9$ $Name: not supported by cvs2svn $7 * @date $Date: 200 7-06-12 22:22:33$6 * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ 7 * @date $Date: 2008-02-08 03:16:12 $ 8 8 * Copyright 2005-2006 Institute for Astronomy, University of Hawaii 9 9 */ … … 15 15 /// @{ 16 16 17 /// Read a readout incrementally 17 /// Check to see if there is more to read when reading a readout incrementally 18 bool pmReadoutMore(pmReadout *readout, ///< Readout of interest 19 psFits *fits, ///< FITS file from which to read 20 int z, ///< Readout number/plane; zero-offset indexing 21 int numScans ///< Number of scans (rows/cols) to read 22 ); 23 24 /// Read a chunk of a readout. 25 /// 26 /// Allows reading the readout incrementally 27 bool pmReadoutReadChunk(pmReadout *readout, ///< Readout of interest 28 psFits *fits, ///< FITS file from which to read 29 int z, ///< Readout number/plane; zero-offset indexing 30 int numScans ///< Number of scans (rows/cols) to read 31 ); 32 33 /// Read the entire readout 34 bool pmReadoutRead(pmReadout *readout, ///< Readout of interest 35 psFits *fits, ///< FITS file from which to read 36 int z ///< Readout number/plane; zero-offset indexing 37 ); 38 39 /// Read a readout incrementally --- this is maintained temporarily only for backwards compatibility; it has 40 /// been replaced by pmReadoutRead, pmReadoutReadChunk and pmReadoutMore. 18 41 /// 19 42 /// Multiple calls to this function moves through a readout within a cell incrementally. It is required to … … 25 48 /// Use pmReadoutWriteNext to write the data that's read by this function. This function is intended for 26 49 /// reading in many readouts into memory at once (e.g., for stacking) where the input is not written out. 27 bool pmReadoutReadNext(bool *status, 28 50 bool pmReadoutReadNext(bool *status, // non-error exit condition? 51 pmReadout *readout, // Readout into which to read 29 52 psFits *fits, // FITS file from which to read 30 53 int z, // Readout number/plane; zero-offset indexing 31 54 int numRows // The number of rows to read 32 55 ); 56 57 /// Return the number of readouts within a cell 58 /// 59 /// This function is type-independent (doesn't matter if you are interested in the image/mask/weight). 60 int pmCellNumReadouts(pmCell *cell, psFits *fits); 33 61 34 62 /// Read an entire cell … … 57 85 ); 58 86 87 // Mask functions follow 88 89 /// Check to see if there is more to read when reading a readout incrementally into the mask 90 bool pmReadoutMoreMask(pmReadout *readout, ///< Readout of interest 91 psFits *fits, ///< FITS file from which to read 92 int z, ///< Readout number/plane; zero-offset indexing 93 int numScans ///< Number of scans (rows/cols) to read 94 ); 95 96 /// Read a chunk of a readout into the mask 97 /// 98 /// Allows reading the readout incrementally 99 bool pmReadoutReadChunkMask(pmReadout *readout, ///< Readout of interest 100 psFits *fits, ///< FITS file from which to read 101 int z, ///< Readout number/plane; zero-offset indexing 102 int numScans ///< Number of scans (rows/cols) to read 103 ); 104 105 /// Read the entire readout into the mask 106 bool pmReadoutReadMask(pmReadout *readout, ///< Readout of interest 107 psFits *fits, ///< FITS file from which to read 108 int z ///< Readout number/plane; zero-offset indexing 109 ); 110 59 111 /// Read an entire cell into the mask 60 112 /// 61 113 /// Same as pmCellRead, but reads into the mask element of the readouts. 62 bool pmCellReadMask(pmCell *cell, 63 psFits *fits, 64 psDB *db 114 bool pmCellReadMask(pmCell *cell, // Cell to read into 115 psFits *fits, // FITS file from which to read 116 psDB *db // Database handle, for "concepts" ingest 65 117 ); 66 118 … … 68 120 /// 69 121 /// Same as pmChipRead, but reads into the mask element of the readouts. 70 bool pmChipReadMask(pmChip *chip, 71 psFits *fits, 72 psDB *db 122 bool pmChipReadMask(pmChip *chip, // Chip to read into 123 psFits *fits, // FITS file from which to read 124 psDB *db // Database handle, for "concepts" ingest 73 125 ); 74 126 … … 76 128 /// 77 129 /// Same as pmFPARead, but reads into the mask element of the readouts. 78 bool pmFPAReadMask(pmFPA *fpa, 79 psFits *fits, 80 psDB *db 130 bool pmFPAReadMask(pmFPA *fpa, // FPA to read into 131 psFits *fits, // FITS file from which to read 132 psDB *db // Database handle, for "concepts" ingest 81 133 ); 134 135 // Weight functions follow 136 137 /// Check to see if there is more to read when reading a readout incrementally into the weight 138 bool pmReadoutMoreWeight(pmReadout *readout, ///< Readout of interest 139 psFits *fits, ///< FITS file from which to read 140 int z, ///< Readout number/plane; zero-offset indexing 141 int numScans ///< Number of scans (rows/cols) to read 142 ); 143 144 /// Read a chunk of a readout into the weight 145 /// 146 /// Allows reading the readout incrementally 147 bool pmReadoutReadChunkWeight(pmReadout *readout, ///< Readout of interest 148 psFits *fits, ///< FITS file from which to read 149 int z, ///< Readout number/plane; zero-offset indexing 150 int numScans ///< Number of scans (rows/cols) to read 151 ); 152 153 /// Read the entire readout into the weight 154 bool pmReadoutReadWeight(pmReadout *readout, ///< Readout of interest 155 psFits *fits, ///< FITS file from which to read 156 int z ///< Readout number/plane; zero-offset indexing 157 ); 82 158 83 159 /// Read an entire cell into the weight … … 109 185 /// Same as pmCellRead, but reads only the headers of the readouts. 110 186 bool pmCellReadHeaderSet(pmCell *cell, // Cell to read into 111 112 187 psFits *fits, // FITS file from which to read 188 psDB *db // Database handle, for "concepts" ingest 113 189 ); 114 190 … … 125 201 /// Same as pmFPARead, but reads only the headers of the readouts. 126 202 bool pmFPAReadHeaderSet(pmFPA *fpa, // FPA to read into 127 128 203 psFits *fits, // FITS file from which to read 204 psDB *db // Database handle, for "concepts" ingest 129 205 ); 130 206
Note:
See TracChangeset
for help on using the changeset viewer.
