CompDQMUserManual < TOTEM

---+ !TotemDQMLite: User's guide

Note: this manual refers to version 3.x. In the current version (7.x), certain elements may have a slightly different look, but the principal functionality is the same.

---+++ 1. Getting started

*STEP 1*

After proper configuration of your CMSSW, just type:
<verbatim>
TotemDQMLite
</verbatim>
to start *Data Quality Monitor* application.


To see more options you can use:
<verbatim>
TotemDQMLite --help
</verbatim>

*STEP 2*


After running DQM application you should see Main Window.

<img src="%ATTACHURL%/1.png" width=400>


In order to use the application you must open a configuration file. 

To do so, just click on *File->Open*.

*STEP 3*


Now you should see *'Open Dialog'* window.

<img src="%ATTACHURL%/2.png" width=400>

Choose configuration files to be opened in section *'Configuration File'* and related data files in section *'Event Source'*.

Click *'Open'*.

After a while data should be loaded and you should see 'File opened' message in the status bar.

*STEP 4*

Now click on *Window->New* to open new plots' space

<img src="%ATTACHURL%/19.png" width=200>

You should see:

<img src="%ATTACHURL%/3.png" width=400>

*STEP 5*

Try double-click on a cell to choose the plot you'd like to see.

After double-click on a cell, the *'Choose Dialog'* Window should become visible.

<img src="%ATTACHURL%/4.png" width=400>

Now you can select the plot that you're interested in. 

From the left window (tree structure) you select the *'element type'* and from the right window - *'output plot'* related to the element.

Confirm by *'OK'* or by double-click.

You should see chosen plot in the clicked cell.

<img src="%ATTACHURL%/5.png" width=400>

*STEP 6*

You can repeat the choosing plot operation for the same or other cells to get the plots you like.

If you need more cells, just increase the number of cells by clicking *'+col'* or *'+row'* button (in the 'Window Layout groupbox - right bottom of the Main Window).

*STEP 7*

For plots which are related to one event use *'Event'* groupbox (left bottom of the Main Window) to change the number of the __run__ and the __event__.

<img src="%ATTACHURL%/6.png" width=400>

Use can also use *'+'* and *'-'* keyboard shortcut to change the *event* number.


---+++

This is the minimum you have to know to use the DQM application, but your work can be much faster and more pleasant while using special features delivered by the DQM.

So I strongly recommend reading the next section.


---+++ 2. Useful features

*MULTIPLE WINDOWS*

Multiple Windows feature gives you the possibility to better organize your plots. You can keep them in separate windows which can be easily attached/detached and tabbed in the *Main Frame* (Main Window).

To detach window from the *Main Frame* click on the window name (e.g. "Untitled") and while pressing the mouse button move the cursor outside the Main Frame.

<img src="%ATTACHURL%/7.png" width=600>

Now, release the mouse button. You should see a separate window related to the same application.

To attach the window back to the *Main Frame*, grab it and move to the *Main Frame*. Then release the button.


Now, change the window name. You can do it by *double-clicking* on the current name of the window (just the place you pressed the mouse button before). Try *double-click* on that place (e.g. "Untitled"). You should see the *Change Window Name* dialog.

<img src="%ATTACHURL%/8.png" width=250>

Try changing the window name (e.g. "Very important plots").


The windows can be tabbed in the Main Window.
Try creating a new window (*Window->New*).

Now, you should see it has been added as a tabbed window which you can control be clicking the tab you want.

<img src="%ATTACHURL%/9.png" width=500>


Benefit from the multiple windows and try separating logically your graphs in a way that is the best for you.

*LAYOUTS*

Layout feature gives you the possibility to save and load the arrangement of your plots. 

So you place the plots in the positions you like and then save the layout. After running again the application you can load the layout and have the same plot arrangement you've saved.


There are two types of layout:

   1. Window Layout
   1. Application Layout

*Window Layout*

Window Layout is related to one window (not all windows you have in the application).

It remembers:
   * the arrangement of the plots (inside one window).

To save the Window Layout click on the *Save* button placed on the bottom-right side of the window.

<img src="%ATTACHURL%/10.png" width=400>

Now when you run the DQM application once again or just create a new window, you can have the same plots arrangement that you have saved. To load the layout - use *Load* button and select the  *.lay file you want.


Try also creating new window directly from *Window Layout* (*.lay) file by clicking *Window->New From...*

<img src="%ATTACHURL%/11.png" width=200>

*Application Layout*

Application Layout is related to the whole application. 

It remembers:
   * names of all windows
   * arrangement of plots in all windows
   * geometry of all windows 
   * attached/detached with reference to the Main Window

To save the Application Layout, click *Application Layout->Save to...*.

<img src="%ATTACHURL%/12.png" width=250>

Now, after running the application once again, you can load the Application Layout by clicking *Application Layout->Load From...* and selecting the *apl file you want.


*Directories to save layouts*

The directories to keep files of the layouts can be selected each time you wish to save/load layout. But for the convenience the default directories can be set by using environmental variable:
<verbatim>
DQM_LAYOUT_DIR
</verbatim>

*PLOT DRAG & DROP*

Plot Drag&Drop feature is extremely useful while arranging plots' places. You can simply change the place of the plot.

While the mouse cursor is on some plot, press *Ctrl* key and keep it pressed. Now, press the left mouse button and while they are pressed (both *Ctrl* key and left mouse button) move the cursor on the other plot. 

<img src="%ATTACHURL%/13.png" width=400>

Now, release the mouse button. 
You should see that plots have changed their places.

<img src="%ATTACHURL%/14.png" width=400>


Drag&Drop can be also used when one would like to exchange the plots between different windows.


*ZOOMING*

Zooming feature is useful when one would like to see the plot in details.

Try clicking on the plot with both mouse buttons (or while pressing *Shift* button click the left mouse button). You should see a new fullscreen window with only one plot in it.

<img src="%ATTACHURL%/15.png" width=300>



---+++ 3. Detailed application description


*OPEN FILE WINDOW*

Open File window is dedicated to selecting and opening the proper configuration file with data files you want.

<img src="%ATTACHURL%/16.png" width=400>


*1. configuration file selection*

Click *browse* to select the configuration file you want to use. The configuration files you selected before are remembered and you can use them by clicking on the combo box.

If you want to edit the configuration file - click *edit*. It will be opened in editor set by the local variable:
<verbatim>
DQM_EDITOR
</verbatim>

If the variable is not set, the configuration file will be opened in the *'kate'* editor


*2. data source selection*

You can use data files from the configuration file (if there are any) or select data files separately.


*3. selecting data files*

Click on *browse* button to add a new data file.

Click on *clear* button to clear the 'Data files' field.

Your previous choices are remembered in the history, so by clicking *'<--'* and *'-->'* buttons you can select one of them.



*CHOOSE DIALOG WINDOW*

The graphs seen in the Choose Dialog Window have to be firstly registered in the DQM Plugin. It is made by the function:
<verbatim>
PlotManager::Register(const std::string &path, const std::string &title, TNamed *n, const string &opt, bool own)
</verbatim>

*'path'* is a tree pattern string

For example after registering graph with the path: 

*&#8220;sector 56/station 220/nr_tp/plane 02/cluster size&#8221;*

we will see the result in the *Choose Dialog* window:

<img src="%ATTACHURL%/17.png" width=400>


After choosing the proper element in the left part of the window the plots related to this element will be shown in the right part of the window.

Then, click *OK* to show the chosen plot.

One can use *Empty* button to clear the cell (put an empty-plot).


*VIEW BOX*

__'View'__ can be seen in the bottom-middle part of the window. It consists of 3 buttons.

<img src="%ATTACHURL%/18.png" width=300>

   * *Refresh* - refresh visually plots and to update the incoming data (with streaming data)
   * *Screenshot* - save the plots as an image in the format you want
   * *Save ROOT File* - save all the plots that have been registered in the *PlotManager* to a ROOT file


---+++ 4. Other important information

*CORRELATION PLOTS CHOOSING*

The correlation plot is done for 2 planes. If we wanted to use all the planes, there would be too many plots. So we have to reduce the number of the correlation plots.

There are 3 variables in the configuration file:
   * *buildCorrelationPlots* : cms.untracked.bool  - decides whether to use correlation plots or not 
   * *correlationPlotsLimit* : cms.untracked.uint32 - decides the maximum number of the correlation plots
   * *correlationPlotsFilter* : cms.untracked.string - decides which planes are used for correlation plots

The example of the filter string (*correlationPlotsFilter*):

*&#8220;default=0,3,6; 120=0,3,6,4;&#8221;*

With this string following planes would be used:
   * from RP number 120 : planes 0,3,4,6
   * from other RPs : planes 0,3,6

So the default defines the planes for every casual RP, then we specify for each RP which plane to use.

From all the chosen planes all necessary correlation plots are created.

Attachments

Topic attachments
I	Attachment	History	Action	Size	Date	Who
png	1.png	r1	manage	9.2 K	2009-09-17 - 16:49	UnknownUser
png	2.png	r1	manage	13.5 K	2009-09-17 - 16:52	UnknownUser
png	3.png	r1	manage	15.6 K	2009-09-17 - 16:52	UnknownUser
png	4.png	r1	manage	13.6 K	2009-09-17 - 16:52	UnknownUser
png	5.png	r1	manage	17.0 K	2009-09-17 - 16:53	UnknownUser
png	6.png	r1	manage	18.3 K	2009-09-17 - 16:53	UnknownUser
png	7.png	r1	manage	14.7 K	2009-09-17 - 17:00	UnknownUser
png	8.png	r1	manage	5.2 K	2009-09-17 - 17:08	UnknownUser
png	9.png	r1	manage	14.8 K	2009-09-17 - 17:13	UnknownUser
png	10.png	r1	manage	18.3 K	2009-09-17 - 17:39	UnknownUser
png	11.png	r1	manage	2.7 K	2009-09-17 - 17:46	UnknownUser
png	12.png	r1	manage	3.3 K	2009-09-17 - 17:54	UnknownUser
png	13.png	r1	manage	20.2 K	2009-09-17 - 18:13	UnknownUser
png	14.png	r1	manage	19.6 K	2009-09-17 - 18:14	UnknownUser
png	15.png	r1	manage	16.1 K	2009-09-17 - 18:20	UnknownUser
png	16.png	r1	manage	16.7 K	2009-09-17 - 18:35	UnknownUser
png	17.png	r1	manage	12.9 K	2009-09-17 - 18:59	UnknownUser
png	18.png	r1	manage	1.7 K	2009-09-17 - 19:12	UnknownUser
png	19.png	r1	manage	2.8 K	2009-09-18 - 09:28	UnknownUser

This topic: TOTEM > WebLeftBar > CompMonitor > Comp > CompDQMUserManual
Topic revision: r9 - 2015-10-07 - JanKaspar

Copyright &© 2008-2023 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
or Ideas, requests, problems regarding TWiki? use Discourse or Send feedback