Changeset 9572 for trunk/psModules/src/concepts/pmConceptsPhotcode.h

Timestamp:

Oct 13, 2006, 4:35:39 PM (20 years ago)

Author:

Paul Price

Message:

Adding const where appropriate. Adding doxygen documentation to header files. Removing comments on functions defined in the header file, so that there's only a single source.

File:

• trunk/psModules/src/concepts/pmConceptsPhotcode.h (modified) (1 diff)

trunk/psModules/src/concepts/pmConceptsPhotcode.h

@@ -2 +2 @@
 #define PM_CONCEPTS_PHOTCODE_H
 
-#include "pslib.h"
+#include <pslib.h>
 #include "pmConfig.h"
 #include "pmFPAview.h"
 #include "pmFPAfile.h"
 
-char *pmConceptsPhotcodeForView (pmConfig *config, pmFPAfile *file, pmFPAview *view);
+/// Return the photcode based on the PHOTCODE.RULE in the PHASE2 recipe
+///
+/// A photometry code ("photcode") is a string that represents the combination of filter and detector (chip).
+/// This functions generates a photcode for a particular chip within the FPA, based on the PHOTCODE.RULE in
+/// the PHASE2 recipe.  Interpolation using the usual syntax (e.g., "{CHIP.NAME}") is permitted.
+psString pmConceptsPhotcodeForView(pmConfig *config, pmFPAfile *file, pmFPAview *view);
 
 # endif