myFig_client.py 11.8 KB
Newer Older
Yori 'AGy' Fournier's avatar
Yori 'AGy' Fournier committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# ================= FILE HEADER ========================================
#
#   myplotlib v3.0.1,
#
#   @file      myFig.py
#   @author    Yori 'AGy' Fournier
#   @licence   CC-BY-SA
#
#   MyFig class: Overlay of matplotlib Figure class
#   It is done such that the user can concentrate on
#   the important aspect of the figure and not the
#   technical part.
#
#   @Class MyFig
#
#   @Constructor
#
#                fignum:      number of the Figure.
#                reformat:    flag for reComputing plotted data
#                             from rawData.
#                debug:       flag for debugging, more verbatile.
#                (kw)args:    user defined arguments and keywords.
#
#   @section Functions
#
#            - printDebug:    print some debug information.
#
#            - plot:          overlay of Figure.plot() function,
#                             should be overwrited by the user.
#                             Consists of
#                             - creating axes,
#                             - formating the data,
#                             - adding the axis to the figure
#                             - plotting the axis
#
#            - update:        update the parameters in the
#                             keywords dictionary.
#
#   @section History
#
#   v 0.1.1 - MyFig class for the myplotlib module.
#
#   v 1.0.0 - Changed rawdata with inputarg to allows any type
#             of rawdata, can be an array.
#
#             replace the attribute format (reserved word) with
#             formatted.
#
#   v 1.0.1 - Suppress the explicit definitions of the keywords.
#             by the introduction of the keywords dictionary.
#             All parameters in this dictionary are automatically
#             updated.
#
#             suppress the default value of fignum and hardcode it
#             to be -1.
#
#             add the attribute boundedToWin required for the
#             interactive mode of myplotlib.
#
#   v 2.2.3 - Allow the possibility of giving a unique rawdata format
#             all axes. /!\ self.rawdata is a generator. /!\
#
# ======================================================================
#
#
# IMPORT ---------------------------------------------------------------
from . import os
from . import D_FIGSIZE, D_INPUTARG, D_DEBUG, D_REFORMAT, D_FORMATTED
from . import D_OFORMAT, D_OPATH
from . import DBUG, SEVR, INFO, SPCE, WARN
from . import MyData
from . import MyAxes
from . import Figure


# Class MyFig Overwriting Matplotlib.figure.Figure
class MyFig_client(Figure):
  
    # Set the size of the Figure in inch
    # (private variable can not be updated)
    FIGSIZE = D_FIGSIZE
  
    # CONSTRUCTOR --------------------------------------------------------
    def __init__(self, rawdata, *args, **kwargs):
        
        # for the update function
        self._attributesToUpdateKeys = ['fignum', 'reformat', 'debug', 'formatted', 'aliases']
        
        # initialise the attribute default values and remove them from kwargs
        self.fignum       = kwargs.pop('fignum', -1)  # need to be hard coded for interactive mode
        self.reformat     = kwargs.pop('reformat', D_REFORMAT)
        self.debug        = kwargs.pop('debug', D_DEBUG)
        self.formatted    = kwargs.pop('formatted', D_FORMATTED)
        self.aliases      = {}
98
99
        self.syncID       = -1
        self.client       = None
Yori 'AGy' Fournier's avatar
Yori 'AGy' Fournier committed
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
        self.FIGSIZE      = kwargs.pop('figsize', self.FIGSIZE)
        
        # parent constructor
        Figure.__init__(self, figsize=self.FIGSIZE)
        
        # This is required for the interactive mode
        # it ensures that a figure can not be bounded
        # to several windows and prevent the loss of canvas.
        self.boundedToWin = False
        
        # initialise
        self._initialize(*args, **kwargs)
    
    # INITIALIZE -------------------------------------------------------
    def _initialize(self, *args, **kwargs):
        
        # add the axes
        self.addAxes()
        
        # declare the aliases
        self.declareAliases()
        
        # update the attributes and keywords
        self.update(**kwargs)
    
    # UPDATE ----------------------------------------------------------
    def update(self, **kwargs):
        
        # check attributes in keywords
        for keyword in kwargs.keys():
            
            # if it is an attribute
            if keyword in self._attributesToUpdateKeys:
                # update value
                setattr(self, keyword, kwargs[keyword])
            
        # For each axes update the keywords
        for ax in self.get_axes():
                
            forax = {}
            
            for keyword in kwargs.keys():
                
                # ignore figure attributes
                if keyword in self._attributesToUpdateKeys :
                    pass
                
                # Check if a key of kwargs has an alias for this axes
                elif keyword in self.aliases.keys():
                    alax, alkey = self.aliases[keyword]
            
                    # If an alias is found then update axkwargs
                    if ax == alax:
                        forax.update(**{alkey: kwargs[keyword]})
                
                # use keyword as it is for the axes
                else :
                    forax.update(**{keyword : kwargs[keyword]})
                
            # Then eventually all collected Keywords are updated in one go
            if (forax) :
                if self.debug:
                    print (DBUG+' fig.update ', ax, 'keywords: ', forax)
                ax.update(**forax)
        
        return(True)
    
    # DECLARE ALIASES -------------------------------------------------
    def declareAliases(self):
        pass
    
    # ADD AXES ---------------------------------------------------------
    def addAxes(self, *arg, **kwargs):
        pass
    
    # This overwrites MPL add_axes. It gives a name to the axis added so that it is easier to refer to
    def add_axes(self, ax, name) :
        
#        if isinstance(name, str) and issubclass(ax.__class__, MyAxes): # This lead to an error is ax is not in the same namespace
        ax.name = name
#        else:
#            print(SEVR + " there is an error with the input type of add_axes()")
#            return False
        
        # test if an axes with that name is already present
        for pax in self.get_axes() :
            if pax.name == name :
                print(SEVR + " an axes with that name is already present")
                return False
        
        Figure.add_axes(self, ax)
        
        return True
    
    # GET AXES BY NAME -------------------------------------------------
    def getAxesByName(self, name):
        
        for ax in self.get_axes() :
            if ax.name == name :
                return ax
        
        #if the name is correct we should never get here.
        print(SEVR + "The axes name ", name, " was not found")
        return None
                
    
    # FORMAT RAW DATA --------------------------------------------------
    def formatRawData(self):
        # HEre comes a function that send a signal to the server
        # and tells him to execute the format rawdata of the
        # synchronized figure (server-side)
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
        if (self.client is not None) and (self.syncID != -1):

            try:
                datas = self.client.syncFigFormatRawData(self.syncID)
            except:
                print(SEVR+'The server-side figure could not format the data...')
                return(False)
            
            for ax, data in zip(self.get_axes(), datas):
                ax.data = data
                
        else:
            print(SEVR+'The figure is not properly synchronized.')
            return(False)

        return(True)
            
Yori 'AGy' Fournier's avatar
Yori 'AGy' Fournier committed
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
    # PLOT -------------------------------------------------------------
    def plot(self):
        
        status = True
        
        if(self.debug):
            print(DBUG + "currently formatting the data...")
        
        if((self.reformat) or (not self.formatted)):
            status = self.formatRawData()
            if(not status): return(False)
        
        if(self.debug):
            print(DBUG + "currently plotting the axes...")
        
        # For all axes in the figure reformat if needed and plot
        for ax in self.get_axes():
            
            # clean the axes
            ax.cla()
            
            # plot
            plottingStatus = ax.plotting()
            status = status and plottingStatus
        
        return(status)
    
    # RESET ------------------------------------------------------------
    def reset(self, *args, **kwargs):
        self.clf()
        self._initialize(*args, **kwargs)
        self.plot()
    
    # DEBUG --------------------------------------------------------------
    def printDebug(self):
        className = str(self.__class__.__name__)
        print('\n' + DBUG + "  {0} PARAMETERS: ".format(className))
        print(SPCE + "     ID the figure: " + str(self.fignum))
        print(SPCE + "Size of the figure: " + str(self.FIGSIZE) + ' [inch] \n')
    
    # PRINT 2 FILE -------------------------------------------------------
    def print2file(self, filename, *args, **kwargs):
        
        # get the keywords
        debug = kwargs.get('debug', D_DEBUG)
        oformat = kwargs.get('oformat', D_OFORMAT)
        opath = kwargs.get('opath', D_OPATH)
        as_seen = kwargs.get('as_seen', False)
        
        # set the dpi
        if(oformat == 'png'):
            dpi = 300.
            addMetaData = True  # NOT YET IMPLEENTED
        else:
            dpi = 100.
            addMetaData = False  # NOT YET IMPLEMENTED
        
        from matplotlib.backends.backend_agg import FigureCanvasAgg as FigureCanvas
        # if the figure is boundedToWin
        # save to canvas in a local variable and restore after saving to file.
        if self.boundedToWin:
            winCanvas = self.canvas
        else:
            winCanvas = None
            
        canvas = FigureCanvas(self)  # the canvas of the figure changed
        
        # Plot the figure
        if not as_seen:
            status = self.plot()
            if not status:
                print(SEVR + 'Can not plot the figure. sorry --> EXIT')
                return(False)
        
        # draw the figure on the new canvas
        canvas.draw()  # not really needed (savefig does that)
        
        # check if the extention is in the name
        if '.png' in str(filename):
            oformat = 'png'
            filename = filename[:-4]
        elif '.eps' in str(filename):
            oformat = 'eps'
            filename = filename[:-4]
        
        # check if the path is in the name
        if '/' in str(filename):
            if(debug):
                print(WARN + "I detect that the path is in the name of the file, will ignore D_OPATH.")
            arg = filename
            filename = os.path.basename(arg)
            opath = os.path.dirname(arg)
        
        # take care of the . in the extention
        if oformat[0] == '.':
            oformat = oformat[1:]
        
        # clean the output path
        if str(opath)[-1] == '/':
            opath = str(opath)[:-1]
        else:
            opath = str(opath)
        
        # print into a file
        try:
            self.savefig(str(opath) + '/' + str(filename) + '.' + str(oformat), dpi=dpi)  # ! this not the save from plt but from fig
        except IOError:
            print(SEVR + 'the path to the file does not exists:')
            print(SPCE + str(opath) + '/' + str(filename) + '.' + str(oformat) + ' --> EXIT')
            return(False)
        except:
            print(SEVR + 'Can not save file. sorry --> EXIT')
            return(False)
        
        # restore the former canvas
        if winCanvas is not None:
            self.canvas = winCanvas
        
        return(True)