Changeset 13407 for fact/tools/pyscripts/pyfact/factfits.py

Timestamp:

04/21/12 09:32:59 (13 years ago)

Author:

neise

Message:

added some comments

File:

• fact/tools/pyscripts/pyfact/factfits.py (modified) (3 diffs)

fact/tools/pyscripts/pyfact/factfits.py

@@ -45 +45 @@
 
     def _make_meta_dict(self):
+        """ This method retrieves meta information about the fits file and 
+            stores this information in a dict
+            return: dict
+                key: string - all capital letters
+                value: tuple( numerical value, string comment)
+        """
         # intermediate variables for file metadata dict generation
         keys=self.GetPy_KeyKeys()
@@ -81 +87 @@
 
     def _make_columns_dict(self):
+        """ This method retrieves information about the columns
+            stored inside the fits files internal binary table.
+            returns: dict
+                key:    string column name -- all capital letters
+                values: tuple(
+                    number of elements in table field - integer
+                    size of element in bytes -- this is not really interesting for any user
+                            might be ommited in future versions
+                    type - a single character code -- should be translated into 
+                            a comrehensible word
+                    unit - string like 'mV' or 'ADC count'
+        """
         # intermediate variables for file table-metadata dict generation
         keys=self.GetPy_ColumnKeys()
@@ -291 +309 @@
                     self.stacked_cols[col] = np.vstack( (self.stacked_cols[col],self.dict[col]) ) 
                 else:
-#                elif isinstance(self.dict[col], ctypes._SimpleCData):
                     self.stacked_cols[col] = np.vstack( (self.stacked_cols[col],np.array(self.dict[col])) )
-                #else:
-                    #raise TypeError("I don't know how to stack "+col+". It is of type: "+str(type(self.dict[col])))
- 
-                    
-                    
-                    
             self._current_row += 1
         else: