HPS-MC
MergePoisson Class Reference

Merge StdHep files, applying poisson sampling. More...

Inheritance diagram for MergePoisson:
StdHepTool Component

Public Member Functions

def __init__ (self, xsec=0, **kwargs)
 
def setup (self)
 Setup MergePoisson component. More...
 
def required_parameters (self)
 Return list of required parameters. More...
 
def cmd_args (self)
 Setup command arguments. More...
 
def execute (self, log_out, log_err)
 Execute MergePoisson component. 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 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 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 config (self, parser)
 Automatic configuration. More...
 
def set_parameters (self, params)
 Set class attributes for the component based on JSON parameters. More...
 
def optional_parameters (self)
 Return a list of optional parameters. More...
 
def required_config (self)
 Return a list of required configuration settings. 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

 xsec
 cross section in pb More...
 
 target_thickness
 target thickness in cm More...
 
 num_electrons
 number of electrons per bunch More...
 
 mu
 
- Public Attributes inherited from Component
 name
 
 command
 
 nevents
 
 seed
 
 inputs
 
 outputs
 
 append_tok
 
 output_ext
 
 ignore_job_params
 
 hpsmc_dir
 
 logger
 

Additional Inherited Members

- Static Public Attributes inherited from StdHepTool
list seed_names
 List of commands which accept a 'seed' argument. More...
 

Detailed Description

Merge StdHep files, applying poisson sampling.

Required parameters are: target_thickness, num_electrons

Definition at line 769 of file tools.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  xsec = 0,
**  kwargs 
)

Reimplemented from StdHepTool.

Definition at line 776 of file tools.py.

Member Function Documentation

◆ cmd_args()

def cmd_args (   self)

Setup command arguments.

Returns
list of arguments

Reimplemented from StdHepTool.

Definition at line 806 of file tools.py.

◆ execute()

def execute (   self,
  log_out,
  log_err 
)

Execute MergePoisson component.

Reimplemented from Component.

Definition at line 833 of file tools.py.

◆ required_parameters()

def required_parameters (   self)

Return list of required parameters.

Required parameters are: target_thickness, num_electrons

Returns
list of required parameters

Reimplemented from Component.

Definition at line 797 of file tools.py.

◆ setup()

def setup (   self)

Setup MergePoisson component.

Reimplemented from Component.

Definition at line 789 of file tools.py.

Member Data Documentation

◆ mu

mu

Definition at line 792 of file tools.py.

◆ num_electrons

num_electrons

number of electrons per bunch

Definition at line 782 of file tools.py.

◆ target_thickness

target_thickness

target thickness in cm

Definition at line 780 of file tools.py.

◆ xsec

xsec

cross section in pb

Definition at line 778 of file tools.py.


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