changed "includeUnSelected" to "includeUnselected"

README.md

@@ -66,7 +66,7 @@ clusters, one cannot load monte carlo information and the u/v mapping is still
 very wonky.
 
 ```python
-loadFromRoot.open('/root-files/slow_pions_2.root', includeUnSelected=True)
+loadFromRoot.open('/root-files/slow_pions_2.root', includeUnselected=True)
 ```
 
 So far mixing opening multiply files, with and without ROI unselected clusters

rootable/detectors/clustersFromDigits.py

@@ -110,8 +110,8 @@ class ClustersFromDigits:
                                  'vCellID': 'PXDDigitsOUT/PXDDigitsOUT.m_vCellID',
                               'cellCharge': 'PXDDigitsOUT/PXDDigitsOUT.m_charge'}
 
-    def branches(self, *, includeUnSelected: bool = False) -> list:
-        if includeUnSelected is True:
+    def branches(self, *, includeUnselected: bool = False) -> list:
+        if includeUnselected is True:
             return list((self.digitsInKeys | self.digitsOutKeys).values())
         return list(self.digitsInKeys.values())
 

rootable/detectors/mcToClusters.py

@@ -32,7 +32,7 @@ class MCtoClusters:
         self.mcClusterRelations = {'from': 'PXDClustersToMCParticles/m_elements/m_elements.m_from',
                                      'to': 'PXDClustersToMCParticles/m_elements/m_elements.m_to'}
 
-    def branches(self, *, includeUnSelected: bool = False) -> list:
+    def branches(self, *, includeUnselected: bool = False) -> list:
         return list((self.mcKeys | self.mcClusterRelations).values())
 
     def get(self, eventTree: TTree) -> dict:
@@ -157,8 +157,8 @@ class MCtoDigits:
                                  'vCellID': 'PXDDigitsOUT/PXDDigitsOUT.m_vCellID',
                               'cellCharge': 'PXDDigitsOUT/PXDDigitsOUT.m_charge'}
 
-    def branches(self, *, includeUnSelected: bool = False) -> list:
-        if includeUnSelected is True:
+    def branches(self, *, includeUnselected: bool = False) -> list:
+        if includeUnselected is True:
             return list((self.mcKeys | self.mcDigitsInRelations | self.mcDigitsOutRelations).values())
         return list((self.mcKeys | self.mcDigitsInRelations).values())
 

rootable/detectors/pxd.py

@@ -77,14 +77,14 @@ class PXD(FancyDict):
         self.data = data if data is not None else {}
         self.length = 0
 
-    def branches(self, *, includeUnSelected: bool = False) -> dict:
+    def branches(self, *, includeUnselected: bool = False) -> dict:
         branches = {  'clusters': list(self.clusterKeys.values()),
-                        'digits': self.clustersFromDigits.branches(includeUnSelected=includeUnSelected),
-                    'monteCarlo': self.mcToClusters.branches(includeUnSelected=includeUnSelected)}
-        branches['monteCarlo'].extend(self.mcToDigits.branches(includeUnSelected=includeUnSelected))
+                        'digits': self.clustersFromDigits.branches(includeUnselected=includeUnselected),
+                    'monteCarlo': self.mcToClusters.branches(includeUnselected=includeUnselected)}
+        branches['monteCarlo'].extend(self.mcToDigits.branches(includeUnselected=includeUnselected))
         return branches
 
-    def getClusters(self, eventTree: TTree, fileName: str = None, includeUnSelected: bool = False) -> None:
+    def getClusters(self, eventTree: TTree, fileName: str = None, includeUnselected: bool = False) -> None:
         """
         this uses the array from __init__ to load different branches into the data dict
         """
@@ -111,7 +111,7 @@ class PXD(FancyDict):
         self.set('fileName', np.array([fileName] * length))
 
         missing_branches = set(self.clustersFromDigits.digitsOutKeys.values()) - eventKeys
-        if includeUnSelected and not missing_branches:
+        if includeUnselected and not missing_branches:
             clusters = self.clustersFromDigits.get(eventTree, 'outROI')
             clusters_ = {key: clusters[key] for key in self.clusterKeys.keys()}
             length = len(clusters['clsCharge'])
@@ -145,7 +145,7 @@ class PXD(FancyDict):
         except:
             return KeyError
 
-    def getDigits(self, eventTree: TTree, includeUnSelected: bool = False) -> None:
+    def getDigits(self, eventTree: TTree, includeUnselected: bool = False) -> None:
         """
         reorganizes digits, so that they fit to the clusters
         """
@@ -188,7 +188,7 @@ class PXD(FancyDict):
             self.set('cellCharges', np.array(cellChargesTemp, dtype=object))
 
         missing_branches = set(self.clustersFromDigits.digitsOutKeys.values()) - eventKeys
-        if includeUnSelected and not missing_branches:
+        if includeUnselected and not missing_branches:
             digits = self.clustersFromDigits.get(eventTree, 'outROI')
             digits = {key: digits[key] for key in self.digitKeys.keys()}
             self.extend(digits)
@@ -237,7 +237,7 @@ class PXD(FancyDict):
             self.set(key, data)
         self.gotCoordinates = True
 
-    def getMCData(self, eventTree: TTree, includeUnSelected: bool = False) -> None:
+    def getMCData(self, eventTree: TTree, includeUnselected: bool = False) -> None:
         """
         this loads the monte carlo from the root file
         """
@@ -254,7 +254,7 @@ class PXD(FancyDict):
         for key, data in mcData.items():
             self.set(key, data)
 
-        if includeUnSelected:
+        if includeUnselected:
             mcData = self.mcToDigits.get(eventTree, 'outROI')
             self.extend(mcData)
 

rootable/rootable.py

@@ -92,16 +92,16 @@ class Rootable:
     def stack(self, *columns, toKey: str, pop: bool = True) -> None:
        self.pxd.stack(*columns, toKey=toKey)
 
-    def open(self, *fileNames: str, includeUnSelected: bool = False) -> None:
+    def open(self, *fileNames: str, includeUnselected: bool = False) -> None:
         """
         Reads the file off of the hard drive; it automatically creates event numbers.
         """
         self.eventTrees = []
         self.fileNames = []
-        branches = self.pxd.branches(includeUnSelected=includeUnSelected)
+        branches = self.pxd.branches(includeUnselected=includeUnselected)
 
         self.multiplyFiles = True if len(fileNames) > 1 else False
-        self.includeUnSelected = includeUnSelected
+        self.includeUnselected = includeUnselected
         for fileName in fileNames:
             file, _, treeName = fileName.partition(':')
             if not file.endswith('.root'):
@@ -130,7 +130,7 @@ class Rootable:
             warnings.warn('already loaded clusters parameters')
         else:
             for eventTree, fileName in zip(self.eventTrees, self.fileNames):
-                self.pxd.getClusters(eventTree, fileName, self.includeUnSelected)
+                self.pxd.getClusters(eventTree, fileName, self.includeUnselected)
             self.gotClusters = True
 
     def getDigits(self) -> None:
@@ -138,7 +138,7 @@ class Rootable:
             warnings.warn('already loaded cluster digits')
         else:
             for eventTree in self.eventTrees:
-                self.pxd.getDigits(eventTree, self.includeUnSelected)
+                self.pxd.getDigits(eventTree, self.includeUnselected)
             self.gotDigits = True
 
     def getMatrices(self, matrixSize: tuple = (9, 9)) -> None:
@@ -185,7 +185,7 @@ class Rootable:
         if self.gotMCData:
             warnings.warn('already loaded clusters mc data')
         for eventTree in self.eventTrees:
-            self.pxd.getMCData(eventTree, self.includeUnSelected)
+            self.pxd.getMCData(eventTree, self.includeUnselected)
         self.gotMCData = True
 
     def asStructuredArray(self) -> np.ndarray: