HPS-MC
HPSTR Class Reference

Run the hpstr analysis tool. More...

Inheritance diagram for HPSTR:
Component

Public Member Functions

def __init__ (self, cfg=None, is_data=0, year=None, tracking=None, **kwargs)
 
def setup (self)
 Setup HPSTR component. More...
 
def required_parameters (self)
 Return list of required parameters. More...
 
def optional_parameters (self)
 Return list of optional parameters. More...
 
def required_config (self)
 Return list of required configs. More...
 
def cmd_args (self)
 Setup command arguments. More...
 
def output_files (self)
 Adjust names of output files. More...
 
def execute (self, log_out, log_err)
 Execute HPSTR 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 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 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

 cfg
 configuration More...
 
 is_data
 run mode More...
 
 year
 year More...
 
 tracking
 tracking option (KF, GBL, BOTH) More...
 
 hpstr_install_dir
 
 hpstr_base
 
 env_script
 
 cfg_path
 
 append_tok
 
- Public Attributes inherited from Component
 name
 
 command
 
 nevents
 
 seed
 
 inputs
 
 outputs
 
 append_tok
 
 output_ext
 
 ignore_job_params
 
 hpsmc_dir
 
 logger
 

Detailed Description

Run the hpstr analysis tool.

Required parameters are: config_files
Optional parameters are: year, is_data, nevents
Required configs are: hpstr_install_dir, hpstr_base

Definition at line 344 of file tools.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  cfg = None,
  is_data = 0,
  year = None,
  tracking = None,
**  kwargs 
)

Definition at line 353 of file tools.py.

Member Function Documentation

◆ cmd_args()

def cmd_args (   self)

Setup command arguments.

Returns
list of arguments

Reimplemented from Component.

Definition at line 425 of file tools.py.

◆ execute()

def execute (   self,
  log_out,
  log_err 
)

Execute HPSTR component.

Reimplemented from Component.

Definition at line 452 of file tools.py.

◆ optional_parameters()

def optional_parameters (   self)

Return list of optional parameters.

Optional parameters are: year, is_data, nevents

Returns
list of optional parameters

Reimplemented from Component.

Definition at line 407 of file tools.py.

◆ output_files()

def output_files (   self)

Adjust names of output files.

Reimplemented from Component.

Definition at line 442 of file tools.py.

◆ required_config()

def required_config (   self)

Return list of required configs.

Required configs are: hpstr_install_dir, hpstr_base

Returns
list of required configs

Reimplemented from Component.

Definition at line 416 of file tools.py.

◆ required_parameters()

def required_parameters (   self)

Return list of required parameters.

Required parameters are: config_files

Returns
list of required parameters

Reimplemented from Component.

Definition at line 398 of file tools.py.

◆ setup()

def setup (   self)

Setup HPSTR component.

Reimplemented from Component.

Definition at line 371 of file tools.py.

Member Data Documentation

◆ append_tok

append_tok

Definition at line 395 of file tools.py.

◆ cfg

cfg

configuration

Definition at line 355 of file tools.py.

◆ cfg_path

cfg_path

Definition at line 384 of file tools.py.

◆ env_script

env_script

Definition at line 375 of file tools.py.

◆ hpstr_base

hpstr_base

Definition at line 364 of file tools.py.

◆ hpstr_install_dir

hpstr_install_dir

Definition at line 363 of file tools.py.

◆ is_data

is_data

run mode

Definition at line 357 of file tools.py.

◆ tracking

tracking

tracking option (KF, GBL, BOTH)

Definition at line 361 of file tools.py.

◆ year

year

year

Definition at line 359 of file tools.py.


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