annotate src/breadcrumbs/src/ScatterPlot.py @ 0:0de566f21448 draft default tip

v2
author sagun98
date Thu, 03 Jun 2021 18:13:32 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
sagun98
parents:
diff changeset
1 """
sagun98
parents:
diff changeset
2 Author: Timothy Tickle
sagun98
parents:
diff changeset
3 Description: Class to create scatter plots.
sagun98
parents:
diff changeset
4 """
sagun98
parents:
diff changeset
5
sagun98
parents:
diff changeset
6 #####################################################################################
sagun98
parents:
diff changeset
7 #Copyright (C) <2012>
sagun98
parents:
diff changeset
8 #
sagun98
parents:
diff changeset
9 #Permission is hereby granted, free of charge, to any person obtaining a copy of
sagun98
parents:
diff changeset
10 #this software and associated documentation files (the "Software"), to deal in the
sagun98
parents:
diff changeset
11 #Software without restriction, including without limitation the rights to use, copy,
sagun98
parents:
diff changeset
12 #modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
sagun98
parents:
diff changeset
13 #and to permit persons to whom the Software is furnished to do so, subject to
sagun98
parents:
diff changeset
14 #the following conditions:
sagun98
parents:
diff changeset
15 #
sagun98
parents:
diff changeset
16 #The above copyright notice and this permission notice shall be included in all copies
sagun98
parents:
diff changeset
17 #or substantial portions of the Software.
sagun98
parents:
diff changeset
18 #
sagun98
parents:
diff changeset
19 #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
sagun98
parents:
diff changeset
20 #INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
sagun98
parents:
diff changeset
21 #PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
sagun98
parents:
diff changeset
22 #HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
sagun98
parents:
diff changeset
23 #OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
sagun98
parents:
diff changeset
24 #SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
sagun98
parents:
diff changeset
25 #####################################################################################
sagun98
parents:
diff changeset
26
sagun98
parents:
diff changeset
27 __author__ = "Timothy Tickle"
sagun98
parents:
diff changeset
28 __copyright__ = "Copyright 2012"
sagun98
parents:
diff changeset
29 __credits__ = ["Timothy Tickle"]
sagun98
parents:
diff changeset
30 __license__ = "MIT"
sagun98
parents:
diff changeset
31 __maintainer__ = "Timothy Tickle"
sagun98
parents:
diff changeset
32 __email__ = "ttickle@sph.harvard.edu"
sagun98
parents:
diff changeset
33 __status__ = "Development"
sagun98
parents:
diff changeset
34
sagun98
parents:
diff changeset
35 #External libraries
sagun98
parents:
diff changeset
36 from ConstantsFiguresBreadCrumbs import ConstantsFiguresBreadCrumbs
sagun98
parents:
diff changeset
37 import matplotlib.pyplot as plt
sagun98
parents:
diff changeset
38 from pylab import *
sagun98
parents:
diff changeset
39
sagun98
parents:
diff changeset
40 #Plots a matrix
sagun98
parents:
diff changeset
41 class ScatterPlot:
sagun98
parents:
diff changeset
42
sagun98
parents:
diff changeset
43 @staticmethod
sagun98
parents:
diff changeset
44 def funcPlot(lx, ly, strOutputFigurePath, strTitle = "Title", strXTitle="X Axis", strYTitle="Y Axis", strColor = "#83C8F9", fInvert=False):
sagun98
parents:
diff changeset
45 """
sagun98
parents:
diff changeset
46 Plot a scatter plot.
sagun98
parents:
diff changeset
47
sagun98
parents:
diff changeset
48 :params lx: List of x values
sagun98
parents:
diff changeset
49 :type: List of doubles
sagun98
parents:
diff changeset
50 :params ly: List of y values
sagun98
parents:
diff changeset
51 :type: List of doubles
sagun98
parents:
diff changeset
52 :params strOutputFigurePath: File path to make figure
sagun98
parents:
diff changeset
53 :type: String file path
sagun98
parents:
diff changeset
54 :params strTitle: Title of figure
sagun98
parents:
diff changeset
55 :type: String
sagun98
parents:
diff changeset
56 :params strXTitle: Label of x axis
sagun98
parents:
diff changeset
57 :type: String
sagun98
parents:
diff changeset
58 :params strYTitle: Label of y axis
sagun98
parents:
diff changeset
59 :type: String
sagun98
parents:
diff changeset
60 :params strColor: Hex color for the face of the boxplots
sagun98
parents:
diff changeset
61 :type: String
sagun98
parents:
diff changeset
62 :params fInvert: Invert colors (true)
sagun98
parents:
diff changeset
63 :type: Boolean
sagun98
parents:
diff changeset
64 """
sagun98
parents:
diff changeset
65
sagun98
parents:
diff changeset
66 #Start plot
sagun98
parents:
diff changeset
67 #Get plot object
sagun98
parents:
diff changeset
68 imgFigure = plt.figure()
sagun98
parents:
diff changeset
69
sagun98
parents:
diff changeset
70 #Get plot colorsstrOutFigure
sagun98
parents:
diff changeset
71 objFigureControl = ConstantsFiguresBreadCrumbs()
sagun98
parents:
diff changeset
72 #Boxplots have to be plotted over the scatter so the alpha can not go to 1.0
sagun98
parents:
diff changeset
73 #In this case capturing the alpha before inversion
sagun98
parents:
diff changeset
74 #Inversion automoatically sets it to 1.
sagun98
parents:
diff changeset
75 dAlpha=objFigureControl.c_dAlpha
sagun98
parents:
diff changeset
76 objFigureControl.invertColors(fInvert=fInvert)
sagun98
parents:
diff changeset
77
sagun98
parents:
diff changeset
78 #Color/Invert figure
sagun98
parents:
diff changeset
79 imgFigure.set_facecolor(objFigureControl.c_strBackgroundColorWord)
sagun98
parents:
diff changeset
80 imgSubplot = imgFigure.add_subplot(111,axisbg=objFigureControl.c_strBackgroundColorLetter)
sagun98
parents:
diff changeset
81 imgSubplot.set_xlabel(strXTitle)
sagun98
parents:
diff changeset
82 imgSubplot.set_ylabel(strYTitle)
sagun98
parents:
diff changeset
83 imgSubplot.spines['top'].set_color(objFigureControl.c_strDetailsColorLetter)
sagun98
parents:
diff changeset
84 imgSubplot.spines['bottom'].set_color(objFigureControl.c_strDetailsColorLetter)
sagun98
parents:
diff changeset
85 imgSubplot.spines['left'].set_color(objFigureControl.c_strDetailsColorLetter)
sagun98
parents:
diff changeset
86 imgSubplot.spines['right'].set_color(objFigureControl.c_strDetailsColorLetter)
sagun98
parents:
diff changeset
87 imgSubplot.xaxis.label.set_color(objFigureControl.c_strDetailsColorLetter)
sagun98
parents:
diff changeset
88
sagun98
parents:
diff changeset
89 #Adds light grid for numbers and puts them in the background
sagun98
parents:
diff changeset
90 imgSubplot.yaxis.grid(True, linestyle='-', which='major', color=objFigureControl.c_strGridLineColor, alpha=objFigureControl.c_dAlpha)
sagun98
parents:
diff changeset
91 imgSubplot.set_axisbelow(True)
sagun98
parents:
diff changeset
92 imgSubplot.yaxis.label.set_color(objFigureControl.c_strDetailsColorLetter)
sagun98
parents:
diff changeset
93 imgSubplot.tick_params(axis='x', colors=objFigureControl.c_strDetailsColorLetter)
sagun98
parents:
diff changeset
94 imgSubplot.tick_params(axis='y', colors=objFigureControl.c_strDetailsColorLetter)
sagun98
parents:
diff changeset
95 charMarkerEdgeColor = objFigureControl.c_strDetailsColorLetter
sagun98
parents:
diff changeset
96
sagun98
parents:
diff changeset
97 #Make scatter plot
sagun98
parents:
diff changeset
98 plt.scatter(x=lx,y=ly,c=strColor,marker="o",alpha=objFigureControl.c_dAlpha)
sagun98
parents:
diff changeset
99
sagun98
parents:
diff changeset
100 #Set ticks and title
sagun98
parents:
diff changeset
101 imgSubplot.set_title(strTitle)
sagun98
parents:
diff changeset
102 imgSubplot.title.set_color(objFigureControl.c_strDetailsColorLetter)
sagun98
parents:
diff changeset
103
sagun98
parents:
diff changeset
104 #End plot
sagun98
parents:
diff changeset
105 #Save to a file
sagun98
parents:
diff changeset
106 imgFigure.savefig(strOutputFigurePath, facecolor=imgFigure.get_facecolor())