HPS-MC
 
Loading...
Searching...
No Matches
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

 __init__ (self, steering=None, **kwargs)
 
 required_parameters (self)
 Return list of required parameters.
 
 optional_parameters (self)
 Return list of optional parameters.
 
 setup (self)
 Setup EvioToLcio component.
 
 cmd_args (self)
 Setup command arguments.
 
- Public Member Functions inherited from JavaTool
 required_config (self)
 Return list of required config.
 
 config (self, parser)
 Automatic configuration.
 
- Public Member Functions inherited from Component
 cmd_line_str (self)
 
 execute (self, log_out=sys.stdout, log_err=sys.stderr)
 Generic component execution method.
 
 cmd_exists (self)
 Check if the component's assigned command exists.
 
 cmd_args_str (self)
 Return list of arguments, making sure they are all converted to strings.
 
 cleanup (self)
 Perform post-job cleanup such as deleting temporary files.
 
 config_logging (self, parser)
 Configure the logging for a component.
 
 set_parameters (self, params)
 Set class attributes for the component based on JSON parameters.
 
 check_config (self)
 Raise an exception on the first missing config setting for this component.
 
 input_files (self)
 Get a list of input files for this component.
 
 output_files (self)
 Return a list of output files created by this component.
 
 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.
 

Public Attributes

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

Additional Inherited Members

- Protected Member Functions inherited from Component
 _inputs_to_outputs (self)
 This is the default method for automatically transforming input file names to outputs when output file names are not explicitly provided.
 

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__()

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

Reimplemented from JavaTool.

Definition at line 967 of file tools.py.

Member Function Documentation

◆ cmd_args()

cmd_args (   self)

Setup command arguments.

Returns
list of arguments

Reimplemented from JavaTool.

Definition at line 1010 of file tools.py.

◆ optional_parameters()

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()

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()

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.

◆ nevents

nevents

Definition at line 1035 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.

◆ steering_files

steering_files

Definition at line 1007 of file tools.py.


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