Changeset 14099 for fact/tools/pyscripts/doc

Timestamp:

06/07/12 10:53:41 (12 years ago)

Author:

neise

Message:

some more examples

File:

• fact/tools/pyscripts/doc/getting_started.rst (modified) (3 diffs)

fact/tools/pyscripts/doc/getting_started.rst

@@ -179 +179 @@
 ===============
 
+one may interactively play with the two most important classes *RawData* and
+*SlowData* from module pyfact... 
+
 *datafilepath* and *calibfilepath* should be adjusted in case you are not working
 on the ISDC cluster. 
@@ -184 +187 @@
 explore class RawData::
 
-  import pyfact
-  datafilepath = '/data00/fact-construction/raw/2012/03/04/20120304_018.fits.gz'
-  calibfilepath = '/data00/fact-construction/raw/2012/03/04/20120304_012.drs.fits.gz'
-  run = pyfact.RawData( datafilepath, calibfilepath, return_dict = True)
+  from pyfact import RawData
+  # or from pyfact import *
+  
+  datafilepath = '/fact/raw/2012/03/04/20120304_018.fits.gz'
+  calibfilepath = '/fact/raw/2012/03/04/20120304_012.drs.fits.gz'
+  run = RawData(datafilepath, calibfilepath)
   event = run.next()
   
@@ -198 +203 @@
     print 70*'*'
 
+for historical reasons, an event contains *data* and *acal_data*, where *acal_data*
+would be the DRS amplitude calibrated data, and *data* would be uncalibrated.
+But since the calibration was moved into a C++ class, for better performance,
+these keys now contains the same data.
+
 loop over RawData::
 
-  import pyfact
-  datafilepath = '/data00/fact-construction/raw/2012/03/04/20120304_018.fits.gz'
-  calibfilepath = '/data00/fact-construction/raw/2012/03/04/20120304_012.drs.fits.gz'
-  run = pyfact.RawData( datafilepath, calibfilepath, return_dict = True)
-  
+  from pyfact import RawData
+  # or from pyfact import *
+  
+  datafilepath = '/fact/raw/2012/03/04/20120304_018.fits.gz'
+  calibfilepath = '/fact/raw/2012/03/04/20120304_012.drs.fits.gz'
+  run = RawData(datafilepath, calibfilepath)
+
   for event in run:
     print 'event_id:', event['event_id'] 
-    # the data can be found in event['acal_data']
+    # the data can be found in event['data']
+
+have a look at some SlowData::
+
+  :~$ cd /fact/aux/2012/05/30
+  :/fact/aux/2012/05/30$ python
+  
+  from pyfact import SlowData
+  file = SlowData('20120530.FTM_CONTROL_TRIGGER_RATES.fits')
+  file.show()
+  
+
+have a look at the *columns*, that are available::
+
+  'columns': {'BoardRate': (40L, 4L, 'E', 'Hz'),
+             'ElapsedTime': (1L, 4L, 'E', 'sec'),
+             'FTMtimeStamp': (1L, 8L, 'K', 'us'),
+             'OnTime': (1L, 4L, 'E', 'sec'),
+             'OnTimeCounter': (1L, 8L, 'K', 'us'),
+             'PatchRate': (160L, 4L, 'E', 'Hz'),
+             'QoS': (1L, 4L, 'J', ''),
+             'Time': (1L, 8L, 'D', 'MJD'),
+             'TriggerCounter': (1L, 4L, 'J', 'int'),
+             'TriggerRate': (1L, 4L, 'E', 'Hz')},
+
+choose the *columns* you would like to retrieve from the file::
+
+  file.register('TriggerRate')
+  file.register('Time')
+  # or in case you are unsure
+  file.register('all')
+
+check, what happened. file has got some new members::
+
+  file.show()
+
+but they are all zero. Now one should call *next()* in order to get 
+the file contents row by row::
+
+  file.next()
+  file.show()
+
+or loop over the file::
+
+  counter = 0
+  for row in file::
+    if counter > 10:
+      break
+    
+    print row.Time, row. OnTime
+    counter += 1
+
 
 .. rubric:: Footnotes