ApplyPedeRes Class Reference

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

Inheritance diagram for ApplyPedeRes:

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

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

def __init__

(

self

)

Definition at line 224 of file _apply.py.

Member Function Documentation

cmd_line_str()

def cmd_line_str

(

self

)

Reimplemented from Component.

Definition at line 237 of file _apply.py.

execute()

def execute	(		self,
			log_out,
			log_err
	)

Generic component execution method.

   Individual components may override this if specific behavior is required.

   @param log_out  name of log file for output
   @param log_err  name of log file for error
   @return error code

Reimplemented from Component.

Definition at line 240 of file _apply.py.

optional_parameters()

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

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:

• python/hpsmc/alignment/_apply.py