HPS-MC
EvioToLcio Class Reference

Convert EVIO events to LCIO using the hps-java EvioToLcio command line tool. More...

Inheritance diagram for EvioToLcio:
JavaTool Component

Public Member Functions

def __init__ (self, steering=None, **kwargs)
 
def required_parameters (self)
 Return list of required parameters. More...
 
def optional_parameters (self)
 Return list of optional parameters. More...
 
def setup (self)
 Setup EvioToLcio component. More...
 
def cmd_args (self)
 Setup command arguments. More...
 
- Public Member Functions inherited from JavaTool
def __init__ (self, name, java_class, **kwargs)
 
def required_config (self)
 Return list of required config. More...
 
def config (self, parser)
 Automatic configuration. More...
 
- Public Member Functions inherited from Component
def __init__ (self, name, command=None, nevents=None, seed=1, inputs=[], outputs=None, append_tok=None, output_ext=None, ignore_job_params=[], **kwargs)
 
def cmd_line_str (self)
 
def execute (self, log_out=sys.stdout, log_err=sys.stderr)
 Generic component execution method. More...
 
def cmd_exists (self)
 Check if the component's assigned command exists. More...
 
def cmd_args_str (self)
 Return list of arguments, making sure they are all converted to strings. More...
 
def cleanup (self)
 Perform post-job cleanup such as deleting temporary files. More...
 
def config_logging (self, parser)
 Configure the logging for a component. More...
 
def set_parameters (self, params)
 Set class attributes for the component based on JSON parameters. More...
 
def check_config (self)
 Raise an exception on the first missing config setting for this component. More...
 
def input_files (self)
 Get a list of input files for this component. More...
 
def output_files (self)
 Return a list of output files created by this component. More...
 
def config_from_environ (self)
 Configure component from environment variables which are just upper case versions of the required config names set in the shell environment. More...
 

Public Attributes

 detector
 detector name More...
 
 run_number
 run number More...
 
 skip_events
 number of events that are skipped More...
 
 event_print_interval
 event print interval More...
 
 steering
 steering file More...
 
 steering_file
 
- Public Attributes inherited from JavaTool
 java_class
 java class More...
 
 java_args
 java arguments More...
 
 conditions_url
 tbd More...
 
- Public Attributes inherited from Component
 name
 
 command
 
 nevents
 
 seed
 
 inputs
 
 outputs
 
 append_tok
 
 output_ext
 
 ignore_job_params
 
 hpsmc_dir
 
 logger
 

Detailed Description

Convert EVIO events to LCIO using the hps-java EvioToLcio command line tool.

Input files have evio format (format used by DAQ system).

Required parameters are: detector, steering_files
Optional parameters are: run_number, skip_events, nevents, event_print_interval

Definition at line 957 of file tools.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  steering = None,
**  kwargs 
)

Definition at line 967 of file tools.py.

Member Function Documentation

◆ cmd_args()

def cmd_args (   self)

Setup command arguments.

Returns
list of arguments

Reimplemented from JavaTool.

Definition at line 1010 of file tools.py.

◆ optional_parameters()

def optional_parameters (   self)

Return list of optional parameters.

Optional parameters are: run_number, skip_events, nevents, event_print_interval

Returns
list of optional parameters

Reimplemented from Component.

Definition at line 994 of file tools.py.

◆ required_parameters()

def required_parameters (   self)

Return list of required parameters.

Required parameters are: detector, steering_files

Returns
list of required parameters

Reimplemented from Component.

Definition at line 985 of file tools.py.

◆ setup()

def setup (   self)

Setup EvioToLcio component.

Reimplemented from Component.

Definition at line 1003 of file tools.py.

Member Data Documentation

◆ detector

detector

detector name

Definition at line 969 of file tools.py.

◆ event_print_interval

event_print_interval

event print interval

Definition at line 975 of file tools.py.

◆ run_number

run_number

run number

Definition at line 971 of file tools.py.

◆ skip_events

skip_events

number of events that are skipped

Definition at line 973 of file tools.py.

◆ steering

steering

steering file

Definition at line 977 of file tools.py.

◆ steering_file

steering_file

Definition at line 1008 of file tools.py.


The documentation for this class was generated from the following file: