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

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

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

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

__init__ (   self,
**  kwargs 
)

Reimplemented from JavaTool.

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

◆ optional_parameters()

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.

◆ nevents

nevents

Definition at line 1205 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: