HPS-MC
WriteMisalignedDet Class Reference

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

Inheritance diagram for WriteMisalignedDet:
_DetectorEditor Component

Public Member Functions

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

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

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

def __init__ (   self)

Definition at line 304 of file _apply.py.

Member Function Documentation

◆ cmd_line_str()

def cmd_line_str (   self)

Reimplemented from Component.

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

◆ required_config()

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

def 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

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