Difference between revisions of "RootSpy"

From GlueXWiki
Jump to: navigation, search
(Created page with "RootSpy is a system for the distributed viewing of ROOT histograms. *TODO* GUI: * save/load working set of histograms * specify graphics options at run time (using scripts?) *...")
 
m (Text replacement - "/halldweb1.jlab.org/" to "/halldweb.jlab.org/")
 
(26 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
RootSpy is a system for the distributed viewing of ROOT histograms.
 
RootSpy is a system for the distributed viewing of ROOT histograms.
  
*TODO*
+
===Details===
 +
 
 +
The RootSpy package provides two primary programs:
 +
* A GUI program (RootSpy) for the interactive viewing of histograms
 +
* A command line program (RSArchiver) that collects and archives the histograms for later analysis.
 +
 
 +
RSArchiver has several options (see the output of 'RSArchiver -h' below) that can be set either on the command line or in a configuration file.  A sample configuration file is included as 'dot-RSArchiver'.
 +
 
 +
<pre>
 +
ifarm1101> RSArchiver -h
 +
Usage:
 +
      RSArchiver [options]
 +
 
 +
Saves ROOT histograms being stored by programs running the RootSpy plugin.
 +
 
 +
Options:
 +
 
 +
  -h,--help                Print this message
 +
  -u,--udl udl              UDL of cMsg RootSpy server
 +
  -q,--daq-udl udl          UDL of cMsg CODA server
 +
  -s,--server server-name  Set RootSpy UDL to point to server IP/hostname
 +
  -S,--session-name name    Name of CODA session
 +
  -f,--force                Start program assuming run is already in progress
 +
  -p,--poll-delay time      Time (in seconds) to wait between polling seconds
 +
  -F,--output-file file    Name of ROOT file used to store output of the current run
 +
  -A,--archive-dir path    Directory used to store archived ROOT files
 +
  -P,--pdf-output          Enable output of summary PDF
 +
  -H,--html-output          Enable output of summary web pages
 +
  -R,--summary-dir path    Directory used to store summary files
 +
 
 +
</pre>
 +
 
 +
The RootSpy JANA plugin and a sample program are included in the DRootSpy package.
 +
 
 +
===Downloads===
 +
 
 +
RootSpy is distributed in the standard Hall D online software environment.
 +
 
 +
However, RootSpy can be used with any program that uses the ROOT libraries, and a standalone distribution is available for download below.
 +
 
 +
* [https://halldweb.jlab.org/wiki/images/5/5f/RootSpy-0.0.2.tar.gz RootSpy 0.0.2]
 +
 
 +
===Screenshots===
 +
 
 +
[[File:RS-2014-01-15-1.png|270x232px]]
 +
 
 +
===TODO===
  
 
GUI:
 
GUI:
  
* save/load working set of histograms
+
* <s>Fix statistics box display</s>
* specify graphics options at run time (using scripts?)
+
* Optimize display
* run certain scripts (e.g. fits) on histograms and display/save output
+
* <s>Different y-axes for current/archived overlaid hists</s>
* run scripts
+
* <s>Add button for moving to previous histogram</s>
 +
* <s>Save/load working set of histograms</s> - fixes needed to Select Hists dialog?
 +
* Specify display options at run time (maybe using ROOT scripts?)
 +
* <s>Run certain scripts (e.g. fits) on histograms and display/save output</s>
  
* revamp interface
+
* <s>Revamp interface</s> - keyboard shortcuts
* multiple histogram viewing?
+
* Display archived 2D histos side-by-side
 +
* Displaying multiple histogram at once
 +
* Add more display settings (dialogue to set them), e.g. where/if should we normalize, log vs. linear y axis...
  
 
Archiver:
 
Archiver:
  
* save TTrees
+
* Implement "final histogram" mechanism with JANA plugin
* output image files to web
+
* <s>Output image files to web</s>
* PDF summary output
+
* <s>PDF summary output</s>
 +
* <s>Add configuration file</s>
 +
* Save TTrees?

Latest revision as of 17:22, 31 March 2015

RootSpy is a system for the distributed viewing of ROOT histograms.

Details

The RootSpy package provides two primary programs:

  • A GUI program (RootSpy) for the interactive viewing of histograms
  • A command line program (RSArchiver) that collects and archives the histograms for later analysis.

RSArchiver has several options (see the output of 'RSArchiver -h' below) that can be set either on the command line or in a configuration file. A sample configuration file is included as 'dot-RSArchiver'.

ifarm1101> RSArchiver -h
Usage:
       RSArchiver [options]

Saves ROOT histograms being stored by programs running the RootSpy plugin.

Options:

   -h,--help                 Print this message
   -u,--udl udl              UDL of cMsg RootSpy server
   -q,--daq-udl udl          UDL of cMsg CODA server
   -s,--server server-name   Set RootSpy UDL to point to server IP/hostname
   -S,--session-name name    Name of CODA session
   -f,--force                Start program assuming run is already in progress
   -p,--poll-delay time      Time (in seconds) to wait between polling seconds
   -F,--output-file file     Name of ROOT file used to store output of the current run
   -A,--archive-dir path     Directory used to store archived ROOT files
   -P,--pdf-output           Enable output of summary PDF
   -H,--html-output          Enable output of summary web pages
   -R,--summary-dir path     Directory used to store summary files

The RootSpy JANA plugin and a sample program are included in the DRootSpy package.

Downloads

RootSpy is distributed in the standard Hall D online software environment.

However, RootSpy can be used with any program that uses the ROOT libraries, and a standalone distribution is available for download below.

Screenshots

RS-2014-01-15-1.png

TODO

GUI:

  • Fix statistics box display
  • Optimize display
  • Different y-axes for current/archived overlaid hists
  • Add button for moving to previous histogram
  • Save/load working set of histograms - fixes needed to Select Hists dialog?
  • Specify display options at run time (maybe using ROOT scripts?)
  • Run certain scripts (e.g. fits) on histograms and display/save output
  • Revamp interface - keyboard shortcuts
  • Display archived 2D histos side-by-side
  • Displaying multiple histogram at once
  • Add more display settings (dialogue to set them), e.g. where/if should we normalize, log vs. linear y axis...

Archiver:

  • Implement "final histogram" mechanism with JANA plugin
  • Output image files to web
  • PDF summary output
  • Add configuration file
  • Save TTrees?