pmConceptsRead.h

Go to the documentation of this file.
00001 /* @file  pmConceptsRead.h
00002  * @brief Reading concepts from a variety of sources.
00003  *
00004  * @author Paul Price, IfA
00005  *
00006  * @version $Revision: 1.5 $ $Name:  $
00007  * @date $Date: 2007/01/24 02:54:14 $
00008  * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
00009  */
00010 
00011 #ifndef PM_CONCEPTS_READ_H
00012 #define PM_CONCEPTS_READ_H
00013 
00014 #include <pslib.h>
00015 #include "pmFPA.h"
00016 
00017 /// Read concepts from the camera format file's CELLS.
00018 ///
00019 /// Examines the CELLS metadata in the camera format file
00020 /// for the current type of cell, and sucks in the concepts defined there.
00021 /// This is a useful way of defining concepts that vary depending on the
00022 /// type of the cell.
00023 bool p_pmConceptsReadFromCells(psMetadata *target, ///< Place into which to read the concepts
00024                                const psMetadata *specs, ///< The concept specifications
00025                                const pmCell *cell ///< The cell
00026                               );
00027 
00028 /// Read concepts from the DEFAULTS in the camera format file.
00029 ///
00030 /// Examines the DEFAULTS metadata in the camera format file
00031 /// for concepts in the specs, and imports them into the target.
00032 bool p_pmConceptsReadFromDefaults(psMetadata *target, // Place into which to read the concepts
00033                                   const psMetadata *specs, // The concept specifications
00034                                   const pmFPA *fpa, // The FPA
00035                                   const pmChip *chip, // The chip
00036                                   const pmCell *cell // The cell
00037                                  );
00038 
00039 /// Read concepts from the header TRANSLATION in the camera format file.
00040 ///
00041 /// Examines the TRANSLATION metadata in the camera format file
00042 /// for concepts in the specs, and imports them into the target.
00043 bool p_pmConceptsReadFromHeader(psMetadata *target, // Place into which to read the concepts
00044                                 const psMetadata *specs, // The concept specifications
00045                                 const pmFPA *fpa, // The FPA
00046                                 const pmChip *chip, // The chip
00047                                 const pmCell *cell  // The cell
00048                                );
00049 
00050 /// Read concepts from the header DATABASE in the camera format file.
00051 ///
00052 /// Examines the DATABASE metadata in the camera format file
00053 /// for concepts in the specs, and imports them into the target.
00054 /// WARNING: This function has not been tested; use at your own risk!
00055 bool p_pmConceptsReadFromDatabase(psMetadata *target, // Place into which to read the concepts
00056                                   const psMetadata *specs, // The concept specifications
00057                                   const pmFPA *fpa, // The FPA
00058                                   const pmChip *chip, // The chip
00059                                   const pmCell *cell,  // The cell
00060                                   psDB *db // The database handle
00061                                  );
00062 /// @}
00063 #endif

Generated on Fri Feb 2 22:35:28 2007 for Pan-STARRS Module Library by  doxygen 1.5.1