source: trunk/imports/G2phase_GPX.py @ 3146

# -*- coding: utf-8 -*-
########### SVN repository information ###################
# $Date: 2017-10-23 16:39:16 +0000 (Mon, 23 Oct 2017) $
# $Author: vondreele $
# $Revision: 3136 $
# $URL: trunk/imports/G2phase_GPX.py $
# $Id: G2phase_GPX.py 3136 2017-10-23 16:39:16Z vondreele $
########### SVN repository information ###################
'''
*Module G2phase_GPX: Import phase from GSAS-II project*
--------------------------------------------------------

Copies a phase from another GSAS-II project file into the
current project.

'''
from __future__ import division, print_function
import platform
import sys
if '2' in platform.python_version_tuple()[0]:
    import cPickle
else:
    import _pickle as cPickle
import random as ran
import GSASIIobj as G2obj
import GSASIIIO as G2IO
import GSASIIstrIO as G2stIO
import GSASIIpath
GSASIIpath.SetVersionNumber("$Revision: 3136 $")

class PhaseReaderClass(G2obj.ImportPhase):
    'Opens a .GPX file and pulls out a selected phase'
    def __init__(self):
        super(self.__class__,self).__init__( # fancy way to say ImportPhase.__init__
            extensionlist=('.gpx',),
            strictExtension=True,
            formatName = 'GSAS-II gpx',
            longFormatName = 'GSAS-II project (.gpx file) import'
            )
        
    def ContentsValidator(self, filename):
        "Test if the 1st section can be read as a cPickle block, if not it can't be .GPX!"
        if True:
            fp = open(filename,'rb')
        try: 
            if '2' in platform.python_version_tuple()[0]:
                data = cPickle.load(fp)
            else:
                data = cPickle.load(fp,encoding='latin-1')
        except:
            self.errors = 'This is not a valid .GPX file. Not recognized by cPickle'
            fp.close()
            return False
        fp.close()
        return True

    def Reader(self,filename, ParentFrame=None, **unused):
        '''Read a phase from a .GPX file. Does not (yet?) support selecting and reading
        more than one phase at a time.'''
        try:
            phasenames = G2stIO.GetPhaseNames(filename)
        except:
            self.errors = 'Reading of phase names failed'
            return False
        if not phasenames:
            self.errors = 'No phases found in '+str(filename)
            return False            # no blocks with coordinates
        elif len(phasenames) == 1: # one block, no choices
            selblk = 0
        else:                       # choose from options                
            selblk = G2IO.PhaseSelector(phasenames,ParentFrame=ParentFrame,
                title= 'Select a phase from the list below',)
            if selblk is None:
                self.errors = 'No phase selected'
                return False # User pressed cancel
        self.Phase = G2stIO.GetAllPhaseData(filename,phasenames[selblk])
        self.Phase['Histograms'] = {}       #remove any histograms
        self.Phase['Pawley ref'] = []       # & any Pawley refl.
        self.Phase['RBModels'] = {}
        del self.Phase['MCSA']
        if 'Map Peaks' in self.Phase:
            del self.Phase['Map Peaks']
        del self.Phase['General']['Map']
        self.Phase['ranId'] = ran.randint(0,sys.maxsize)
        return True