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

Randomly sample StdHep events into a new file. More...

Inheritance diagram for RandomSample:
StdHepTool Component

Public Member Functions

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

 mu
 median of distribution?
 
 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

Randomly sample StdHep events into a new file.

Optional parameters are: nevents, mu

Definition at line 589 of file tools.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self,
**  kwargs 
)

Reimplemented from StdHepTool.

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

◆ execute()

execute (   self,
  log_out,
  log_err 
)

Execute RandomSample component.

Reimplemented from Component.

Definition at line 647 of file tools.py.

◆ optional_parameters()

optional_parameters (   self)

Return list of optional parameters.

Optional parameters are: nevents, mu

Returns
list of optional parameters

Reimplemented from Component.

Definition at line 638 of file tools.py.

Member Data Documentation

◆ mu

mu

median of distribution?

Definition at line 602 of file tools.py.

◆ nevents

nevents

Definition at line 617 of file tools.py.

◆ seed

seed

Definition at line 612 of file tools.py.


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