myAxes.py 5.12 KB
Newer Older
Yori 'AGy' Fournier's avatar
Yori 'AGy' Fournier committed
1
2
3
4
5
#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# ================= FILE HEADER ========================================
#
Philipp Gast's avatar
Philipp Gast committed
6
#   myplotlib v3.0.1,
Yori 'AGy' Fournier's avatar
Yori 'AGy' Fournier committed
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
#
#   @file      myAxes.py
#   @author    Yori 'AGy' Fournier
#   @licence   CC-BY-SA
#
#   MyAxes class: Overlay of matplotlib Axes class
#   It is done such that the user can concentrate on
#   the important aspect of the figure and not the
#   technical part. It consists of a constructor,
#   that requires a Figure, the ratio of the xaxis over
#   the yaxis, and the frame in which the figure
#   should be plotted.
#
#   @Class MyAxes
#
#   @Constructor(self, fig, ratio, frame, +user defined kw):
#
#   @section Functions
#
#            - plotting: this is the overwritten function
#                        from Axes. It is called by it's
#                        parent-figure's function .plot()
#
#            - formatRawData: it computes out of the rawData
#                        given as argument some quantities that
#                        are returned as a dictionary and
#                        become accessable for plotting.
#
#   @section History
#
#   v 0.0.0 - MyAxes class for the myplotlib module, consists
#             of a constructor, a pltting function and
#             formatRawData.
#
41
42
#   v 2.2.3 - Add testRawData function
#
Yori 'AGy' Fournier's avatar
Yori 'AGy' Fournier committed
43
44
45
46
# ======================================================================
#
#
# IMPORT ---------------------------------------------------------------
47
48
49
from . import SEVR, DBUG
from . import Axes
from . import rcParams
Yori 'AGy' Fournier's avatar
Yori 'AGy' Fournier committed
50
51
52
53


# Class MyAxes Overwriting Matplotlib.figure.Axes
class MyAxes(Axes):
54
    
Yori 'AGy' Fournier's avatar
Yori 'AGy' Fournier committed
55
    # CONSTRUCTOR --------------------------------------------------------
56
    def __init__(self, fig, ratio, frameRect, *args, **kwargs):
57
58
        
        self.fig = fig
59
        self.declareKeywords()
60
61
        
        rect = self.computeRect(ratio, frameRect, *args, **kwargs)
Yori 'AGy' Fournier's avatar
Yori 'AGy' Fournier committed
62
63
        kwargs.pop('forceRatioOnWidth', None)
        kwargs.pop('forceRatioOnHeight', None)
64
65
66
        
        # parent constructor
        Axes.__init__(self, fig, rect, **kwargs)
67
68
        
        # set a default name. Should be individualized by instance
69
        self.name = 'default'
70

71
72
73
74
    # COMPUTE RECT -------------------------------------------------------
    def computeRect(self, ratio, frameRect, *args, **kwargs):
        
        # Get the optional keyword
Yori 'AGy' Fournier's avatar
Yori 'AGy' Fournier committed
75
76
        forceRatioOnWidth = kwargs.pop('forceRatioOnWidth', None)
        forceRatioOnHeight = kwargs.pop('forceRatioOnHeight', None)
77
        
Yori 'AGy' Fournier's avatar
Yori 'AGy' Fournier committed
78
79
        # get the frame allowed
        framePosX, framePosY, frameWidth, frameHeight = frameRect
80
        
81
82
83
84
        # get the size of the figure
        figWidth  = self.fig.get_figwidth()
        figHeight = self.fig.get_figheight()
        
85
        if(forceRatioOnWidth):
86
            frameWidth = ratio * figWidth / (frameHeight * figHeight)
87
        elif(forceRatioOnHeight):
88
89
90
91
            frameHeight = ratio * (frameWidth * figWidth) / figHeight
        
        rect = [framePosX, framePosY, frameWidth, frameHeight]
        
92
        return(rect)
93
94
95
    
    # DECLARE KEYWORDS -------------------------------------------------
    def declareKeywords(self):
Yori 'AGy' Fournier's avatar
Yori 'AGy' Fournier committed
96
        self.keywords = {}
97
    
98
    # PLOTTING ---------------------------------------------------------
Yori 'AGy' Fournier's avatar
Yori 'AGy' Fournier committed
99
    def plotting(self):
100
101
        raise(NotImplementedError, 'You should have overwrite the plotting function.')
        return(False)
102
103
104
105
106
107
108
109
110
111
112
113

    # UNPACKING --------------------------------------------------------
    def unpackFormattedData(self, packedData):
        '''Get a string return it evaluation. can be overwritten by user.'''
        return(eval(packedData))    

    # PACKING ----------------------------------------------------------
    def packFormattedData(self, formattedData):
        '''Get an object return its representation. can be overwritten by user.'''
        return(str(formattedData))        

    # FORMATTING -------------------------------------------------------
Yori 'AGy' Fournier's avatar
Yori 'AGy' Fournier committed
114
    def formatRawData(self, rawdata):
115
116
        raise(NotImplementedError, 'You should have overwrite the formatRawData function.')        
        return(False)
117
    
118
    # TESTING THE RAWDATA ----------------------------------------------
119
    def testRawData(self, rawdata):
120
        return(True)
121
    
122
    # UPDATE -----------------------------------------------------------
123
    def update(self, *args, **kwargs):
124

125
        # Because matplotlib.axes.update expect kwargs and not **kwargs ... (stupid!!)
126
127
        if args:  # catch matplotlib kwargs
            kwargs = args[0]
128
129
130
131
132
133
134
            # kw_for_axes = {key: value for (key, value) in args[0].items() if key not in self.keywords}  # Not compatible with python2.6
            
            kw_for_axes = {}
            for (key, value) in args[0].items():
                if key not in self.keywords:
                    kw_for_axes.update({key: value})
            
135
            Axes.update(self, kw_for_axes)  # update matplotlib.Axes
136
        
137
        # myplotlib update
138
139
140
141
142
143
        # self.keywords.update({key: value for (key, value) in kwargs.items() if key in self.keywords})  # Not compatible with python2.6
        
        for (key, value) in kwargs.items():
            if key in self.keywords:
                self.keywords.update({key: value})