# -*- coding: utf-8 -*-
########### SVN repository information ###################
# $Date: 2016-01-22 19:05:12 +0000 (Fri, 22 Jan 2016) $
# $Author: toby $
# $Revision: 2133 $
# $URL: trunk/imports/G2img_SumG2.py $
# $Id: G2img_SumG2.py 2133 2016-01-22 19:05:12Z toby $
########### SVN repository information ###################
'''
*Module G2img_SumG2: Python pickled image*
------------------------------------------

'''

import sys
import os
import cPickle
import GSASIIIO as G2IO
import GSASIIpath
GSASIIpath.SetVersionNumber("$Revision: 2133 $")
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
            extensionlist=('.G2img',),
            strictExtension=True,
            formatName = 'Summed GSAS-II image',
            longFormatName = 'Pickled image from GSAS-II "Sum image data" command'
            )

    def ContentsValidator(self, filepointer):
        '''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 cPickle
        '''
        import scipy.misc
        Fp = open(filename,'rb')
        self.Comments,self.Data,self.Npix,self.Image = cPickle.load(Fp)
        Fp.close()
        self.LoadImage(ParentFrame,filename)
        return True