HPS-MC
 
All Classes Namespaces Files Functions Variables Pages
Loading...
Searching...
No Matches
FilterBunches Class Reference

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

Inheritance diagram for FilterBunches:
JavaTool Component

Public Member Functions

 __init__ (self, **kwargs)
 
 config (self, parser)
 Configure FilterBunches component.
 
 cmd_args (self)
 Setup command arguments.
 
 optional_parameters (self)
 Return list of optional parameters.
 
 required_config (self)
 Return list of required config.
 
- 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

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

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 1113 of file tools.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self,
**  kwargs 
)

Reimplemented from JavaTool.

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

◆ config()

config (   self,
  parser 
)

Configure FilterBunches component.

Reimplemented from JavaTool.

Definition at line 1167 of file tools.py.

◆ optional_parameters()

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 1201 of file tools.py.

◆ required_config()

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 1215 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 1135 of file tools.py.

◆ filter_ecal_pairs

filter_ecal_pairs

Definition at line 1130 of file tools.py.

◆ filter_event_interval

filter_event_interval

Default event filtering interval.

Definition at line 1142 of file tools.py.

◆ filter_nevents_read

filter_nevents_read

Default is no maximum nevents to read.

Definition at line 1148 of file tools.py.

◆ filter_nevents_write

filter_nevents_write

Default is no maximum nevents to write.

Definition at line 1154 of file tools.py.

◆ filter_no_cuts

filter_no_cuts

By default cuts are on.

Definition at line 1124 of file tools.py.

◆ hps_java_bin_jar

hps_java_bin_jar

Definition at line 1159 of file tools.py.


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