User Manual
Contents
1. 16 Shortcuts 13 14 15 Figure 1 ced2go after the first start 1 Overview The C Event Display CED and is a client server based tool to draw objects into a dynamic 3D picture CED is a graphical application which uses OpenGL to display the 3D enviroment It is possible to draw individual objects with CED see section but for common use it is well integrated into the ilcsoft framework The common use for CED is to display events To do this several steps are necessary A data file which contains the LCIO objects to be drawn is needed This object gets processed with Marlin which sends the data of the events over a TCP IP connection to CED In order to do this Marlin needs a steering file This XML file can be written by hand or can be generated with MarlinGUI The steering file decides which data file is read and also which viewer is used the viewer decides which datatype is on what layer see layer section which color will be used etc Example viewers are Generic CED and DST Viewer 2 Quickstart Generating a Marlin steering file can be time consumming but there is a tool in the CED package which displays the event using a default configuration For a simple first look source the ini ilcsoft script and use the command ced2go lt your datafile gt A window which contains the graphical interpretation of your event will open To view the next event press enter in the terminal where you have commited the ced22. 4 Views 4 1 Rotate To change the view simply left click into the CED window hold the mouse button and pull in any direction to rotate the view 4 2 Zoom factor To increase the magnification press to decrease press If you are on Linux zooming with the mousewheel works too 4 3 Move To move the center of view to any direction press and hold the middle mouse button and pull To move the detector on the z axis press arrow key 1 or 4 4 Center It is possible to center any data object drawn within CED Simply put your mouse cursor over that object and press c 4 5 Side view To view the detector from the side press s or choose it from the pop up menu under View Side view 4 6 Front view To view the detector from front press f or choose it from the pop up menu under View Front view 4 7 Reset view settings To reset the view and cut settings press r or choose it from the pop up menu under View Reset view This option resets perspective cutting projections and zoom level 5 Projections There is a big difference between views and projections View options show the same objects at a different angle in contrast to projections which change the objects 5 1 Side view projection To enable side view projection press capital S or choose it from the pop up menu under View Toggle side view projection This projecti
3. environment variable CED_HOST 0n the remote computer export CED_HOST lt your local hostname gt Marlin lt your datafile gt 12 Change the CED port CED binds to a TCP IP socket to receive data that will be drawn By default it uses port number 7286 To change it save the portnumber you want to use in the environment variable CED_PORT export CED_PORT lt Portnumber gt Ensure that the environment variable is set to the same value for Marlin and CED 13 13 CED2go This tool is designed to enable a quick and simple view into the events of a data file To start ced2go type ced2go lt LCIO File gt Marlin and CED will be started CED2go will determine which gearfile has been used by generating the LCIO file and configure the viewer s If you use your very own gearfile you must tell ced2go where to find it use the d lt Gearfile gt option The default viewer is the CEDViewer use the v option to change it more than one viewer at the same time is supported This information has to be written in a XML file to configure Marlin Secondly ced2go search for a free TCP IP port so its possible to start ced2go several times After that CED will start and Marlin connects 14 Viewer To draw an event with Marlin into CED Marlin needs a configuration file written in XML This file is called the Marlin Steeringfile see its documentation for details In this file one or more viewers are configured There a a number of
4. DEUTSCHES ELEKTRONEN SYNCHROTRON USER MANUAL C Event Display CED Author Supervisor Hauke H LBE Dr Frank GAEDE 2011 Contents 1 2 Overview Quickstart Save settings Views 4 1 Rotate 4 2 Zoom factor 4 3 Move 44 Center 4 5 Side view 4 6 Front view 4 7 Reset view settings Projections 5 1 Side view projection 5 2 Front view projection Ono Fisheye VIEW s reag amp amp Sa Yee oe Ee ES ee ee See Bee Layer Ok Date bayer so vt ke vaeceeeeeee See Bu RR ate eae ee 6 2 Detector components 6 amp aw eo AE Re elie en a Se Cuts Tal Longitudinal tuts 4 soc lt amp aw ear oe lS ee ES SG Po SE CUUs 4 2 8 Rh Oh EE E E E aed ee Be oe eo Be 2 Background color 8 1 Change background color 000004 Graphical options 9 1 Differences between classic and new view 9 2 Perspective setting a Boa a ein de cee we ae eae ew as SS 9 3 Transparency or mesh view sosse rss eens 9 4 Visibility of coordinate axes 2 eee ee ee 0 5 Transparency Valles as sg be aaa et ae ES ee ie a ek we 9 6 Frames per seconds comes ess SG eRe eh BBY 10 Picking 10 1 Quickstart 10 2 Install your own print function 0 11 Work with CED from remote 12 Change the CED port 13 CED2go w Ww PPR BWW WH Ww op Aa A QO g a oO 12 12 13 14 Viewer 15 Marlin Util MarlinCED
5. cut off a pie slice from the detector select Detector cuts Angle from the pop up menu Available angles are 0 30 90 135 180 270 and 360 degrees Figure 6 Phi cut 0 Figure 7 Phi cut 30 Figure 8 Phi cut 90 Figure 9 Phi cut 135 8 Background color Changing the background color is not only a setting to increase the aesthetic of the picture it can also be used to increase the visiblility of the drawn data 8 1 Change background color To toggle the background color choose a color from the pop up menu under Background color or press b to change the color from blue to black over gray to white glced bgcolor OXXXXXXX X stands for a number from 0 till F For some examples see Figure 14 Figure 10 Background color darkgray Figure 11 Background color green Figure 12 Background color blue Figure 13 Background color black 9 Graphical options There are a lot of options to customize the look of CED 9 1 Differences between classic and new view To toggle between classic and new view chose Graphics options Classic view or Graphics options New view from the pop up menu There are two graphical settings which are affected by this option Classic view New view Detector EE it transparency perspective 3D 9 2 Perspective setting To turn the perspective on or off select Graphics options Graphic details Perspective from pop up menu Perspectiv
6. different viewers available in ilcsoft CEDViewer DST Viewer Generic Viewer and Vertex Viewer The difference between these viewers is how the event gets drawn The detector geometry does not depend on with viewer is used A sample viewer configuration section could be lt execute gt lt processor name MyGenericViewer gt lt execute gt lt processor name MyGenericViewer type GenericViewer gt lt Sim Calo Hit Collection Names gt lt parameter name SimCaloHitCollections type StringVec lcioInType SimCalorimeterHit gt BeamCalCollection EcalBarrelCollection EcalBarrelPreShowerCollection EcalEndcapCollection EcalEndcapPreShowerCollection EcalEndcapRingCollection FcalEndcapRingPreShowerCollection HcalBarrelRegCollection HcalEndCapRingsCollection HcalEndCapsCollection LHcalCollection LumiCalCollection MuonEndCapCollection lt parameter gt lt Sim Tracker Hit Collection Names gt lt parameter name SimTrackerHitCollections type StringVec lcioInType SimTrackerHit gt ETDCollection FTDCollection SETCollection SITCollection TPCCollection TPCSpacePointCollection VXDCollection lt parameter gt 14 lt Layer for Sim Calo Hits gt lt parameter name LayerSimCaloHit type int value 5 gt lt Layer for Sim Tracker Hits gt lt parameter name LayerSimTrackerHit type int value 6 gt lt processor gt A viewer is used from Marlin as a library and to specify the style co
7. e on means that objects which are further away from the viewer appear smaller Perspective off means all objects have the same size however far away they are OxFOCOCO Figure 14 Some HTML color codes Figure 15 New view Figure 16 Classic view 9 3 Transparency or mesh view To change the way the detector is drawn select Graphics options Graphic details Transparency mesh from pop up menu 9 4 Visibility of coordinate axes Per default at x 0 y 0 z 0 three arrows are drawn standing for the three axes to turn this off select Graphics options Graphic details Toggle visible of axes from pop up menu 9 5 Transparency value While not in mesh view it is possible to change the value of detector trans parency by selecting Graphics options Transparency value percent of transparency from pop up menu Possible values are 0 40 60 70 80 90 95 and 100 10 Figure 17 Transparency 0 Figure 18 Transparency 60 Figure 19 Transparency 90 Figure 20 Transparency 100 9 6 Frames per seconds To measure the performance of CED there is a build in function called FPS Frames per seconds Normally CED only renders a new image after changes such as toggleing the visibility of a layer or changing the view In contrast in FPS mode CED renders so many images as possible and prints out how many images there were rendered
8. go command All possible options are available from the menu at the top Additional you are able to use shortcuts see appendix You are also able to change objects by the popup menu by clicking with the right mouse button at one object 2 1 menu All CED options are accessible from the main menu Splitted into seven sub menus e Layers Toggle the visable of data or detector layers e Transparency Change the transparency of the detector components e Camera Change the possition of view reset view or selecting projections e Cuts Different cuts of the detector e Graphic Graphic options You can also save your prefered settings here e Tools Additional functions like making high resolution screenshots e Help Getting help 2 2 Pop up menu Right click on any object displayed in CED open the popup menu This menu allows you to configure or select the selected object For example to change the color of the background simply click on it and change a different one 3 Save settings You are able to save your favorite settings and switch between the saved ones The settings are stored under glced_cfg The save function store the current background color view transparency cuts layers visibility etc But the current event or other Marlin settings is not saved because these depend on the Marlin steering file and not on CED The config file is human readable but it is not recommended to change the settings by hand
9. in the last second This is a good way to compare the performance of CED in different circumstances for instance different ver sions different viewers or different machines Notice This function is disabled under Mac OSX 11 10 Picking 10 1 Quickstart Simply double click on the object in which you are interested in Marlin will print out information about the selected object MESSAGE MyCEDViewer 4747 4816 4883 4951 5020 5089 5155 MESSAGE My 5221 5287 5353 5422 5488 5553 5618 MESSAGE My 5683 5749 5814 5879 5944 22737 22738 MESSAGE M 4956 5025 5094 5160 5226 5292 5358 MESSAGE M Viewer 5426 5492 5557 5622 5686 5751 5816 MESSAGE MyCED er 5881 5946 6010 MESSAGE MyCEDV er adius o e su MESSAGE MyCEDViewer 6 0 76 0 6 0 0 93 0 MESSAGE My er SimCalorimeterHit MESSAGE MyCEDViewer MESSAGE My MESSAGE M H MESSAGE M Viewer Ener GeV 2 07559e 05 MESSAGE M V er z not verifie 145 491 3125 5 MESSAGE My V er ontr 1 MESSAGE My Vv er article Nu r 0 MESSAGE MyCEDViewer rim PDG 211 MESSAGE MyCEDViewer nergy GeV 2 07559e 05 ime 33 3181 Oxb Oxbe 154 13 1524 63 260 191 0 28 9829 13 not verified 154 13 1524 63 260 1910 0 ic ic 1 70529e 05 42 2045 2451 5 1568 71 1 Oo 2212 1 70529e 05 51 776 MESSAGE MyCEDVie
10. lor and layer of things which get drawn into CED Examples of different viewers are shown in Figure 23 26 Figure 23 CEDViewer Figure 24 DSTViewer Figure 25 Generic Viewer Figure 26 User defined 15 MarlinUtil MarlinCED MarlinUtil MarlinCED is a library used by Marlin which provides the functions to draw data into CED This function simply calls the ced draw functions It also provides the client part of picking which means the mapping between LCIO objects and LCIO ID and calling the output function of the selected object For details of the picking part see chapter 10 2 15 16 Shortcuts Shortcut Option Shorteat Option Toggle layer 0 Toggle background color Toggle layer 1 Toggle help frame Toggle layer 2 Reset view settings Toggle layer 3 Front view Toggle layer 4 Front view projection Toggle layer 5 Side view Toggle layer 6 Side view projection Toggle layer 7 Center object at mouseover Toggle layer 8 Toggle fisheye view Toggle layer 9 Toggle the visible of all data layers Toggle layer 10 Toggle layer 11 Toggle layer 12 Toggle layer 13 Toggle layer 14 Toggle layer 15 Toggle layer 16 Toggle layer 17 Toggle layer 18 Toggle layer 19 Toggle layer 20 Toggle layer 21 Toggle layer 22 Toggle layer 23 Toggle layer 24 0 1 2 3 4 5 6 l 8 9 if 70 Or ee Sey epee Oe Se 16
11. on turns the view into side view and transforms all data hits tracks etc so that the dis tance from the beamline to the object are the same as in 3D mode Yoroj V ae y Zproj Y The detector is cut at 0 to enable a view into it The ability to rotate will be disabled To exit this projection and get back to the previous view choose the side view projection mode again or press S 5 2 Front view projection To enable front view projection press capital F or choose it from the pop up menu under View Toggle front view projection This projection turns the view into front view and transforms all data hits tracks etc Zproj 0 The perspective is turned off and the detector is cut at z 0 to enable a view into the detector The ability to rotate is disabled To exit this projection press F or choose the front view projection mode again Figure 2 Side view projection Figure 3 Front view projection 5 3 Fisheye view This projection enlarges the inner region of the detector to give a clearer view to the inner tracks and hits of the event To enable fisheye press v or select it from the pop up menu under View Toggle fisheye projection To turn this projection off press v or select it from the pop up menu again The fisheye projection is usable together with the front or side view projection Figure 4 Fisheye projection 6 Layer With CED it is possible to d
12. raw different data on different layers This allows to show or hide specific types of data while working with CED Both data and detector components are placed on layers CED supports 100 different layers but you are only able to toggle the visibility of the first 25 data layers and the first 20 detector layers at runtime 6 1 Data Layer To show which data is actually on which layer open the overlaying help by pressing h or choose Data layers from the pop up menu To toggle the visi bility of data layers quickly there are shortcuts for the first 25 data layers See section Shortcuts It is possible to turn all data layers simultaneously on or off by selecting Data layers Show Hide all data layers or by pressing 6 2 Detector components Also detector components can lie on layers To toggle the visibility of detector components choose the corresponding component from Detector layers in the pop up menu It is possible to turn all components simultaneously on off by selecting Detector components Show Hide all detector components Figure 5 Detector components Some detector layers are turned off 7 Cuts In CED it is possible to cut a given range of phi out of the detector or cut data and detector at a specific z axes value 7 1 Longitudinal cuts To cut down the detector in length press and hold capital Z to enlarge the detector back press and hold z 7 2 Phi cuts To
13. ut streams It is possible to print LCIO objects in a short or long style The long form 12 Vertex vertex Vertex YourLCIOVertex0bjekt cout lt lt vertex The short form Vertex vertex Vertex YourLCIOVertex0bjekt cout lt lt 1c short vertex The short form allows to print objects as tables Vertex vertexi Vertex YourLCIOVertex0bjekt1 Vertex vertex2 Vertex YourLCIOVertex0bjekt2 cout lt lt header vertex lt lt tail vertex lt lt lcshort vertex1 lt lt lcshort vertex2 lt lt tail vertex Or cout lt lt header EVENT Vertex lt lt tail EVENT Vertex lt lt lcshort vertex1 lt lt lcshort vertex2 lt lt tail EVENT Vertex This method of printing is available for the following LCIO types MCParticle TrackerHit Sim TrackerHit CalorimeterHit SimCalorimeterHit Reconstruct edParticle Track and Cluster 11 Work with CED from remote For a smooth and quick workflow it is always recommended to start CED on the local computer How to connect which Marlin from a remote computer to your local running CED will be described hereafter To allow incoming remote connections CED must be started with the option trust The arguments of this option are a hostname or IP address 0n the local computer glced trust lt the name of the remote host gt On the computer on which you will start Marlin you need to tell Marlin where to connect to by setting the
14. wer tc Figure 21 CED window Figure 22 Terminal where Marlin runs 10 2 Install your own print function First the following code has to be inserted into the processEvent function of the viewer if you use your own viewer CEDPickingHandler amp pHandler CEDPickingHandler getInstance pHandler update evt The purpose of this code is that the singleton class CEDPickingHandler knows all objects of the event and therefore assigns a print function for every object There are predefined default output functions which can be overwrit ten by the user To use your own output functions it is necessary to register them before calling the update function That can be done by calling the reg ister function The first argument is a collection name or type and the second argument is a pointer to the print function Example CEDPickingHandler amp pHandler CEDPickingHandler getInstance pHandler registerFunction LCIO MCPARTICLE amp MyMCParticlePrintFunction more printfunctions for other types pHandler update evt Note For a proper use of picking it is essential that the IDs of every object drawn in CED are communicated to CED This is done by using the functions ced_line_ID instead of ced_line and ced_hit_ID instead of ced_hit Within the project print functions have been designed for a number of LCIO objects The work of Jan Engels served as a basic principle This allows to send LCIO objects directly to outp
Download Pdf Manuals
Related Search