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

Apply a millepede.res file to a detector description. More...

Inheritance diagram for ApplyPedeRes:
_DetectorEditor Component

Public Member Functions

 __init__ (self)
 
 optional_parameters (self)
 Return a list of optional parameters.
 
 cmd_line_str (self)
 
 execute (self, log_out, log_err)
 Generic component execution method.
 
- Public Member Functions inherited from _DetectorEditor
 required_config (self)
 Return a list of required configuration settings.
 
 required_parameters (self)
 Return a list of required parameters.
 
- Public Member Functions inherited from Component
 cmd_exists (self)
 Check if the component's assigned command exists.
 
 cmd_args (self)
 Return the command arguments of this component.
 
 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.
 
 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

 res_file
 
 bump
 
 to_float
 
 detector
 
 next_detector
 
- Public Attributes inherited from _DetectorEditor
 java_dir
 
 detector
 
 next_detector
 
 force
 
- Public Attributes inherited from Component
 name
 
 command
 
 nevents
 
 seed
 
 inputs
 
 outputs
 
 append_tok
 
 output_ext
 
 ignore_job_params
 
 hpsmc_dir
 
 logger
 

Additional Inherited Members

- Protected Member Functions inherited from _DetectorEditor
 _detector_dir (self, det_name)
 
 _deduce_next_detector (self, bump=False)
 deduce what the next detector should be given how the component has been configured
 
 _to_compact (self, parameter_set, detname, save_prev=True, prev_ext='prev')
 write the input parameter set into the input compact.xml file
 
 _update_readme (self, detname, msg)
 Update the readme for the passed detector name.
 
- 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

Apply a millepede.res file to a detector description.

This job component loads a result file into memory and the goes line-by-line through a detector description, updating the lines with any parameters that have updated values in the result file.

Required Config:

[ApplyPedeRes]
java_dir = /full/path/to/hps-java

Required Parameters:

  • detector: name of detector to apply parameters to

Optional Parameters:

  • res\_file: path to millepede results file (default: 'millepede.res')
  • bump: generate the next detector name by incrementing the iter number of the input detector (default: True)
  • force: override the next detector path (default: False)
  • next\_detector: provide name of next detector, preferred over bump if provided (default: None)

Definition at line 200 of file _apply.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self)

Reimplemented from _DetectorEditor.

Definition at line 224 of file _apply.py.

Member Function Documentation

◆ cmd_line_str()

cmd_line_str (   self)

Reimplemented from Component.

Definition at line 237 of file _apply.py.

◆ execute()

execute (   self,
  log_out,
  log_err 
)

Generic component execution method.

Individual components may override this if specific behavior is required.

Parameters
log_outname of log file for output
log_errname of log file for error
Returns
error code

Reimplemented from Component.

Definition at line 240 of file _apply.py.

◆ optional_parameters()

optional_parameters (   self)

Return a list of optional parameters.

Optional parameters are: nevents, seed

Reimplemented from _DetectorEditor.

Definition at line 234 of file _apply.py.

Member Data Documentation

◆ bump

bump

Definition at line 227 of file _apply.py.

◆ detector

detector

Definition at line 256 of file _apply.py.

◆ next_detector

next_detector

Definition at line 259 of file _apply.py.

◆ res_file

res_file

Definition at line 226 of file _apply.py.

◆ to_float

to_float

Definition at line 230 of file _apply.py.


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