HPS-MC
BeamCoords Class Reference

Transform StdHep events into beam coordinates. More...

Inheritance diagram for BeamCoords:
StdHepTool Component

Public Member Functions

def __init__ (self, **kwargs)
 
def cmd_args (self)
 Setup command arguments. More...
 
def optional_parameters (self)
 Return list of optional parameters. More...
 
- Public Member Functions inherited from StdHepTool
def __init__ (self, name=None, **kwargs)
 
- 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_line_str (self)
 
def execute (self, log_out=sys.stdout, log_err=sys.stderr)
 Generic component execution method. More...
 
def cmd_exists (self)
 Check if the component's assigned command exists. 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 required_parameters (self)
 Return a list of required parameters. More...
 
def required_config (self)
 Return a list of required configuration settings. 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

 beam_sigma_x
 
 beam_sigma_y
 beam sigma in y More...
 
 target_x
 target x position More...
 
 target_y
 target y position More...
 
 target_z
 target z position More...
 
 beam_rot_x
 beam rotation in x? More...
 
 beam_rot_y
 beam rotation in y? More...
 
 beam_rot_z
 beam rotation in z? More...
 
- Public Attributes inherited from Component
 name
 
 command
 
 nevents
 
 seed
 
 inputs
 
 outputs
 
 append_tok
 
 output_ext
 
 ignore_job_params
 
 hpsmc_dir
 
 logger
 

Additional Inherited Members

- Static Public Attributes inherited from StdHepTool
list seed_names
 List of commands which accept a 'seed' argument. More...
 

Detailed Description

Transform StdHep events into beam coordinates.

Optional parameters are: beam_sigma_x, beam_sigma_y, beam_rot_x, beam_rot_y, beam_rot_z, target_x, target_y, target_z

Definition at line 516 of file tools.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
**  kwargs 
)

Definition at line 524 of file tools.py.

Member Function Documentation

◆ cmd_args()

def cmd_args (   self)

Setup command arguments.

Returns
list of arguments

Reimplemented from StdHepTool.

Definition at line 548 of file tools.py.

◆ optional_parameters()

def optional_parameters (   self)

Return list of optional parameters.

Optional parameters are: beam_sigma_x, beam_sigma_y, beam_rot_x, beam_rot_y, beam_rot_z, target_x, target_y, target_z

Returns
list of optional parameters

Reimplemented from Component.

Definition at line 576 of file tools.py.

Member Data Documentation

◆ beam_rot_x

beam_rot_x

beam rotation in x?

Definition at line 537 of file tools.py.

◆ beam_rot_y

beam_rot_y

beam rotation in y?

Definition at line 539 of file tools.py.

◆ beam_rot_z

beam_rot_z

beam rotation in z?

Definition at line 541 of file tools.py.

◆ beam_sigma_x

beam_sigma_x
Todo:
clarify these beam sigma in x

Definition at line 527 of file tools.py.

◆ beam_sigma_y

beam_sigma_y

beam sigma in y

Definition at line 529 of file tools.py.

◆ target_x

target_x

target x position

Definition at line 531 of file tools.py.

◆ target_y

target_y

target y position

Definition at line 533 of file tools.py.

◆ target_z

target_z

target z position

Definition at line 535 of file tools.py.


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