HPS-MC
hadd Class Reference

Run ROOT's histogram/TTree merger. More...

Inheritance diagram for hadd:
Component

Public Member Functions

def __init__ (self, **kwargs)
 
def optional_parameters (self)
 Return a list of optional parameters. More...
 
def cmd_args (self)
 Return the command arguments of this 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 execute (self, log_out=sys.stdout, log_err=sys.stderr)
 Generic component execution method. More...
 
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 setup (self)
 Perform any necessary setup for this component to run such as making symlinks to required directories. 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 required_parameters (self)
 Return a list of required 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

 output_ext
 
 ncores
 
- Public Attributes inherited from Component
 name
 
 command
 
 nevents
 
 seed
 
 inputs
 
 outputs
 
 append_tok
 
 output_ext
 
 ignore_job_params
 
 hpsmc_dir
 
 logger
 

Static Public Attributes

 logger = logging.getLogger('hpsmc.tools.hadd')
 

Detailed Description

Run ROOT's histogram/TTree merger.

Required:

  • inputs: input ROOT files to merge
  • outputs: single output file to merge into Optional:
  • ncores: number of cores to supply to hadd (default 1)

Definition at line 11 of file _hadd.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
**  kwargs 
)

Definition at line 23 of file _hadd.py.

Member Function Documentation

◆ cmd_args()

def cmd_args (   self)

Return the command arguments of this component.

Reimplemented from Component.

Definition at line 31 of file _hadd.py.

◆ optional_parameters()

def optional_parameters (   self)

Return a list of optional parameters.

Optional parameters are: nevents, seed

Reimplemented from Component.

Definition at line 28 of file _hadd.py.

Member Data Documentation

◆ logger

logger = logging.getLogger('hpsmc.tools.hadd')
static

Definition at line 21 of file _hadd.py.

◆ ncores

ncores

Definition at line 25 of file _hadd.py.

◆ output_ext

output_ext

Definition at line 24 of file _hadd.py.


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