Changeset 2068 for trunk/imports/G2img_SumG2.py

Timestamp:

Nov 24, 2015 12:39:12 PM (10 years ago)

Author:

toby

Message:

cleanup image reader documetation

File:

• trunk/imports/G2img_SumG2.py (modified) (3 diffs)

trunk/imports/G2img_SumG2.py ¶

@@ -8 +8 @@
 ########### SVN repository information ###################
 '''
-*Module G2img_G2: Python pickled image*
----------------------------------------
-
-Routine to read an image that has been pickled in Python. Images
-in this format are created by the "Sum image data" command. 
+*Module G2img_SumG2: Python pickled image*
+------------------------------------------
 
 '''
@@ -23 +20 @@
 GSASIIpath.SetVersionNumber("$Revision: $")
 class G2_ReaderClass(G2IO.ImportImage):
+    '''Routine to read an image that has been pickled in Python. Images
+    in this format are created by the "Sum image data" command. At least for
+    now, only one image is permitted per file.
+    '''
     def __init__(self):
         super(self.__class__,self).__init__( # fancy way to self-reference
@@ -32 +33 @@
 
     def ContentsValidator(self, filepointer):
-        '''no test at this time
+        '''test by trying to unpickle (should be quick)
         '''
+        try:
+            Fp = open(filename,'rb')
+            cPickle.load(Fp)
+        except:
+            return False
         return True
         
     def Reader(self,filename,filepointer, ParentFrame=None, **unused):
-        '''Read using scipy PNG reader
+        '''Read using cPickle
         '''
         import scipy.misc