Changeset 14102

Timestamp:

06/07/12 11:03:02 (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

@@ -65 +65 @@
 
 
-4a. Create the needed *.so libs @ ISDC
+4. Create the needed *.so libs @ ISDC
 ======================================
 
@@ -87 +87 @@
   calfactfits_h.so  factfits_h.so  izstream_h.so
 
-4b. Create pyfits_h.so library 
-=============================
+5. Test if everything is running
+=================================
+
+Now you can check if the reading rawdata is working::
+
+  neise@isdc-viewer00:~/py/pyfact$ pyfact.py 
+  showing test of iterator of RawData class
+  in order to test the SlowData classe please use: ./pyfact.py fits-file-name
+  ev  1 data[0,0] =  -7.68806196438 start_cell[0] =  426 trigger type =  416
+  ev  2 data[0,0] =  0.792280672486 start_cell[0] =  437 trigger type =  416
+  ev  3 data[0,0] =  54.9490855517 start_cell[0] =  449 trigger type =  416
+  ev  4 data[0,0] =  3.9482592671 start_cell[0] =  461 trigger type =  416
+  ev  5 data[0,0] =  -66.4329317281 start_cell[0] =  474 trigger type =  416
+  ev  6 data[0,0] =  8.2917625181 start_cell[0] =  485 trigger type =  416
+  ev  7 data[0,0] =  -41.6565116079 start_cell[0] =  498 trigger type =  416
+  ev  8 data[0,0] =  33.4668984163 start_cell[0] =  509 trigger type =  416
+  ev  9 data[0,0] =  -28.520090549 start_cell[0] =  522 trigger type =  416
+  ev  10 data[0,0] =  -20.4925692795 start_cell[0] =  533 trigger type =  416
+
+This should work at ISDC only, but if it does not work, please ask somebody for help.
+
+6. Tiny examples
+===============
+
+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. 
+
+explore class RawData::
+
+  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()
+  
+  type(event)
+  
+  print 70*'*'
+  for key in event:
+    print 'key  :', key
+    print 'value:', event[key]
+    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::
+
+  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['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
+
+7. Old way of creating the so files
+===================================
 
 -----------This is a depricated section---------------
@@ -160 +276 @@
     pyfits.h  pyfits_h.d  pyfits_h.so
 
-Now you can check if the reading rawdata is working::
-
-  neise@isdc-viewer00:~/py/pyfact$ pyfact.py 
-  showing test of iterator of RawData class
-  in order to test the SlowData classe please use: ./pyfact.py fits-file-name
-  ev  1 data[0,0] =  -7.68806196438 start_cell[0] =  426 trigger type =  416
-  ev  2 data[0,0] =  0.792280672486 start_cell[0] =  437 trigger type =  416
-  ev  3 data[0,0] =  54.9490855517 start_cell[0] =  449 trigger type =  416
-  ev  4 data[0,0] =  3.9482592671 start_cell[0] =  461 trigger type =  416
-  ev  5 data[0,0] =  -66.4329317281 start_cell[0] =  474 trigger type =  416
-  ev  6 data[0,0] =  8.2917625181 start_cell[0] =  485 trigger type =  416
-  ev  7 data[0,0] =  -41.6565116079 start_cell[0] =  498 trigger type =  416
-  ev  8 data[0,0] =  33.4668984163 start_cell[0] =  509 trigger type =  416
-  ev  9 data[0,0] =  -28.520090549 start_cell[0] =  522 trigger type =  416
-  ev  10 data[0,0] =  -20.4925692795 start_cell[0] =  533 trigger type =  416
-
-
-5. Run examples
-===============
-
-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. 
-
-explore class RawData::
-
-  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()
-  
-  type(event)
-  
-  print 70*'*'
-  for key in event:
-    print 'key  :', key
-    print 'value:', event[key]
-    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::
-
-  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['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