fix HDF5 image reread bug in scripting; add reminders to GUI import routines so I am less likely to make that error again.

Author: briantoby

GSASII/GSASIIdataGUI.py

@@ -994,7 +994,11 @@ def PreviewFile(self,filename):
 
     def OnImportGeneric(self,reader,readerlist,label,multiple=False,
         usedRanIdList=[],Preview=True,load2Tree=False,filename=None):
-        '''Used for all imports, including Phases, datasets, images...
+        '''Used for all imports from GUI, including Phases, datasets, images...
+
+        N.B. The code here is largely duplicated in 
+        :func:`GSASIIscriptable:import_generic` so any changes made here
+        need to be duplicated there, too. 
 
         Called from :meth:`GSASII.OnImportPhase`, :meth:`GSASII.OnImportImage`,
         :meth:`GSASII.OnImportSfact`, :meth:`GSASII.OnImportPowder`,
@@ -1273,6 +1277,10 @@ def OnImportPhase(self,event):
         reader item associated with the menu item, which will be
         None for the last menu item, which is the "guess" option
         where all appropriate formats will be tried.
+
+        N.B. The code here is largely duplicated in 
+        :mod:`GSASIIscriptable` so any changes made here
+        need to be duplicated there, too. 
         '''
         # look up which format was requested
         reqrdr = self.ImportMenuId.get(event.GetId())
@@ -1513,6 +1521,10 @@ def OnImportImage(self,event):
         where all appropriate formats will be tried.
 
         A reader object is filled each time an image is read.
+
+        N.B. The code here is largely duplicated in 
+        :mod:`GSASIIscriptable` so any changes made here
+        need to be duplicated there, too. 
         '''
         self.CheckNotebook()
         # look up which format was requested
@@ -1541,6 +1553,10 @@ def OnImportSfact(self,event):
         reader item associated with the menu item, which will be
         None for the last menu item, which is the "guess" option
         where all appropriate formats will be tried.
+
+        N.B. The code here is largely duplicated in 
+        :mod:`GSASIIscriptable` so any changes made here
+        need to be duplicated there, too. 
         '''
         # get a list of existing histograms
         HKLFlist = []
@@ -1991,6 +2007,10 @@ def OnImportPowder(self,event):
         where all appropriate formats will be tried.
 
         Also reads an instrument parameter file for each dataset.
+
+        N.B. The code here is largely duplicated in 
+        :mod:`GSASIIscriptable` so any changes made here
+        need to be duplicated there, too. 
         '''
         FP,tth = 25.0,150.
         # get a list of existing histograms
@@ -2625,6 +2645,8 @@ def OnImportSmallAngle(self,event):
         None for the last menu item, which is the "guess" option
         where all appropriate formats will be tried.
         Small angle data is presumed to be as QIE form for either x-rays or neutrons
+
+        N.B. This code is not yet duplicated in :mod:`GSASIIscriptable`. 
         '''
 
         def GetSASDIparm(reader):
@@ -2718,6 +2740,8 @@ def OnImportReflectometry(self,event):
         None for the last menu item, which is the "guess" option
         where all appropriate formats will be tried.
         Reflectometry data is presumed to be in QIE form for x-rays of neutrons
+
+        N.B. This code is not yet duplicated in :mod:`GSASIIscriptable`. 
         '''
 
         def GetREFDIparm(reader):
@@ -2817,6 +2841,10 @@ def OnImportPDF(self,event):
         reader item associated with the menu item, which will be
         None for the last menu item, which is the "guess" option
         where all appropriate formats will be tried.
+
+        N.B. The code here is largely duplicated in 
+        :mod:`GSASIIscriptable` so any changes made here
+        need to be duplicated there, too. 
         '''
         # get a list of existing histograms
         PDFlist = []

GSASII/GSASIIscriptable.py

@@ -433,7 +433,8 @@ def downloadFile(URL,download_loc=None):
     return filename
 
 def import_generic(filename, readerlist, fmthint=None, bank=None,
-                       URL=False, download_loc=None, useNet=True):
+                       URL=False, download_loc=None, useNet=True,
+                       buffer=None):
     """Attempt to import a filename, using a list of reader objects.
 
     Returns the first reader object which worked."""
@@ -496,7 +497,10 @@ def import_generic(filename, readerlist, fmthint=None, bank=None,
             #                    .format(filename,len(rd.selections)))
 
             block = 0
-            rdbuffer = {}
+            if buffer is None:
+                rdbuffer = {}
+            else:
+                rdbuffer = buffer
             repeat = True
             while repeat:
                 repeat = False
@@ -2694,8 +2698,10 @@ def add_image(self, imagefile, fmthint=None, defaultImage=None,
         """
         LoadG2fil()
         if not URL: imagefile = os.path.abspath(os.path.expanduser(imagefile))
+        rdbuffer = {}
         readers = import_generic(imagefile, Readers['Image'],
-                    fmthint=fmthint, URL=URL, download_loc=download_loc)
+                    fmthint=fmthint, URL=URL, download_loc=download_loc,
+                                     buffer=rdbuffer)
         objlist = []
         for i,rd in enumerate(readers):
             if indexList is not None and i not in indexList:
@@ -2706,10 +2712,19 @@ def add_image(self, imagefile, fmthint=None, defaultImage=None,
                 #see this: G2IO.EditImageParms(self,rd.Data,rd.Comments,rd.Image,imagefile)
                 rd.SciPy = False
             rd.readfilename = imagefile
+            TreeLbl = 'IMG '+os.path.basename(imagefile)
             if rd.repeatcount == 1 and not rd.repeat: # skip image number if only one in set
-                rd.Data['ImageTag'] = None
+                imageInfo = imagefile
+            elif 'imagemap' in rdbuffer:
+                # if there is an image map, save the entry there rather than
+                # a simple number (HDF5 only at present)
+                rd.Data['ImageTag'] = rdbuffer['imagemap'][rd.imageEntry]
+                TreeLbl += f' #{i:04}'
+                imageInfo = (imagefile,rd.Data.get('ImageTag'))
             else:
                 rd.Data['ImageTag'] = rd.repeatcount
+                imageInfo = (imagefile,rd.Data.get('ImageTag'))
+                TreeLbl += f' #{rd.Data.get("ImageTag",-1):04}'
             rd.Data['formatName'] = rd.formatName
             if rd.sumfile:
                 rd.readfilename = rd.sumfile
@@ -2718,13 +2733,6 @@ def add_image(self, imagefile, fmthint=None, defaultImage=None,
             # Code from G2IO.LoadImage2Tree(rd.readfilename,self,rd.Comments,rd.Data,rd.Npix,rd.Image)
             Imax = np.amax(rd.Image)
             ImgNames = [i[0] for i in self.names if i[0].startswith('IMG ')]
-            TreeLbl = 'IMG '+os.path.basename(imagefile)
-            ImageTag = rd.Data.get('ImageTag')
-            if ImageTag:
-                TreeLbl += ' #'+'%04d'%(ImageTag)
-                imageInfo = (imagefile,ImageTag)
-            else:
-                imageInfo = imagefile
             TreeName = G2obj.MakeUniqueLabel(TreeLbl,ImgNames)
             # MT dict to contain image info
             ImgDict = {}