Histogram DB for Online Monitoring – User`s Manual
Contents
1. Parent string of max length 30 Folder containing this folder NULL for root folders 1 2 3 Properties of PAGE PageName string of max length 50 unique page identifier Folder valid PageFolderName Nhisto integer number of histograms on page PageDoc string of max length 100 short page description page 3 Histogram DB for Online Monitoring User s Manual Ref 1 DB design Issue 2 Date March 21 2007 1 2 4 Properties of SHOWHISTO The unique identifier is the combination Page Histo Instance Page valid PageName Histo valid HID Instance int sequence number starting from 1 to distinguish different instances of the same histogram on the same page Cx Cy Sx Sy float numbers from 0 to 1 coordinates of the histogram pad on the page Cx and Cy define the position of the top left corner Sx and Sy the size relatively to the window size Sdisplay valid DOID identifier of display option set associated to this Histogram on this Page 1 3 Definition of Automatic Analysis page 4 The ALGORITHM table contains the definition of the algorithms available for analysis They can be used to create new histograms at analysis level these will be called Analysis Histograms and are defined by the HCREATOR table or to perform automatic checks defined in the ANALYSIS table Analyses are properties of an histogram set though their parameters can be specif2. int nh HistDB gt getHistogramsByPage pages j histos for k 0 k lt nh k cout lt lt Histogram lt lt histos k gt name lt lt endl page 13 Histogram DB for Online Monitoring User s Manual 6 References and the lists of subsystems tasks and algorithms std vector lt string gt mylist cout lt lt int nss HistDB gt getSubsystems mylist for i O0 i lt nss it t cout lt lt Subsys lt lt mylist i lt lt endl mylist clear lt lt endl cout lt lt nss HistDB gt getTasks mylist for i 0 i lt nss i cout lt lt Task lt lt mylist i lt lt endl mylist clear lt lt endl cout lt lt nss HistDB gt getAlgorithms mylist for i 0 i lt nss i cout lt lt Algorithm lt lt mylist i lt lt endl finally commit changes to the DB if there were no errors if HistDB gt sendHistBuffer ok false if ok HistDB gt commit else lt lt endl cout lt lt commit aborted because of previous errors lt lt endl delete HistDB 6 References page 14 1 LHCb Commissioning Group Histogramming Framework EDMS 748834 2 Histogram DB and Analysys Tools for Online Monitoring EDMS 774740 Ref Issue 2 Date March 21 2007 r
3. if available Returns true on success bool initHistoPageDisplayOptionsFromSet std string PageName DEFAULT initializes display options associated to this histogram on page PageName default is page with the options defined for the histogram set if available Returns true on success bool initHistoPageDisplayOptionsFromHist std string PageName _NONE initializes display options associated to this histogram on page PageName default is page with the options defined for the histogram if available Returns true on success bool setHistoSetDisplayOption std string ParameterName void value sets a display option for the whole histogram set The available parameter names and the corre sponding types are listed in section 1 2 1 Returns true on success page 9 Histogram DB for Online Monitoring User s Manual Ref 4 C Interface Issue 2 Date March 21 2007 bool setDisplayOption std string ParameterName void value sets a display option for the present histogram bool setHistoPageDisplayOption std string ParameterName void value std string PageName DEFAULT sets a display option for the present histogram on page PageName default is page bool getDisplayOption std string ParameterName void option if display option ParameterName has been defined puts its value into option and returns true In case different sets of display options exists for histogram set histogra
4. actu ally send to the DB server every N histograms or at commit in order to optimize performance The default buffer depth recommended value is 1000 bool sendHistBuffer forces sending histogram declaration buffer to the DB Returns true if there are no errors OnlineHistogram declareAnalysisHistogram std string Algorithm std string Name std vector lt OnlineHistogram gt amp Sources std vector lt float gt Parameters NULL page 6 Histogram DB for Online Monitoring User s Manual Ref 4 C Interface Issue 2 Date March 21 2007 declares an histogram to be produced at analysis level using algorithm Algorithm Name is the histogram name Sources must contain the pointers to the input histograms Parameters is a pointer to a parameter vector optionally needed by the algorithm If the algorithm requires an histogram set as input use any histogram of the set Returns the pointer to the new histogram object bool removeHistogram OnlineHistogram h bool RemoveWholeSet false removes an histogram and optionally its full set bf This is a temporary method to be used if needed at the development stage Will be removed at production stage bool declareCheckAlgorithm std string Name int Npars std string pars NULL std string doc NONE declares to the DB an Analysis algorithm implemented in the Analysis library Npars is the num ber of algorithm s parameters pars should point to an array con
5. number of folders found list must be created by the user int getPageNamesByFolder std string Folder std vectorjstring amp list gets the list of pages in a folder Returns the number of pages found list must be created by the user int getPageNames std vectorjstring amp list gets the list of all available pages Returns the number of pages found list must be created by the user int getSubsystems std vectorjstring amp list gets the list of known subsystems list must be created by the user int getTasks std vectorjstring amp list gets the list of task names list must be created by the user int getAlgorithms std vectorjstring amp list std string type ALL gets the list of algorithm names list must be created by the user type can be _ALL_ CHECK HCREATOR 4 2 OnlineHistogram class page 8 OnlineHistogram objects are instantiated within an OnlineHistDB object i e a DB transaction through the getHistogram method std string identifier full histogram unique identifier Taskname AlgorithmName HistogramName std string page page on which histogram is displayed if specified void setPage std string Page set page on which histogram is displayed reload display options if needed std string hid internal histogram ID equivalent to hsid ihs int hsid internal histogram set ID std string dimServiceName name of the DIM service that is
6. 1 2007 R1 R2 R1 DBEnv H1D LE Timing Time_of_flight OnlineHistDBEnv H1D nd histogram buffer to DB E Timing Time_of_flight string ServiceName H1D nodeMF001_EXAMPLE_01 SafetyCheck Trips HistDB gt declareHistByServiceName ServiceName ServiceName H1D nodeMF001_EXAMPLE_01 SafetyCheck Trips_after_use_of_CRack HistDB gt declareHistByServiceName ServiceName ServiceName H2D nodeMF001_EXAMPLE_01 OccupancyMap Hit_Map_ HistDB gt declareHistByServiceName ServiceName ServiceName H2D nodeMF001_EXAMPLE_01 OccupancyMap Hit_Map_ HistDB gt declareHistByServiceName ServiceName ServiceName H2D nodeMF001_EXAMPLE_01 OccupancyMap Hit_Map_ HistDB gt declareHistByServiceName ServiceName HistDB gt declareHistByServiceName ServiceName HistDB gt declareHistogram EXAMPLE Timing Coincidences O HistDB gt declareHistogram EXAMP if HistDB gt sendHistBuffer needed to se ok false OnlineHistogram thisH HistDB gt getHistogram EXAMPL if thisH t hisH gt setDimServiceName H1D nodeA01_Adder_01 EXAMPLE Timing Time_of_flight Now declare an histogram to be produced at analysis level by some algorithm and an automatic check to be performed on it the declaration of algorithms should be normally done by the developers of analysis library Hist bin by bin subtraction Onli Onli Onli neHistogram sl neHistogram s2 HistDB
7. Histogram DB for Online Monitoring User s Manual Issue 2 Revision 0 Reference Created March 21 2007 Last modified March 21 2007 Prepared by G Graziani Histogram DB for Online Monitoring User s Manual Ref Issue 2 1 DBdesign Date March 21 2007 1 DB design The requirements and use cases of an Histogram Database for Online Monitoring in the context of a common Histogramming Framework 1 have been defined in 2 The present design of DB tables is shown in figure 1 SUBSYSTEM ALGORITHM SHOWHISTO B HISTOGRAM ANALYSIS ANASETTINGS o H a D T gt lt O me fn HH O Z U I H O od Q N v gt U m C CREATOR Figure 1 Scheme of DB tables 1 1 Definition of Histograms Histograms are uniquely identified by the expression Taskname Algorithmname HistogramName The histogram name can contain a subname HistogramName HistogramSet Name _Subname Histograms differing only by Subname are part of the same Histogram set These should be histograms that have identical binning e g containing the same distribution for different channels of a detector For easier reference an internal unique identifier is created for each histogram in the form HID HSID IHS where HSID is an integer number identifying the histogram set and IHS is a sequence number start ing from 1 to identify histograms in the same set 1 1 1 Properties of TASK
8. TaskName string of max length 100 unique task identifier RunOnPhysics RunOnCalib RunOnEmpty boolean specify for which type of data task is running Subsys1 Subsys2 Subsys3 string of length 10 up to 3 subdetector subsystem can be associated to task Reference string of length 100 link to the location of reference histograms for this task page 1 Histogram DB for Online Monitoring User s Manual Ref 1 DB design Issue 2 Date March 21 2007 1 1 2 Properties of HISTOGRAMSET HSID integer NHS integer number of histograms in set Task valid TaskName Algorithm string of max length 100 HistogramSetName string of max length 200 Type H1D H2D for normal histograms P1D P2D for profile histograms CNT for counters Nanalysis integer number of analysis to be performed on set Description string of max length 4000 Documentation string of max length 200 link to a more extensive documentation HSDisplay valid DOID identifier of display option set associated to Histogram set 1 1 3 Properties of HISTOGRAM HID string of max length 12 HSID IHS Subname string of max length 50 DIMServiceName string of max length 130 Name of the DIM service that is currently publishing the histogram IsAnalysisHist boolean true if histogram is produced at analysis level CreationTime timestamp recordin
9. currently publishing the histogram bool setDimServiceName std string DimServiceName setes the DIM service name that is currently publishing the histogram Returns true on success Histogram DB for Online Monitoring User s Manual Ref 4 C Interface Issue 2 Date March 21 2007 int nhs number of histograms in set int ihs position of this histogram in set starting from 1 Can be larger than nhs if some histogram in the set has been deleted std string hstype histogram type H1D H2D P1D P2D or CNT std string hsname histogram set name std string subname subname std string task task name std string algo algorithm name std string descr short description of the histogram std string doc link to a more extensive documentation int creation creation date as a unix timestamp int obsoleteness if the histogram is no more in use returns the end of validity date as a unix timestamp other wise returns 0 Methods for display options typedef enum NONE SET HIST HISTPAGE DisplayOptionMode DisplayOptionMode domode specifies if the display options in this object are not defined associated to the histogram set associated to the histogram associated to the histogram on page page bool initDisplayOptionsFromSet initializes display options associated to this histogram with the options defined for the his togram set
10. f enum H1D H2D P1D P2D CNT HistType int debug const void setDebug int DebugLevel debug level 1 means no messages 0 default means only error messages gt 0 some debugging information is printed int excLevel const void setExcLevel int ExceptionLevel exception level 0 means never throw exc to client code 1 means only severe errors default value 2 means throw all exceptions The default value is 1 meaning that exceptions are thrown only in case of severe DB inconsis tency All other errors e g syntax errors can be checked from the method return values and from the warning messages on the standard output Note that the debug and exception levels defined for the OnlineHistDB object are propagated to all new objects created through the getPage and getHistogram methods 5 Code Example include lt OnlineHistDB OnlineHistDB h gt int main Open DB transaction page 11 Histogram DB for Online Monitoring User s Manual 5 Code Example std string password ask_to_DB_manager OnlineHistDB bool ok true HistDB new Onli neHistDB password Declare the features of your task and your histograms is DB gt declareTas Li k Ref Issue 2 EXAMPLE MUON GAS true true false Region_M1 Region_M1 Region_M3 nlineHist Date March 2
11. g the first time the histogram is seen ObsoletenessTime timestamp can be set by hand if histogram is not produced any more Display valid DOID identifier of display option set associated to Histogram 1 2 Definition of Pages and Display Options page 2 Pages and Page Folders are uniquely identified by their name Page folders can have a hierarchical structure for example Folder1 Folder1 Folder2 Folder1 Folder2 Folder3 Pages are associated to a list of valid histograms through the SHOWHISTO table containing the lay out of each histogram on the page As shown in figure 1 a set of display options can be defined for e an histogram on a given page Histogram DB for Online Monitoring User s Manual Ref Issue 2 1 DBdesign Date March 21 2007 e an histogram e an histogram set so that the most specific available set is used but one can use the same default for say the 2000 histograms of a certain set 1 2 1 Properties of DISPLAYOPTIONS DOID integer unique identifier LABEL_X string of max length 50 LABEL_Y string of max length 50 LABEL_Z string of max length 50 YMIN float YMAxX float STATS int FILLSTYLE int FILLCOLOR int LINESTYLE int LINECOLOR int LINEWIDTH int DRAWOPTS string of max length 50 1 2 2 Properties of PAGEFOLDER PageFolderName string of max length 30 unique page folder identifier
12. gt get HistDB gt get EXAMPLE Saf Li neHistogram htrips 0 DB gt declareCreatorAlgorithm Subtraction 2 OnlineHistDBI EXAMPL Histogram E SafetyChec Histogram etyCheck Trips_after_use_of_C std vector lt OnlineHistogram gt sources if sl amp amp s2 sources push_back sl sources push_back s2 htrips HistDB gt declareAnalysisHistogram Subtraction Trips_due_to_CRack sources std string mypar 1 Max bool algok HistDB gt declareCheckA Checks al if htrips amp amp algok ll bins to be sm lgorithm CheckMax 1 mypar aller than Max std vector lt float gt warn 1 100 std vector lt float gt alarm 1 500 htrips gt declareAnalysis CheckMax page 12 amp warn amp alarm Rack k Trips Env H1D 0 NULL r Histogram DB for Online Monitoring User s Manual 5 Code Example Ref Issue 2 Date March 21 2007 Now create a page and edit the display options of its histograms Start by setting options for the whole histogram set OnlineHistogram h1l HistDB gt getHistogram EXAMPLE OccupancyMap Hit_Map_ Region_M1R1 OnlineHistogram h2 HistDB gt getHistogram EXAMPLE OccupancyMap Hit_Map_ Region_M1R2 OnlineHistogram h3 HistDB gt getHistogram EXAMPLE OccupancyMap Hit_Map_ Region_M3R1 if hl amp amp h2 amp amp h3 Onli
13. ied for each histogram in the ANASETTINGS table 1 3 1 Properties of ALGORITHM AlgorithmName string of max length 30 unique algorithm identifier AlgType HCREATOR or CHECK Ninput integer number of input histograms for HCREATOR algorithms Npars integer number of parameters AlgPars array any length of string of max length 15 parameter names HCTYPE for HCREATOR algorithms type of histogram generated by this algorithm AlgDoc string of max length 1000 documentation 1 3 2 Properties of ANALYSIS AID integer unique analysis identifier allowing to assign the same algorithm more than once to the same histogram HSET valid HSID Algorithm valid AlgorithmName Histogram DB for Online Monitoring User s Manual Ref Issue 2 4 C Interface Date March 21 2007 1 3 3 Properties of ANASETTINGS AnalD valid AID Histogram valid HID Mask boolean allow to mask the analysis for a single histogram Warnings Alarms arrays Npars of floats 2 sets of threshold levels 1 3 4 Properties of HCREATOR when a HCREATOR entry is defined the corresponding histogram is created with Task ANALYSIS and Algorithm the name of the analysis algorithm HCID valid HID Algorithm valid AlgorithmName Sourceh arrays 8 of string of max length 12 list of input histograms SourceHSet valid HSID input hist
14. lent to run it once page 5 Histogram DB for Online Monitoring User s Manual Ref Issue 2 4 C Interface Date March 21 2007 4 1 OnlineHistDB class Each instantiation of this class opens a transaction with the DB server Its methods allow the creation of histograms and pages and the definitions of tasks subsystems and algorithms Histograms and pages can be edited through the pointers to OnlineHistogram and OnlineHistPage objects returned by the getHistogram and getPage methods Such objects make sense only within the transaction and should never be deleted by the user they are destroyed by the OnlineHistDB destructor Changes are committed to the DB only by an explicit call to the commit method By default DB errors don t throw exceptions to the client code but for severe inconsistencies i e bugs The default behaviour can be changed see section 4 4 Normally one can detect errors by the method return values and choose if commit or not Histogram declarations are a special case since in order to improve performance they are stored in a buffer with default depth 1000 and actually sent to the DB server only when the buffer is full or at commit time In order to check for errors in histogram declarations one can use the sendHistBuffer method to force buffer sending and check its return value before committing Note that if an error occurs and you commit anyway only all histograms declared before the error are sent to
15. m and histogram in page the most specific one is used Methods for analysis options int nanalysis number of analysis to be performed on the histogram set const std vector lt int gt amp anald vector of length nanalysis containing the analysis internal IDs const std vector lt std string gt amp anaName vector of length nanalysis containing the analysis algorithm names boolean isAnaHist true if the histogram is produced at analysis level int declareAnalysis std string Algorithm std vector lt float gt warningThr NULL std vector lt float gt alarmThr NULL int instance 1 declare an analysis to be performed on the histogram set If the algorithm requires some pa rameters the warning and alarm values must be specified as vectors of floats and will be set for all histograms in set then you can specify values for single histograms with the setAnalysis method You can create more than one analysis with the same algorithm by using instance gt 1 If the analysis identified by Algorithm and instance already exists parameters are updated Re turns the internal analysis ID bool setAnalysis int AnaID std vector lt float gt warningThr NULL std vector lt float gt alarmThr NULL updates parameters for analysis with ID AnalD for this histogram only Returns true on suc cess bool getAnaSettings int AnaID std vector lt float gt warn std vector lt float gt alarm gets parameters fo
16. neHistPage pg HistDB gt getPage My Example Page Examples My examples if pg pg gt declareHistogram h1 0 0 0 pg gt declareHistogram h2 0 0 5 0 pg gt declareHistogram h3 0 0 0 5 v2 i int L 2 s 7 fe 35 float ymax 20000 hl gt setHistoSetDisplayOption hl gt setHistoSetDisplayOption hl gt setHistoSetDisplayOption hl gt setHistoSetDisplayOption LINECOLOR void amp lc FILLSTYLE void amp fs FILLCOLOR void amp fc YMAX void amp ymax anaa to set more specific display options for single histograms or histograms in a given page remember to initialize the option set if you want to keep the less specific options lc 3 h2 gt initDisplayOptionsFromSet h2 gt setDisplayOption LINECOLOR void amp lc fc 4 h3 gt initHistoPageDisplayOptionsFromSet Example Page h3 gt setHistoPageDisplayOption FILLCOLOR void amp fc Now display the list of pages with their histograms std vector lt string gt folders std vector lt string gt pages std vector lt OnlineHistogram gt histos int nfold HistDB gt getPageFolderNames folders int i j k for i 0 i lt nfold i cout lt lt Folder lt lt folders i lt lt endl pages clear int np HistDB gt getPageNamesByFolder folders i pages for j 0 j lt np jtt cout lt lt Page lt lt pages j lt lt endl histos clear
17. of histograms found list must be created by the user int getAnalysisHistograms std vector lt OnlineHistogram gt amp list gets the list of histograms that have to be produced by analysis task Returns the number of histograms found list must be created by the user int getHistogramsBySubsystem std string SubSys std vector lt OnlineHistogram gt amp list gets the list of histograms related to subsystem SubSys Returns the number of histograms found list must be created by the user int getHistogramsByTask std string Task std vector lt OnlineHistogram gt amp list gets the list of histograms related to task Task Returns the number of histograms found list must be created by the user page 7 Histogram DB for Online Monitoring User s Manual Ref 4 C Interface Issue 2 Date March 21 2007 int getHistogramsByPage std string Page std vector lt OnlineHistogram gt amp list gets the list of histograms displayed on page Page Returns the number of histograms found list must be created by the user int getHistogramsBySet std string SetName std vector lt OnlineHistogram gt amp list int getHistogramsBySet const OnlineHistogram amp Set std vector lt OnlineHistogram gt amp list gets the list of histograms in a Set Returns the number of histograms found list must be created by the user int getPageFolderNames std vectorjstring amp list gets the list of available page folders Returns the
18. ogram set if required by the algorithm HCPARS arrays Npars of floats set of needed parameters 2 DB implementation A first prototype of the DB has been implemented under Oracle on the CERN Oracle server and is available for tests The DB can be accessed through a C API or interactively through a Web interface written in PHP In order to minimize client load and network traffic and ease the maintenance of interface code both interfaces are based on a set of common PL SQL procedures that are precompiled on the Oracle server 3 Web interface It is available for test at the address https webafs3 cern ch ggrazian lhcb OnlineHist DB index php It is intended to be the most suitable tool to browse available histograms edit the display options and the automatic analysis including the definition of histograms to be produced at analysis level Presently it is also possible to edit the viewer page configurations though a graphical editor in the presenter application will likely be the most suitable tool for that task 4 C Interface The interface is available as a link library that can be compiled from the package Online OnlineHistDB in the LHCb code repository The C API allows to perform practically any operation on the DB You can add entries to the DB through the methods beginning with declare that create the specified entry if not existing or update its fields otherwise Thus running the same code twice is equiva
19. r analysis with ID AnaID Returns true on success bool maskAnalysis int AnalysisAnaID bool Mask true masks analysis with ID AnaID Use Mask false to unmask Returns true on success 4 3 OnlineHistPage class page 10 const std string amp name page name const std string amp folder page folder name int nh number of histograms on page Histogram DB for Online Monitoring User s Manual Ref 5 Code Example Issue 2 Date March 21 2007 const std string amp doc short page description bool setDoc std string Doc set short page description bool setFolder std string Folder set page folder name If not existing page folder is created bool declareHistogram OnlineHistogram h float Cx float Cy float Sx float Sy int instance 1 adds or updates an histogram on the page Use instance gt 1 to use the same histogram more than once Returns true on success bool removeHistogram OnlineHistogram h unsigned int instance 1 removes histogram from page returning true on success const std vector lt OnlineHistogram gt amp hlist returns the list of histograms on this page bool getHistLayout OnlineHistogram h float amp Cx float amp Cy float amp Sx float amp Sy unsigned int instance 1 get the layout of given histogram returns false if histogram is not found 4 4 OnlineHistDBEnv class All previous classes derivate from this one that has a few public members typede
20. taining the parameter names doc is a short description of the algorithm bool declareCreatorAlgorithm std string Name int Ninput 0 Histlype OutputType H1D int Npars 0 std string pars NULL std string doc NONE declares to the DB an available algorithm to produce histograms at analysis time Ninput is the number of input histograms Npars the number of optional parameters pars containing their names doc is a short description of the algorithm int getAlgorithmNpar std string AlgName int Ninput NULL gets the number of parameters and optionally the number of input histograms needed by al gorithm AlgName std string getAlgParName std string AlgName int Ipar gets the name of parameter Ipar starting from 1 of algorithm AlgName OnlineHistPage getPage std string Name std string Folder gets a pointer to an OnlineHistPage object to create a new page in this case Folder must be specified or view edit an existing one OnlineHistogram getHistogram std string Name std string Page NONE gets a pointer to an OnlineHistogram object that can be used to view edit an histogram record If Page is specified the default display options for the histogram are those associated to the page if available Query methods int getHistogramsWithA nalysis std vector lt OnlineHistogram gt amp list gets the list of histograms on which some check analysis has to be performed Returns the num ber
21. the DB and the buffer is emptied HistDB std string passwd std string user OnlineHistDBEnv_constants ACCOUNT std string db OnlineHistDBEnv constants DB constructor bool commit commits all changes to the DB Returns true if there are no errors bool declareTask std string Name std string SubDetl NULL std string SubDet2 NULL std string SubDet3 NULL bool RunsOnPhysics false bool RunsOnCalib false bool RunsOnEmpty false creates or updates a Task definition returning true on success Tasks can be associated to up to three subdetectors subsystems bool declareSubSystem std string SubSys declares a subsystem returning true on success void declareHistByServiceName const std string amp ServiceName declares an Histogram by its DIM service name In the LHCb DAQ this is intended to be used only by the Experiment Control System to dynamically update the DB with the published his tograms Tasks not known to the DB are automatically created If histogram already exists just updates the current DIM service name void declareHistogram std string TaskName std string AlgorithmName std string Histogram Name HistType Type declares an Histogram by its identifying attributes no need to know the DIM service name The enum HistType is defined in section 4 4 void setHistogramBufferDepth int N when creating histograms with the declareHistByServiceName method the histogram list is
Download Pdf Manuals
Related Search