AraDisplay Class Reference
Part of AraDisplay library. AraDisplay based on the Marvellous ANITA Graphical Interface and Class Display (Magic Display). More...
#include <AraDisplay.h>
Public Member Functions | |
| void | applyCut (char *cutString) |
| Applies a cut to the head tree. | |
| AraDisplay () | |
| Default constructor. | |
| AraDisplay (char *eventFile, AraCalType::AraCalType_t calType=AraCalType::kVoltageTime) | |
| AraDisplay (char *baseDir, unsigned int time, AraCalType::AraCalType_t calType=AraCalType::kVoltageTime) | |
| The assignment constructor. Most AraDisplay sessions start with a call to this. | |
| void | closeCurrentFile () |
| Closes all currently opened TFiles, in preparation for changing to a new File. | |
| int | displayFirstEvent () |
| Displays the first event in the file, normally called by pressing the "First" button. | |
| int | displayLastEvent () |
| Displays the last event in the file, normally called by pressing the "Last" button. | |
| int | displayNextEvent () |
| Displays the next event in the file, normally called by pressing the "Next" button. | |
| int | displayPreviousEvent () |
| Displays the previous event in the file, normally called by pressing the "Previous" button. | |
| int | displayThisEvent (UInt_t eventNumber) |
| Displays a specified event number. This is an increddibly useful and well hidden function. From the ROOT prompt you can call this by AraDisplay::Instance()->displayThisEvent(10001,3000);. | |
| void | drawEventButtons () |
| Worker function to draw the buttons on the main event display canvas. | |
| UInt_t | getCurrentEvent () |
| Returns the current event number. | |
| Int_t | getCurrentFileTime () |
| Returns the current file time. | |
| int | getEventEntry () |
| Tries to retrieve the event corresponding to entry fEventEntry from the evnt file. Returns zero on success. | |
| int | loadEventTree (char *eventFile=0) |
| Loads the event tree corresponding to fCurrentFileTime. | |
| void | refreshEventDisplay () |
| Refresh the event display and redraw the graphs, this is called everytime a new event is displayed. | |
| void | setCanvasLayout (AraDisplayCanvasLayoutOption::AraDisplayCanvasLayoutOption_t option) |
| void | setCorrelatorType (AraCorrelatorType::AraCorrelatorType_t corType) |
| void | setNumAntsInMap (int numAnts) |
| void | setWaveformFormat (AraDisplayFormatOption::AraDisplayFormatOption_t waveformView) |
| Toggles between waveform and FFT view modes. | |
| void | startControlPanel () |
| Starts the (currently highly buggy) control panel. | |
| void | startEventDisplay () |
| void | startEventPlaying () |
| Starts event playback mode, normally called by pressing the "Play" button the display. | |
| void | startEventPlayingReverse () |
| Starts the event playback in reverse mode, normally called by pressing the "Rev" button on the main display. | |
| void | stopEventPlaying () |
| Stops the event playback, normally called by pressing the "Stop" button on the main display. | |
| ~AraDisplay () | |
| Destructor. | |
Static Public Member Functions | |
| static AraDisplay * | Instance () |
| Returns a pointer to the active AraDisplay. This is very useful if you want to access the TTree's directly or if you want to explicitly call one of the methods. | |
Public Attributes | |
| Char_t | fCurrentBaseDir [180] |
| The base directory for the ROOT files. | |
| UInt_t | fCurrentFileTime |
| The current file time. | |
| Long64_t | fEventCutListEntry |
| The current cut index. | |
| Long64_t | fEventEntry |
| The current event+header entry. | |
| TFile * | fEventFile |
| A pointer to the current event file. | |
| TTreeIndex * | fEventIndex |
| Reused. | |
| TChain * | fEventTree |
| A pointer to the current event tree. | |
| Long64_t | fEventTreeIndexEntry |
| The current entry in the TTreeIndex. | |
Static Protected Attributes | |
| static AraDisplay * | fgInstance = 0 |
| The pointer to the current AraDisplay. | |
Detailed Description
Part of AraDisplay library. AraDisplay based on the Marvellous ANITA Graphical Interface and Class Display (Magic Display).AraDisplay is the main class that controls the display. This class is responsible for opening files and reading trees and owns the various canvases and that sort of thing.
Typically one starts AraDisplay by giving the constructor the base directory that contains the runXXXX directories and the desired start run.
Most of the functions are called by pressig one of the buttons on the display. They can, of course, be called directly through AraDisplay::Instance()->functionName().
Definition at line 50 of file AraDisplay.h.
Constructor & Destructor Documentation
| AraDisplay::AraDisplay | ( | char * | baseDir, | |
| unsigned int | time, | |||
| AraCalType::AraCalType_t | calType = AraCalType::kVoltageTime | |||
| ) |
The assignment constructor. Most AraDisplay sessions start with a call to this.
- Parameters:
-
baseDir The directory that contains the runXXXX directories (that contain the ROOT files run The run number to start with calType The calibration option desired (see the event reader documentation for the different available calibration options)
Definition at line 225 of file AraDisplay.cxx.
Member Function Documentation
| int AraDisplay::displayThisEvent | ( | UInt_t | eventNumber | ) |
Displays a specified event number. This is an increddibly useful and well hidden function. From the ROOT prompt you can call this by AraDisplay::Instance()->displayThisEvent(10001,3000);.
- Parameters:
-
eventNumber The event number to display
- Returns:
- Zero on success
Definition at line 615 of file AraDisplay.cxx.
| AraDisplay * AraDisplay::Instance | ( | ) | [static] |
Returns a pointer to the active AraDisplay. This is very useful if you want to access the TTree's directly or if you want to explicitly call one of the methods.
- Returns:
- A pointer to the active AraDisplay.
Definition at line 252 of file AraDisplay.cxx.
| void AraDisplay::setWaveformFormat | ( | AraDisplayFormatOption::AraDisplayFormatOption_t | waveformView | ) |
Toggles between waveform and FFT view modes.
- Parameters:
-
waveformView See AraDisplayFormatOption for options.
Definition at line 769 of file AraDisplay.cxx.
| void AraDisplay::startEventDisplay | ( | ) |
Starts the main event display. This is typically the first thing that gets done after creating a AraDisplay object in the runAraDisplay macro.
Definition at line 268 of file AraDisplay.cxx.
The documentation for this class was generated from the following files:
- AraDisplay/AraDisplay.h
- AraDisplay/AraDisplay.cxx
Generated on Mon Mar 18 16:00:46 2013 for ARA ROOT v3.4 Software by
1.4.7