HPS-MC
 
Loading...
Searching...
No Matches
MergePoisson Class Reference

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

Inheritance diagram for MergePoisson:
StdHepTool Component

Public Member Functions

 __init__ (self, xsec=0, **kwargs)
 
 setup (self)
 Setup MergePoisson component.
 
 required_parameters (self)
 Return list of required parameters.
 
 cmd_args (self)
 Setup command arguments.
 
 execute (self, log_out, log_err)
 Execute MergePoisson component.
 
- Public Member Functions inherited from Component
 cmd_line_str (self)
 
 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.
 
 cleanup (self)
 Perform post-job cleanup such as deleting temporary files.
 
 config_logging (self, parser)
 Configure the logging for a component.
 
 config (self, parser)
 Automatic configuration.
 
 set_parameters (self, params)
 Set class attributes for the component based on JSON parameters.
 
 optional_parameters (self)
 Return a list of optional parameters.
 
 required_config (self)
 Return a list of required configuration settings.
 
 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

 xsec
 cross section in pb
 
 target_thickness
 target thickness in cm
 
 num_electrons
 number of electrons per bunch
 
 mu
 
 seed
 
 nevents
 
- Public Attributes inherited from StdHepTool
 seed
 
- 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.
 
- 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

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

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

Reimplemented from StdHepTool.

Definition at line 776 of file tools.py.

Member Function Documentation

◆ cmd_args()

cmd_args (   self)

Setup command arguments.

Returns
list of arguments

Reimplemented from StdHepTool.

Definition at line 806 of file tools.py.

◆ execute()

execute (   self,
  log_out,
  log_err 
)

Execute MergePoisson component.

Reimplemented from Component.

Definition at line 833 of file tools.py.

◆ required_parameters()

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

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.

◆ nevents

nevents

Definition at line 815 of file tools.py.

◆ num_electrons

num_electrons

number of electrons per bunch

Definition at line 782 of file tools.py.

◆ seed

seed

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