HPS-MC
FilterBunches Class Reference

Space MC events and apply energy filters to process before readout. More...

Inheritance diagram for FilterBunches:
JavaTool Component

Public Member Functions

def __init__ (self, **kwargs)
 
def config (self, parser)
 Configure FilterBunches component. More...
 
def cmd_args (self)
 Setup command arguments. More...
 
def optional_parameters (self)
 Return list of optional parameters. More...
 
def required_config (self)
 Return list of required config. More...
 
- Public Member Functions inherited from JavaTool
def __init__ (self, name, java_class, **kwargs)
 
- 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

 filter_no_cuts
 By default cuts are on. More...
 
 filter_ecal_pairs
 
 filter_ecal_hit_ecut
 No default ecal hit cut energy (negative val to be ignored) More...
 
 filter_event_interval
 Default event filtering interval. More...
 
 filter_nevents_read
 Default is no maximum nevents to read. More...
 
 filter_nevents_write
 Default is no maximum nevents to write. More...
 
 hps_java_bin_jar
 
- 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

Space MC events and apply energy filters to process before readout.

Optional parameters are: filter_ecal_hit_ecut, filter_event_interval, filter_nevents_read, filter_nevents_write, filter_no_cuts
Required config are: hps_java_bin_jar

Definition at line 1048 of file tools.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
**  kwargs 
)

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

◆ config()

def config (   self,
  parser 
)

Configure FilterBunches component.

Reimplemented from JavaTool.

Definition at line 1102 of file tools.py.

◆ optional_parameters()

def optional_parameters (   self)

Return list of optional parameters.

Optional parameters are: filter_ecal_hit_ecut, filter_event_interval, filter_nevents_read, filter_nevents_write, filter_no_cuts

Returns
list of optional parameters

Reimplemented from Component.

Definition at line 1136 of file tools.py.

◆ required_config()

def required_config (   self)

Return list of required config.

Required config are: hps_java_bin_jar

Returns
list of required config

Reimplemented from JavaTool.

Definition at line 1150 of file tools.py.

Member Data Documentation

◆ filter_ecal_hit_ecut

filter_ecal_hit_ecut

No default ecal hit cut energy (negative val to be ignored)

Definition at line 1070 of file tools.py.

◆ filter_ecal_pairs

filter_ecal_pairs

Definition at line 1065 of file tools.py.

◆ filter_event_interval

filter_event_interval

Default event filtering interval.

Definition at line 1077 of file tools.py.

◆ filter_nevents_read

filter_nevents_read

Default is no maximum nevents to read.

Definition at line 1083 of file tools.py.

◆ filter_nevents_write

filter_nevents_write

Default is no maximum nevents to write.

Definition at line 1089 of file tools.py.

◆ filter_no_cuts

filter_no_cuts

By default cuts are on.

Definition at line 1059 of file tools.py.

◆ hps_java_bin_jar

hps_java_bin_jar

Definition at line 1094 of file tools.py.


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