src::event_process::event_process Class Reference

Inheritance diagram for src::event_process::event_process:

src::acqiris::acqiris src::add_all_devices::add_all_devices src::add_available_data::add_available_data src::add_elog::add_elog src::build_html::build_html src::counter::counter src::cspad::cspad src::epics_scatter::epics_scatter src::epics_trend::epics_trend src::evr::evr src::ipimb::ipimb src::offbyone::offbyone src::simple_stats::simple_stats src::simple_trends::simple_trends src::store_report_results::store_report_results src::time_fiducials::time_fiducials List of all members.

Public Member Functions

def __init__
def set_parent
def output_dir
def output_dir
def beginJob
def beginRun
def event
def endRun
def endJob
def replicate_info
def describe_self
def reduce

Detailed Description

An empty event process in the new style.
See some working examples in event_process_lib.py
They all inherit form this.

Definition at line 8 of file event_process.py.


Member Function Documentation

def src::event_process::event_process::__init__ (   self  ) 

this will need to be overriden in a child class

Reimplemented in src::acqiris::acqiris, src::add_available_data::add_available_data, src::add_elog::add_elog, src::build_html::build_html, src::counter::counter, src::cspad::cspad, src::epics_scatter::epics_scatter, src::epics_trend::epics_trend, src::evr::evr, src::ipimb::ipimb, src::offbyone::offbyone, src::simple_trends::simple_trends, src::store_report_results::store_report_results, and src::time_fiducials::time_fiducials.

Definition at line 10 of file event_process.py.

def src::event_process::event_process::beginJob (   self  ) 

put setup tasks here

Reimplemented in src::cspad::cspad, src::epics_scatter::epics_scatter, src::epics_trend::epics_trend, src::evr::evr, src::ipimb::ipimb, src::simple_stats::simple_stats, src::simple_trends::simple_trends, and src::time_fiducials::time_fiducials.

Definition at line 50 of file event_process.py.

def src::event_process::event_process::beginRun (   self  ) 

put run specific setup tasks here

Reimplemented in src::ipimb::ipimb.

Definition at line 56 of file event_process.py.

def src::event_process::event_process::describe_self (   self  ) 

returns an object that can be used to create another identical (minus data)
instance of the current object

Definition at line 90 of file event_process.py.

def src::event_process::event_process::endJob (   self  ) 

put end of job tasks here
this is also an important task since it is performed after all events have
been processed, and where final analysis should be performed.  it's the "reduce" step,
and as such it needs to be programmed parallel-y

Reimplemented in src::acqiris::acqiris, src::add_available_data::add_available_data, src::add_elog::add_elog, src::build_html::build_html, src::counter::counter, src::cspad::cspad, src::epics_scatter::epics_scatter, src::epics_trend::epics_trend, src::ipimb::ipimb, src::offbyone::offbyone, src::simple_stats::simple_stats, src::simple_trends::simple_trends, and src::store_report_results::store_report_results.

Definition at line 75 of file event_process.py.

def src::event_process::event_process::endRun (   self  ) 

put end of run tasks here

Reimplemented in src::ipimb::ipimb.

Definition at line 69 of file event_process.py.

def src::event_process::event_process::event (   self,
  evt 
)

put the main even processing tasks here
this gets run on every single even in the data set

Reimplemented in src::acqiris::acqiris, src::add_all_devices::add_all_devices, src::add_available_data::add_available_data, src::counter::counter, src::cspad::cspad, src::epics_scatter::epics_scatter, src::epics_trend::epics_trend, src::evr::evr, src::ipimb::ipimb, src::offbyone::offbyone, src::simple_stats::simple_stats, src::simple_trends::simple_trends, and src::time_fiducials::time_fiducials.

Definition at line 62 of file event_process.py.

def src::event_process::event_process::output_dir (   self,
  val 
)

set a specific output directory instead of using the automatic one

Definition at line 39 of file event_process.py.

def src::event_process::event_process::output_dir (   self  ) 

set a unique output directory name (based on event process id and node rank)

Definition at line 27 of file event_process.py.

def src::event_process::event_process::reduce (   self,
  ranks,
  root = None,
  tag = None 
)

example of the philosophy necessary to carefully collect the data from
only the ranks the encountered the data.  this isn't encountered often
but it is possible.  there is probrably a better way to do it with mpi groups

Definition at line 99 of file event_process.py.

def src::event_process::event_process::replicate_info (   self  ) 

not used

Reimplemented in src::acqiris::acqiris, src::cspad::cspad, src::epics_scatter::epics_scatter, src::epics_trend::epics_trend, src::ipimb::ipimb, src::simple_stats::simple_stats, and src::simple_trends::simple_trends.

Definition at line 84 of file event_process.py.

def src::event_process::event_process::set_parent (   self,
  parent 
)

stores the parent name space for easy access by the subjob

Definition at line 20 of file event_process.py.


The documentation for this class was generated from the following file:
Generated on 19 Dec 2016 for PSDMSoftware by  doxygen 1.4.7