annotate src/breadcrumbs/src/Utility.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: Utility class for generic functions.
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 class Utility():
sagun98
parents:
diff changeset
36 """
sagun98
parents:
diff changeset
37 Class to perform misc methods.
sagun98
parents:
diff changeset
38 """
sagun98
parents:
diff changeset
39
sagun98
parents:
diff changeset
40 #Tested 6
sagun98
parents:
diff changeset
41 @staticmethod
sagun98
parents:
diff changeset
42 def getIndices(aList, dataElement):
sagun98
parents:
diff changeset
43 """
sagun98
parents:
diff changeset
44 Returns the index or indicies of the element in the list.
sagun98
parents:
diff changeset
45
sagun98
parents:
diff changeset
46 :param aList: List ot search for element.
sagun98
parents:
diff changeset
47 :type List.
sagun98
parents:
diff changeset
48 :param dataElement: Element for which to search.
sagun98
parents:
diff changeset
49 :type Object of the same type as is found in the list.
sagun98
parents:
diff changeset
50 :return: List of indicies indicating where the element occurs in the list. Returns [] when the element is not in the list.
sagun98
parents:
diff changeset
51 """
sagun98
parents:
diff changeset
52
sagun98
parents:
diff changeset
53 aretIndices = []
sagun98
parents:
diff changeset
54 for dataIndex in xrange(0,len(aList)):
sagun98
parents:
diff changeset
55 if(aList[dataIndex] == dataElement):
sagun98
parents:
diff changeset
56 aretIndices.append(dataIndex)
sagun98
parents:
diff changeset
57 return aretIndices
sagun98
parents:
diff changeset
58
sagun98
parents:
diff changeset
59 #Tested 6
sagun98
parents:
diff changeset
60 @staticmethod
sagun98
parents:
diff changeset
61 def reduceList(aList, dataIndicies):
sagun98
parents:
diff changeset
62 """
sagun98
parents:
diff changeset
63 Reduces a list to just the data indicies given.
sagun98
parents:
diff changeset
64
sagun98
parents:
diff changeset
65 :param aList: List to reduce.
sagun98
parents:
diff changeset
66 :type List
sagun98
parents:
diff changeset
67 :param dataIndicies: list of indicies to keep.
sagun98
parents:
diff changeset
68 :type List of integers
sagun98
parents:
diff changeset
69 :return: Reduced list. Returns [] when the and empty index list is given.
sagun98
parents:
diff changeset
70 """
sagun98
parents:
diff changeset
71 return [aList[dataIndicies[dataIndex]] for dataIndex in xrange(0,len(dataIndicies))]
sagun98
parents:
diff changeset
72
sagun98
parents:
diff changeset
73 #Tested 8
sagun98
parents:
diff changeset
74 @staticmethod
sagun98
parents:
diff changeset
75 def RGBToHex(adColor):
sagun98
parents:
diff changeset
76 """
sagun98
parents:
diff changeset
77 Change a RGB float to hex.
sagun98
parents:
diff changeset
78
sagun98
parents:
diff changeset
79 :param adColor: A list of 3 elements which are floats between 0.0 and 1.0
sagun98
parents:
diff changeset
80 :type A list of floats
sagun98
parents:
diff changeset
81 :return: A string (HEX formatted) representation of the RGB color
sagun98
parents:
diff changeset
82 """
sagun98
parents:
diff changeset
83
sagun98
parents:
diff changeset
84 charR = (hex(int(adColor[0]*255)))[2:]
sagun98
parents:
diff changeset
85 if(str(charR) == "0"):
sagun98
parents:
diff changeset
86 charR = "00"
sagun98
parents:
diff changeset
87 charG = (hex(int(adColor[1]*255)))[2:]
sagun98
parents:
diff changeset
88 if(str(charG) == "0"):
sagun98
parents:
diff changeset
89 charG = "00"
sagun98
parents:
diff changeset
90 charB = (hex(int(adColor[2]*255)))[2:]
sagun98
parents:
diff changeset
91 if(str(charB) == "0"):
sagun98
parents:
diff changeset
92 charB = "00"
sagun98
parents:
diff changeset
93 return "".join(["#",charR, charG, charB])