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

write a detector intentionally misaligned relative to another one More...

Inheritance diagram for WriteMisalignedDet:
_DetectorEditor Component

Public Member Functions

 __init__ (self)
 
 required_config (self)
 Return a list of required configuration settings.
 
 required_parameters (self)
 Return a list of required parameters.
 
 cmd_line_str (self)
 
 execute (self, out, err)
 Generic component execution method.
 
- Public Member Functions inherited from _DetectorEditor
 optional_parameters (self)
 Return a list of optional 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

 param_map
 
 parameters
 
 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

write a detector intentionally misaligned relative to another one

Required Config:

[WriteMisalignedDet]
java_dir = /full/path/to/hps-java
param_map = /full/path/to/parameter/map.txt

Required Job:

  • detector : name of detector to base our misalignment on (and write to if no next\_detector is given)
  • parameters : dictionary of parameters to the change that should be applied

Definition at line 287 of file _apply.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self)

Reimplemented from _DetectorEditor.

Definition at line 304 of file _apply.py.

Member Function Documentation

◆ cmd_line_str()

cmd_line_str (   self)

Reimplemented from Component.

Definition at line 319 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 322 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 313 of file _apply.py.

◆ required_parameters()

required_parameters (   self)

Return a list of required parameters.

The job will fail if these are not present in the JSON file.

Reimplemented from _DetectorEditor.

Definition at line 316 of file _apply.py.

Member Data Documentation

◆ next_detector

next_detector

Definition at line 356 of file _apply.py.

◆ param_map

param_map

Definition at line 306 of file _apply.py.

◆ parameters

parameters

Definition at line 309 of file _apply.py.


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