Public Member Functions | |
| def | __init__ |
| def | initialize |
| def | initTagList |
| def | addTag |
| def | getTag |
| def | tagIt |
| def | reset |
| def | check |
| def | config |
| def | save |
| def | execute |
| def | finalPrint |
| def | finalize |
Abstract Class for Saving UserTag and UserData
The following demostrate the layout of UserTaggingAlg:
UserTaggingAlg
|
|
----------------
| |
| |
tagSet 'other members ...'
|
|
-------------
| | |
| | |
Tag1 Tag2 ...
|
|
----------------------------------
| | | | |
| | | | |
dataSet path header isTagged ...
|
|
-------------
| | |
| | |
Data1 Data2 ...
|
|
---------------------------
| | | |
| | | |
paraSet path header ...
|
|
-------------
| | |
| | |
Para1 Para2 ...
Definition at line 10 of file UserTaggingAlg.py.
| def UserTagging::UserTaggingAlg::UserTaggingAlg::__init__ | ( | self, | ||
| name | ||||
| ) |
Definition at line 13 of file UserTaggingAlg.py.
00014 : 00015 00016 UserTaggingAlg 00017 | 00018 | 00019 ---------------- 00020 | | 00021 | | 00022 tagSet 'other members ...' |
| def UserTagging::UserTaggingAlg::UserTaggingAlg::initialize | ( | self | ) |
User need not implement, but if so, you must call this method on the super-class
Definition at line 23 of file UserTaggingAlg.py.
| def UserTagging::UserTaggingAlg::UserTaggingAlg::initTagList | ( | self | ) |
Child Class should overwrite this function.
Child Class should initialize UserTag and UserData here
example adding Tag:
self.addTag('AD' , '/Event/UserTag/Detector/AD')
or alternative (pythonic) syntax:
self.tagSet.AD = Tag('/Event/UserTag/Detector/AD')
example adding a Dummy Tag and UserData:
self.addTag('Dummy', ''
).addData('ADReadoutData', '/Event/UserData/AD/ADReadoutData'
).addInt('nChannels', 'nHits'
).addFloat('chargeSum')
or alternative (pythonic) syntax:
self.tagSet.Dummy = Tag()
self.tagSet.Dummy.dataSet.ADReadoutData = Data('/Event/UserData/AD/ADReadoutData')
paraSet = self.tagSet.Dummy.dataSet.ADReadoutData.paraSet
paraSet.nChannels = Int()
paraSet.nHits = Int()
paraSet.chargeSum = Float()
Reimplemented in UserTagging::UserData::ADCalibData::ADCalibData, UserTagging::UserData::ADChannelData::ADChannelData, UserTagging::UserData::ADReadoutData::ADReadoutData, UserTagging::UserData::ADRecData::ADRecData, UserTagging::UserData::CoincData::CoincData, UserTagging::UserData::GenData::GenData, UserTagging::UserData::SimData::SimData, UserTagging::UserTag::CoincTag::CoincTag, and UserTagging::UserTag::DetectorTag::DetectorTag.
Definition at line 45 of file UserTaggingAlg.py.
00055 : 00056 DybPythonAlg.__init__(self,name) 00057 00058 # avoid a 'bug?' of UserDataHeader 00059 # gbl.std.vector('float')() has to be called at least once 00060 # before instantiate UserDataHeader 00061 tmp = gbl.std.vector('float')(); 00062 return 00063 00064 # --------------------------------------- 00065 def initialize(self): 00066 00067 ''' 00068 User need not implement, but if so, you must call this method on the 00069 super-class''' 00070 00071 status = DybPythonAlg.initialize(self) if status.isFailure(): return status
| def UserTagging::UserTaggingAlg::UserTaggingAlg::addTag | ( | self, | ||
| name, | ||||
path = '' | ||||
| ) |
Add one UserTag by name, provide a path to cause the tag object to be sent through I/O. Can also do: self.tagSet.<name> = Models.Tag([path])
Definition at line 72 of file UserTaggingAlg.py.
00072 : return status 00073 00074 # self.tagSet = {} 00075 self.tagSet = TagSet() 00076 00077 status = self.initTagList() 00078 if status == FAILURE: 00079 self.error('error in initTagList() function') 00080 return FAILURE 00081 00082 self.execNumber = 1 00083
| def UserTagging::UserTaggingAlg::UserTaggingAlg::getTag | ( | self, | ||
| name | ||||
| ) |
Look the UserTagHeader a tag by name. Can also do: mytag = self.tagSet.<name>
Definition at line 84 of file UserTaggingAlg.py.
00087 : 00088 ''' 00089 Child Class should overwrite this function. 00090 Child Class should initialize UserTag and UserData here 00091 00092 example adding Tag: 00093 self.addTag('AD' , '/Event/UserTag/Detector/AD') 00094 or alternative (pythonic) syntax:
| def UserTagging::UserTaggingAlg::UserTaggingAlg::tagIt | ( | self, | ||
| name | ||||
| ) |
Tag the named UserTag. Can also do: self.tagSet.<name>.tagIt()
Definition at line 95 of file UserTaggingAlg.py.
00095 : 00096 self.tagSet.AD = Tag('/Event/UserTag/Detector/AD') 00097 00098 example adding a Dummy Tag and UserData: 00099 self.addTag('Dummy', '' 00100 ).addData('ADReadoutData', '/Event/UserData/AD/ADReadoutData' 00101 ).addInt('nChannels', 'nHits' 00102 ).addFloat('chargeSum') 00103 00104 or alternative (pythonic) syntax: 00105 self.tagSet.Dummy = Tag() self.tagSet.Dummy.dataSet.ADReadoutData = Data('/Event/UserData/AD/ADReadoutData')
| def UserTagging::UserTaggingAlg::UserTaggingAlg::reset | ( | self | ) |
Reset the Tag States
Definition at line 106 of file UserTaggingAlg.py.
00114 : 00115 """ 00116 Add one UserTag by name, provide a path to cause the tag 00117 object to be sent through I/O. 00118 00119 Can also do:
| def UserTagging::UserTaggingAlg::UserTaggingAlg::check | ( | self, | ||
| evt | ||||
| ) |
Child Class should overwrie this function
Reimplemented in UserTagging::UserData::ADCalibData::ADCalibData, UserTagging::UserData::ADChannelData::ADChannelData, UserTagging::UserData::ADReadoutData::ADReadoutData, UserTagging::UserData::ADRecData::ADRecData, UserTagging::UserData::CoincData::CoincData, UserTagging::UserData::GenData::GenData, UserTagging::UserData::SimData::SimData, UserTagging::UserTag::CoincTag::CoincTag, and UserTagging::UserTag::DetectorTag::DetectorTag.
Definition at line 120 of file UserTaggingAlg.py.
00126 : 00127 """ 00128 Look the UserTagHeader a tag by name. 00129 00130 Can also do: 00131 00132 mytag = self.tagSet.<name> 00133 """ 00134 return self.tagSet.get(name) 00135 # --------------------------------------
| def UserTagging::UserTaggingAlg::UserTaggingAlg::config | ( | self, | ||
| evt | ||||
| ) |
Configure the UserTagHeader and UserDataHeader object Child class can overwrite depends on the situation. The "evt" is the transient event store object.
Definition at line 136 of file UserTaggingAlg.py.
00137 : 00138 """ 00139 Tag the named UserTag. 00140 00141 Can also do: 00142 00143 self.tagSet.<name>.tagIt() 00144 """ 00145 return self.tagSet.get(name).tagIt() 00146 00147 # -------------------------------------- 00148 def reset(self): 00149 '''Reset the Tag States''' 00150 00151 for tag in self.tagSet.all(): 00152 if tag.isTagged: 00153 if tag.path: 00154 tag.header = gbl.DayaBay.HeaderObject() 00155 ROOT.SetOwnership(tag.header,False) 00156 for data in tag.dataSet.all(): 00157 data.header = gbl.DayaBay.UserDataHeader() 00158 ROOT.SetOwnership(data.header,False) 00159 tag.isTagged = False 00160 00161 # -------------------------------------- 00162 def check(self, evt): 00163 '''Child Class should overwrie this function''' 00164 # all the real logics/algorithms happen here: # - check the properties of the event headers, run some algorithms.
| def UserTagging::UserTaggingAlg::UserTaggingAlg::save | ( | self, | ||
| evt | ||||
| ) |
Save the UserTag and UserData objects Most subclass should not override.
Definition at line 165 of file UserTaggingAlg.py.
00178 : 00179 ''' 00180 Configure the UserTagHeader and UserDataHeader object 00181 Child class can overwrite depends on the situation. 00182 00183 The "evt" is the transient event store object. '''
| def UserTagging::UserTaggingAlg::UserTaggingAlg::execute | ( | self | ) |
Definition at line 184 of file UserTaggingAlg.py.
00186 : 00187 if tag.isTagged: 00188 baseHeader = evt[tag.baseHeader] 00189 if not baseHeader: 00190 self.error(tag.baseHeader + ' does not exist') 00191 return FAILURE 00192 if tag.path: 00193 tagHeader = tag.header 00194 tagHeader.setExecNumber(baseHeader.execNumber()) 00195 tagHeader.setContext(baseHeader.context()) 00196 tagHeader.setEarliest(baseHeader.earliest()) 00197 tagHeader.setLatest(baseHeader.latest()) 00198 00199 for data in tag.dataSet.all(): 00200 dataHeader = data.header 00201 dataHeader.setExecNumber(baseHeader.execNumber()) 00202 dataHeader.setContext(baseHeader.context()) 00203 dataHeader.setEarliest(baseHeader.earliest()) 00204 dataHeader.setLatest(baseHeader.latest()) 00205 00206 # -------------------------------------- 00207 def save(self, evt): 00208 ''' 00209 Save the UserTag and UserData objects 00210 00211 Most subclass should not override. 00212 '''
| def UserTagging::UserTaggingAlg::UserTaggingAlg::finalPrint | ( | self | ) |
Print how many tagged events
Definition at line 213 of file UserTaggingAlg.py.
00214 : 00215 if tag.isTagged: 00216 tag.nTagged += 1 00217 if tag.path: 00218 evt[tag.path] = tag.header 00219 del tag.header 00220 for data in tag.dataSet.all(): 00221 data.save() evt[data.path] = data.header
| def UserTagging::UserTaggingAlg::UserTaggingAlg::finalize | ( | self | ) |
1.4.7