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

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

Inheritance diagram for hadd:
Component

Public Member Functions

 __init__ (self, **kwargs)
 
 optional_parameters (self)
 Return a list of optional parameters.
 
 cmd_args (self)
 Return the command arguments of this component.
 
- Public Member Functions inherited from Component
 cmd_line_str (self)
 
 execute (self, log_out=sys.stdout, log_err=sys.stderr)
 Generic component execution method.
 
 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

 output_ext
 
 ncores
 
 outputs
 
 inputs
 
- 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')
 

Additional Inherited Members

- 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

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

__init__ (   self,
**  kwargs 
)

Reimplemented from Component.

Definition at line 23 of file _hadd.py.

Member Function Documentation

◆ cmd_args()

cmd_args (   self)

Return the command arguments of this component.

Reimplemented from Component.

Definition at line 31 of file _hadd.py.

◆ optional_parameters()

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

◆ inputs

inputs

Definition at line 38 of file _hadd.py.

◆ 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.

◆ outputs

outputs

Definition at line 35 of file _hadd.py.


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