WireHitPreparerRunMixin Class Reference

Inheritance diagram for WireHitPreparerRunMixin:

Collaboration diagram for WireHitPreparerRunMixin:

Public Member Functions
def	create_argument_parser (self, **kwds)
def	create_path (self)
def	name (self)
def	configure_and_execute_from_commandline (self)
def	execute (self)
def	run (self, path)
def	configure_from_commandline (self)
def	configure (self, arguments)
def	adjust_path (self, path)

Static Public Attributes
string	flight_time_estimation = ""
	Used option for the initial flight time estimation.
	n_loops = float("nan")
	Loop limit above which on wire hits are prepared for the track finder - Uses MC information.
string	description = "Empty execution of basf2"
	Description of the run setup to be displayed on command line.

Detailed Description

Mixin part the 

Definition at line 14 of file wirehit_preparation.py.

Member Function Documentation

adjust_path()

def adjust_path (   self,   path  )

inherited

Hook that gives the opportunity to check the path for consistency before processing it

Reimplemented in HarvestingRunMixin.

Definition at line 95 of file minimal.py.

configure()

def configure (   self,   arguments  )

inherited

Save the command-line arguments as key-value pairs

Reimplemented in CDCDisplayRun, and ReadOrGenerateEventsRun.

Definition at line 74 of file minimal.py.

configure_and_execute_from_commandline()

def configure_and_execute_from_commandline (   self )

inherited

Configure basf2 job script from command-line arguments then run it

Definition at line 46 of file minimal.py.

configure_from_commandline()

def configure_from_commandline (   self )

inherited

Convert the command-line arguments to a basf2 job script

Definition at line 68 of file minimal.py.

create_argument_parser()

def create_argument_parser	(		self,
		**	kwds
	)

Configure the basf2 job script using the translated command-line arguments

Reimplemented from EmptyRun.

Definition at line 23 of file wirehit_preparation.py.

    def create_argument_parser(self, **kwds):
        """Configure the basf2 job script using the translated command-line arguments"""
 
        argument_parser = super().create_argument_parser(**kwds)
 
        argument_parser.add_argument(
            "-ft",
            "--flight-time-estimation",
            choices=["none", "outwards", "downwards"],
            default=argparse.SUPPRESS,
            dest="flight_time_estimation",
            help=("Choose which estimation method for the time of flight should be use. \n"
                  "* 'none' no time of flight corrections\n"
                  "* 'outwards' means the minimal time needed to travel to the wire from the interaction point \n"
                  "* 'downwards' means the minimal time needed to travel to the wire from the y = 0 plane downwards \n")
        )
 
        argument_parser.add_argument(
            "-l",
            "--mc-loop-limit",
            type=float,
            dest="n_loops",
            help=("Choose to block all wire hits but the ones located on the {mc_loops} first loops")
        )
 
        return argument_parser
 

create_path()

def create_path

(

self

)

Sets up a path that plays back pregenerated events or generates events
based on the properties in the base class.

Reimplemented from EmptyRun.

Definition at line 50 of file wirehit_preparation.py.

execute()

def execute (   self )

inherited

Create the basf2 path then run the job

Reimplemented in ReadOrGenerateEventsRun.

Definition at line 51 of file minimal.py.

name()

def name (   self )

inherited

provide name of this object

Definition at line 42 of file minimal.py.

run()

def run (   self,   path  )

inherited

Process the basf2 path

Reimplemented in PostProcessingRunMixin.

Definition at line 59 of file minimal.py.

---

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

• tracking/trackFindingCDC/scripts/trackfindingcdc/run/wirehit_preparation.py