Skip to content

Commit

Permalink
more doc for the gui
Browse files Browse the repository at this point in the history
  • Loading branch information
davidsanchez committed Feb 14, 2014
1 parent d412461 commit 750c10f
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 19 deletions.
1 change: 0 additions & 1 deletion bin/enrico_sed
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ except:
print('Usage: '+sys.argv[0]+' <config file name>')
sys.exit(1)

print len(sys.argv)
if len(sys.argv)==2 :
#read an config file alone. If not working, try to read an ascii file with different conf file
try :
Expand Down
78 changes: 62 additions & 16 deletions doc/source/gui.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,82 +3,128 @@
Graphical User Interface (GUI)
========================

detailed documentation to come
This page describe the windows of the `enrico` GUI. To run the GUI, type

.. code-block:: bash
enrico_'gui' Configuration.conf
The GUI aims to allow easy configuration file management and to run tools. Each page, arranged in tabs, roughly correspond to a section of the configuration file (see :ref:`configfile`). At the bottom of the GUI are buttons to save the configuration file and close the GUI. The convention is such that a crossed box stand for a `yes` in the configuration file.

Main page
-------------

The first page is the Main page of the GUI. Here the main options can be defined and tools can be run using the buttons (run a tool save the configuration file on disk).

.. figure:: _static/GuiMain.png
:align: center

Main page of the GUI

Files page
-------------

The second page manage the files definition (event, FT2 and xml) as well as the tag of your analysis.


.. figure:: _static/GuiFile.png
:align: center

File page of the GUI
Target/Space page
-------------

The target (name, position and spectral model) is defined is this page (first frame). The second frame defined the ROI (center (Xref, Yref), size). The `sync` button update the value Xref and Yref with the target position. It is then possible to have a ROI not centered on the target. The projection type and coordinate system is defined here also.

.. figure:: _static/GuiTargetSpace.png
:align: center

Target and Space pages of the GUI
Analysis page
-------------

The analysis tab deal with the analysis chain (binned or unbinned), some cuts (zenith angle (zmax), filter for the GTI definition). The IRFs are also defined here.

The fitting algorithm (MINUIT, NEWMINUIT, etc) and the tolerance are setup here.

.. figure:: _static/GuiAnalysis.png
:align: center

Analysis page of the GUI

Energy/Time page
-------------

This page define the energy and time ranges.

.. figure:: _static/GuiET.png
:align: center

Energy and Time page of the GUI

Spectrum/Ebin page
-------------

This page is used to manage the spectrum and energy bins generation as in the configuration file. The buttons `Re-run Ebin` can be used to only rerun the bin (by running as many jobs as the number of bin)


.. figure:: _static/GuiEbin.png
:align: center

Spectrum page of the GUI

Upper Limits page
-------------

This page allows the definition of the UL computation parameters : assumed index, minimal TS and confidence level

.. figure:: _static/GuiUL.png
:align: center

Upper limits page of the GUI

.. figure:: _static/GuiLC.png
:align: center

Light curves page of the GUI
Light Curves page
-------------

The light Curves are setup here.

.. figure:: _static/GuiLC.png
:align: center

Light curves page of the GUI


Aperture/FoldedLC page
-------------

The first frame of the page is for the aperture LC and the second for the Folded LC.

.. figure:: _static/GuiAppLC.png
:align: center

Aperture and Folded Light curves page of the GUI

TS Map page
-------------

TS Map parameters are managed here

.. figure:: _static/GuiTSMap.png
:align: center

TS Map page of the GUI

Findsrc page
-------------


The findsrc tool parameters are managed here

.. figure:: _static/GuiFindSRC.png
:align: center

Find source page of the GUI
Plots page
-------------

This page allow to draw the produced plots. Using the buttons, you have access to

* the SED and corresponding debug plots
* the LC and corresponding debug plots

If the plot has not been produced, Enrico Fermi picture is display.

.. figure:: _static/Guiplot.png
:align: center

plot page of the GUI

11 changes: 9 additions & 2 deletions enrico/gui.py
Original file line number Diff line number Diff line change
Expand Up @@ -850,8 +850,8 @@ def _addLC(self):
# BNPage.attach(frame, 0, 8, 0, 4)

def _addAppFoldedLC(self):
BNPage = self.AddBlocNotePage("Apperture/Folded LC")
frameapp,tableapp = self._addFrame("Apperture photometry options",2,4)
BNPage = self.AddBlocNotePage("Aperture/Folded LC")
frameapp,tableapp = self._addFrame("Aperture photometry options",2,4)
BNPage.attach(frameapp, 0, 8, 0, 4)

FitButton = gtk.CheckButton("")
Expand Down Expand Up @@ -1038,6 +1038,13 @@ def __init__(self,infile):
config['out'] = os.getcwd()
self.config = get_config(config)

try :
ftmp=open(self.config['file']['xml'],'r')
ftmp.close()
except :
os.system('touch '+self.config['file']['xml'])


window = gtk.Window(gtk.WINDOW_TOPLEVEL)
window.connect("delete_event", self.delete)
window.set_border_width(10)
Expand Down

0 comments on commit 750c10f

Please sign in to comment.