Equipment List Parameters: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
No edit summary
(The midas documentation has moved to https://midas.triumf.ca/docs/)
Tag: Replaced
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== TABLE showing Equipment List Parameters ==
The midas documentation has moved. The new documentation about the equipment list is in:
 
* [https://midas.triumf.ca/docs/develop/features/acquiring_data/frontends/programming/#declaring-your-equipment Declaring your equipment] on the Frontends: programming page (declaring equipment in a frontend)
Links
* [https://midas.triumf.ca/docs/develop/reference/reference/odb_keys/#equipmentxxxcommon /Equipment/xxx/Common] on the ODB keys page (the equipment parameters in the ODB)
[[Equipment Declaration]]
* [https://midas.triumf.ca/docs/develop/features/acquiring_data/slow_control/programming/#the-device-driver-list The device driver list] on the Slow control: programming page (class and device drivers for slow control equipment)
<div id="B">B</div>
 
[[#Equipment Name]] [[#EventID]] [[#TriggerMask]]  [[#Equipment Type]]  [[#Test1]]  [[#Buffer]]
 
[[#Equipment Type]] [[#EQ_PERIODIC]] [[#EQ_POLLED]] [[#EQ_INTERRUPT]] [[#EQ_MULTITHREAD]] [[#EQ_SLOW]]  [[#EQ_MANUAL_TRIG]]  [[#EQ_FRAGMENTED]]  [[#EQ_EB]]
 
[[#MirroredInODB]]
 
'''Note''' These parameters are copied to the ODB <span style="color: purple;">''/Equipment/<equipment-name>/Common''</span> subdirectory when the frontend is initialized.
 
{|  style="text-align: left; width: 100%; background-color: rgb(255, 255, 255);" border="3" cellpadding="2" cellspacing="2"
 
|-
| colspan="1" rowspan="1" style="vertical-align: top; background-color: rgb(255, 255, 204); font-weight: bold;" | EQUIPMENT Parameter
| colspan="1" rowspan="1" style="vertical-align: top; background-color: rgb(255, 255, 204); font-weight: bold;" | Explanation
 
'''<div id="Equipment Name"></div>'''
|- 
| colspan="1" rowspan="1"  style="vertical-align: top; background-color: rgb(255, 255, 255); color: red"  |Equipment Name
| Each equipment has to be assigned a <b> unique name </b> (i.e. no two equipments in the  same experiment may have the same name). The name will be the reference name of the equipment generating the event. Examples of typical Equipment Names are "Trigger","Scaler","Epics".
 
|-
|  style="text-align: center; font-weight: bold; vertical-align: top; background-color:turquoise; color: rgb(255, 255, 255);  " colspan="2" rowspan="1"  | EQUIPMENT_INFO  Structure
 
'''<div id="EventID"></div>'''
|- style="background-color: mintcream; "   
| style="color: seagreen;"                |  EventID
| Each equipment has to be associated with a  '''unique eventID''' . The event ID will be part of the event header of that particular equipment.
 
'''<div id="TriggerMask"></div>'''
|-  style="background-color: mintcream; "   
| style="color: seagreen;"                | Trigger Mask
| Each equipment must be associated with a <b> unique Trigger Mask </b> if  the [[#Equipment Type|Equipment Type]] is  "[[#EQ_INTERRUPT|EQ_INTERRUPT]]" or "[[#EQ_MULTITHREAD|EQ_MULTITHREAD]]".  In this case, the Trigger Mask can be modified dynamically by the readout routine to define a  '''sub-event type''' on an event-by-event basis. This can be used to mix "physics events" (from a physics trigger) and "calibration events" (from a clock for example) in one run and identify them later. Both parameters are declared as 16bit values. If the Trigger Mask is used in a single bit-wise mode, 16 is the maximum number of different masks available. 
 
'''<div id="Buffer"></div>'''  '''<div id="MirroredInODB"></div>'''
|-  style="background-color: mintcream; "
| style="color: seagreen;"    | Buffer
|  Specifies the name of the Buffer to which the event will be sent. After composition of an "Equipment", the Midas  [[Frontend Operation#Frontend|Frontend]] ''mfe.c''
takes over the sending of this event to the buffer (usually the '''"SYSTEM"''' buffer) on the back-end computer  where it may be sent to the data logger [[mlogger] and the [[analyser]].
 
*  If this field is left empty, (i.e. set to ""), the readout function associated with that equipment will still be performed, but the  actual event won't be sent to the buffer. Instead, that particular equipment can be '''mirrored in the ODB''' if the "[[#RO_ODB|RO_ODB]]" flag is turned on (see @ref  FE_RO_ODB_example "example").  The ODB is updated with a new event approximately every second. Note that this feature is generally used only for testing or monitoring, as writing large amounts of data to the ODB takes time.
* By using a buffer other than the "SYSTEM" buffer,  [[Event Filtering]] can be implemented.  
* If using an [[Event Builder]] [[Mevb]] ( i.e. a secondary stage on the back-end to collect and assemble events coming from different buffers in order to
compose a larger event) , a dedicated buffer can be specified.  In this case the "[[#EQ_EB|EQ_EB]]" flag must be turned on, and the events coming from the  [[Frontend Operation#Frontend|Frontend]] are called  '''fragments'''.
 
 
 
<div id="Type"></div>
|- style="background-color: mintcream; "
| style="color: seagreen;"    | Type
| Equipment '''Type''' should be set to one of the Equipment Flags EQ_XXX selected
from the [[Equipment Flags|list of valid Equipment Flags]].
 
 
 
 
 
 
<div id="Test1"></div>
|-  style="background-color: mintcream; " 
| style="color: seagreen;"  |
| 
 
 
|-  style="background-color: mintcream; "
| style="color: seagreen;"    |
|
 
 
|-  style="background-color: mintcream; "
| style="color: seagreen;"    |
|
 
 
 
 
|}

Latest revision as of 22:00, 30 October 2026

The midas documentation has moved. The new documentation about the equipment list is in:

Retrieved from "https://daq00.triumf.ca/MidasWiki/index.php?title=Equipment_List_Parameters&oldid=3700"