IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Nov 18, 2006, 1:43:28 PM (20 years ago)
Author:
Paul Price
Message:

Extensive changes to FPA reading/writing functions to support mask and weight map reading/writing. Actually, not so much changes as generalisations to the reading/writing functions. Moved the reading/writing functionality into file-static functions, which the higher level functions for reading/writing particular elements (image, mask, weight) call. Added additional pmFPAfile types for mask and weight, with supporting functionality to call the reading/writing functions.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/psModules/src/camera/pmFPAWrite.h

    r9983 r10081  
    77/// @author Paul Price, IfA
    88///
    9 /// @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
    10 /// @date $Date: 2006-11-15 00:40:02 $
     9/// @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
     10/// @date $Date: 2006-11-18 23:43:28 $
    1111///
    1212/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
    … …  
    6969/// Write a cell mask to a FITS file
    7070///
    71 /// Generates CELL.TRIMSEC, CELL.BIASSEC and the HDU pixels if required.  Writes the concepts to the various
    72 /// locations, and then the HDU mask to the FITS file.
     71/// Generates CELL.TRIMSEC, CELL.BIASSEC and the HDU mask pixels if required.  A blank (i.e., image-less
     72/// header) is written only if specifically requested.  Writes the concepts to the various locations, and then
     73/// the HDU mask to the FITS file.  This function should be called at the beginning of the output cell loop
     74/// with blank=true in order to produce the correct file structure.
    7375bool pmCellWriteMask(pmCell *cell,      ///<  Cell to write
    7476                     psFits *fits,      ///<  FITS file to which to write
    75                      psDB *db           ///<  Database handle for "concepts" update
     77                     psDB *db,          ///<  Database handle for "concepts" update
     78                     bool blank         ///<  Write a blank PHU?
    7679                    );
    7780
    7881/// Write a chip mask to a FITS file
    7982///
    80 /// Generates CELL.TRIMSEC, CELL.BIASSEC and the HDU pixels if required.  Writes the concepts to the various
    81 /// locations, and then the HDU mask to the FITS file.
     83/// Generates CELL.TRIMSEC, CELL.BIASSEC and the HDU mask pixels if required.  A blank (i.e., image-less
     84/// header) is written only if specifically requested.  Writes the concepts to the various locations, and then
     85/// the HDU mask to the FITS file, optionally recursing to lower levels.  This function should be called at
     86/// the beginning of the output chip loop with blank=true and recurse=false in order to produce the correct
     87/// file structure.
    8288bool pmChipWriteMask(pmChip *chip,      ///<  Chip to write
    8389                     psFits *fits,      ///<  FITS file to which to write
    84                      psDB *db           ///<  Database handle for "concepts" update
     90                     psDB *db,          ///<  Database handle for "concepts" update
     91                     bool blank,        ///<  Write a blank PHU?
     92                     bool recurse       ///<  Recurse to lower levels?
    8593                    );
    8694
    8795/// Write an FPA mask to a FITS file
    8896///
    89 /// Generates CELL.TRIMSEC, CELL.BIASSEC and the HDU pixels if required.  Writes the concepts to the various
    90 /// locations, and then the HDU mask to the FITS file.
     97/// Generates CELL.TRIMSEC, CELL.BIASSEC and the HDU mask pixels if required.  A blank (i.e., image-less
     98/// header) is written only if specifically requested.  Writes the concepts to the various locations, and then
     99/// the HDU mask to the FITS file, optionally recursing to lower levels.  This function should be called at
     100/// the beginning of the output FPA loop with blank=true and recurse=false in order to produce the correct
     101/// file structure.
    91102bool pmFPAWriteMask(pmFPA *fpa,         ///<  FPA to write
    92103                    psFits *fits,       ///<  FITS file to which to write
    93                     psDB *db            ///<  Database handle for "concepts" update
     104                    psDB *db,           ///<  Database handle for "concepts" update
     105                    bool blank,         ///<  Write a blank PHU?
     106                    bool recurse        ///<  Recurse to lower levels?
    94107                   );
     108
     109/// Write a cell weight to a FITS file
     110///
     111/// Generates CELL.TRIMSEC, CELL.BIASSEC and the HDU weight pixels if required.  A blank (i.e., image-less
     112/// header) is written only if specifically requested.  Writes the concepts to the various locations, and then
     113/// the HDU weight to the FITS file.  This function should be called at the beginning of the output cell loop
     114/// with blank=true in order to produce the correct file structure.
     115bool pmCellWriteWeight(pmCell *cell,    ///<  Cell to write
     116                       psFits *fits,    ///<  FITS file to which to write
     117                       psDB *db,        ///<  Database handle for "concepts" update
     118                       bool blank       ///<  Write a blank PHU?
     119                      );
     120
     121/// Write a chip weight to a FITS file
     122///
     123/// Generates CELL.TRIMSEC, CELL.BIASSEC and the HDU weight pixels if required.  A blank (i.e., image-less
     124/// header) is written only if specifically requested.  Writes the concepts to the various locations, and then
     125/// the HDU weight to the FITS file, optionally recursing to lower levels.  This function should be called at
     126/// the beginning of the output chip loop with blank=true and recurse=false in order to produce the correct
     127/// file structure.
     128bool pmChipWriteWeight(pmChip *chip,    ///<  Chip to write
     129                       psFits *fits,    ///<  FITS file to which to write
     130                       psDB *db,        ///<  Database handle for "concepts" update
     131                       bool blank,      ///<  Write a blank PHU?
     132                       bool recurse     ///<  Recurse to lower levels?
     133                      );
     134
     135/// Write an FPA weight to a FITS file
     136///
     137/// Generates CELL.TRIMSEC, CELL.BIASSEC and the HDU weight pixels if required.  A blank (i.e., image-less
     138/// header) is written only if specifically requested.  Writes the concepts to the various locations, and then
     139/// the HDU weight to the FITS file, optionally recursing to lower levels.  This function should be called at
     140/// the beginning of the output FPA loop with blank=true and recurse=false in order to produce the correct
     141/// file structure.
     142bool pmFPAWriteWeight(pmFPA *fpa,       ///<  FPA to write
     143                      psFits *fits,     ///<  FITS file to which to write
     144                      psDB *db,         ///<  Database handle for "concepts" update
     145                      bool blank,       ///<  Write a blank PHU?
     146                      bool recurse      ///<  Recurse to lower levels?
     147                     );
     148
    95149
    96150/// Write a FITS table from the cell's analysis metadata.
Note: See TracChangeset for help on using the changeset viewer.