Changeset 6819 for branches/rel10_ifa/psModules/src/astrom/pmFPAfile.h

Timestamp:

Apr 8, 2006, 10:13:03 AM (20 years ago)

Author:

magnier

Message:

adding pmFPAfile handling functions for arguments, etc

File:

• branches/rel10_ifa/psModules/src/astrom/pmFPAfile.h (modified) (4 diffs)

branches/rel10_ifa/psModules/src/astrom/pmFPAfile.h

@@ -7 +7 @@
 *  @author EAM, IfA
 *
-*  @version $Revision: 1.1.2.8 $ $Name: not supported by cvs2svn $
-*  @date $Date: 2006-03-29 20:55:42 $
+*  @version $Revision: 1.1.2.9 $ $Name: not supported by cvs2svn $
+*  @date $Date: 2006-04-08 20:13:03 $
 *
 *  Copyright 2004-2005 Institute for Astronomy, University of Hawaii
@@ -17 +17 @@
 
 #include "pslib.h"
+#include "pmConfig.h"
 #include "pmFPA.h"
 #include "pmFPAview.h"
@@ -72 +73 @@
 pmFPAfile;
 
+// allocate an empty pmFPAfile structure
 pmFPAfile *pmFPAfileAlloc ();
+
+// load the pmFPAfile information from the camera configuration data
 pmFPAfile *pmFPAfileDefine (psMetadata *files, psMetadata *camera, pmFPA *fpa, char *name);
+
+// load the pmFPAfile information from the camera configuration data, constructing the needed fpa structure
+// XXX deprecate this function?
+pmFPAfile *pmFPAfileConstruct (psMetadata *files, psMetadata *format, psMetadata *camera, char *name);
+
+// open the real file corresponding to the given pmFPAfile appropriate to the current view
 bool pmFPAfileOpen (pmFPAfile *file, const pmFPAview *view);
+
+// read from the real file corresponding to the given pmFPAfile for the current view
 bool pmFPAfileRead (pmFPAfile *file, const pmFPAview *view);
+
+// write to the real file corresponding to the given pmFPAfile for the current view
 bool pmFPAfileWrite (pmFPAfile *file, const pmFPAview *view);
+
+// close the real file corresponding to the given pmFPAfile appropriate to the current view
 bool pmFPAfileClose (pmFPAfile *file, const pmFPAview *view);
 
-bool pmFPAfileReadChecks (psMetadata *files, const pmFPAview *view);
+// examine all pmFPAfiles listed in the files and perform the needed I/O operations (open,read,write,close)
 bool pmFPAfileIOChecks (psMetadata *files, const pmFPAview *view, pmFPAfilePlace place);
 
+// return an image corresponding to the current readout, from the specified file.  if the pmFPAfile does not
+// exist, construct the image using the given size and type (save it in a pmFPAfile??)
 psImage *pmFPAfileReadoutImage (psMetadata *files, const pmFPAview *view, char *name, int Nx, int Ny, int type);
 
@@ -90 +108 @@
 bool pmFPAviewWriteFitsImage (const pmFPAview *view, pmFPAfile *file);
 
+// look for the given argname on the argument list.  find the give filename from the file rules
+pmFPAfile *pmFPAfileFromArgs (bool *found, pmConfig *config, char *filename, char *argname);
+
+// look for the given argname on the argument list.  find the give filename from the file rules
+pmFPAfile *pmFPAfileFromConf (bool *found, pmConfig *config, char *filename, pmFPA *input);
+
+// add the specified filename info (value) to the files of the given mode using the given reference name
+bool pmFPAfileAddFileNames (psMetadata *files, char *name, char *value, int mode);
+
 // convert the rule to a name based on the current view
 char *pmFPAfileNameFromRule (char *rule, pmFPAfile *file, const pmFPAview *view);
 
-pmFPAfile *pmFPAfileConstruct (psMetadata *files, psMetadata *format, psMetadata *camera, char *name);
-
 # endif