HPS-MC
ExtractEventsWithHitAtHodoEcal Class Reference

Apply hodo-hit filter and space MC events to process before readout. More...

Inheritance diagram for ExtractEventsWithHitAtHodoEcal:
JavaTool Component

Public Member Functions

def __init__ (self, **kwargs)
 
def cmd_args (self)
 Setup command arguments. More...
 
def optional_parameters (self)
 Return list of optional parameters. 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 setup (self)
 Perform any necessary setup for this component to run such as making symlinks to required directories. 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 required_parameters (self)
 Return a list of required 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

 num_hodo_hits
 
 event_interval
 
- 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

Apply hodo-hit filter and space MC events to process before readout.

The nevents parameter is not settable from JSON in this class. It should be supplied as an init argument in the job script if it needs to be customized (the default nevents and event_interval used to apply spacing should usually not need to be changed by the user).
Optional parameters are: num_hodo_hits, event_interval

Definition at line 1160 of file tools.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
**  kwargs 
)

Definition at line 1172 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 1189 of file tools.py.

◆ optional_parameters()

def optional_parameters (   self)

Return list of optional parameters.

Optional parameters are: num_hodo_hits, event_interval

Returns
list of optional parameters

Reimplemented from Component.

Definition at line 1208 of file tools.py.

Member Data Documentation

◆ event_interval

event_interval

Definition at line 1179 of file tools.py.

◆ num_hodo_hits

num_hodo_hits

Definition at line 1174 of file tools.py.


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