ConstructDetector Class Reference

construct an LCDD from a compact.xml and recompile necessary parts of hps-java More...

Inheritance diagram for ConstructDetector:

Public Member Functions
	__init__ (self)
	required_config (self)
	Return a list of required configuration settings.
	optional_parameters (self)
	Return a list of optional parameters.
	setup (self)
	cmd_args (self)
	Return the command arguments of this component.
Public Member Functions inherited from _DetectorEditor
	required_parameters (self)
	Return a list of required parameters.
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.
	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
	hps_java_bin_jar
	bump
	detector_to_construct
	next_detector
	java_dir
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

construct an LCDD from a compact.xml and recompile necessary parts of hps-java

This is a Component interface to the hps-mc-construct-detector script.

Required Config:

[ConstructDetector]
java_dir = /full/path/to/hps-java
hps_java_bin_jar = /full/path/to/hps-java/bin.jar

Required Parameters:

• detector: name of detector to construct (unless next\_detector is provided)

Optional Parameters:

• 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 369 of file _apply.py.

Constructor & Destructor Documentation

__init__()

__init__

(

self

)

Reimplemented from _DetectorEditor.

Definition at line 390 of file _apply.py.

Member Function Documentation

cmd_args()

cmd_args

(

self

)

Return the command arguments of this component.

Reimplemented from Component.

Definition at line 420 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 407 of file _apply.py.

required_config()

required_config

(

self

)

Return a list of required configuration settings.

There are none by default.

Reimplemented from _DetectorEditor.

Definition at line 404 of file _apply.py.

setup()

setup

(

self

)

Called after configured but before running

We deduce which detector we will be running with,
attempting to mimic the logic in ApplyPedeRes.execute
so that we compile the same detector that pede results
were written into.

Reimplemented from Component.

Definition at line 410 of file _apply.py.

Member Data Documentation

bump

bump

Definition at line 396 of file _apply.py.

detector_to_construct

detector_to_construct

Definition at line 399 of file _apply.py.

hps_java_bin_jar

hps_java_bin_jar

Definition at line 392 of file _apply.py.

java_dir

java_dir

Definition at line 421 of file _apply.py.

next_detector

next_detector

Definition at line 421 of file _apply.py.

---

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

• python/hpsmc/alignment/_apply.py