WireHitPreparerRunMixin Class Reference

Inheritance diagram for WireHitPreparerRunMixin:

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

Static Public Attributes
str	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.
str	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()

adjust_path ( self, path )

inherited

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

Reimplemented in VXDTF2TrackingValidation, and VXDTF2TrackingValidationBkg.

Definition at line 94 of file minimal.py.

    def adjust_path(self, path):
        """Hook that gives the opportunity to check the path for consistency before processing it"""
 
# Minimal run stub defining some general parameters
 
 

configure()

configure ( self, arguments )

inherited

Save the command-line arguments as key-value pairs

Reimplemented in ReadOrGenerateEventsRun.

Definition at line 73 of file minimal.py.

    def configure(self, arguments):
        """Save the command-line arguments as key-value pairs"""
        # Simply translate the arguments that have
        # the same name as valid instance arguments
        for (key, value) in list(vars(arguments).items()):
            if value is None:
                continue
            if hasattr(self, key):
                get_logger().info("Setting %s to %s", key, value)
                setattr(self, key, value)
 

configure_and_execute_from_commandline()

configure_and_execute_from_commandline ( self )

inherited

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

Definition at line 45 of file minimal.py.

    def configure_and_execute_from_commandline(self):
        """Configure basf2 job script from command-line arguments then run it"""
        self.configure_from_commandline()
        self.execute()
 

configure_from_commandline()

configure_from_commandline ( self )

inherited

Convert the command-line arguments to a basf2 job script

Definition at line 67 of file minimal.py.

    def configure_from_commandline(self):
        """Convert the command-line arguments to a basf2 job script"""
        argument_parser = self.create_argument_parser()
        arguments = argument_parser.parse_args()
        self.configure(arguments)
 

create_argument_parser()

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

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.

    def create_path(self):
        """
        Sets up a path that plays back pregenerated events or generates events
        based on the properties in the base class.
        """
        path = super().create_path()
 
        wire_hit_preparer = path.add_module("TFCDC_WireHitPreparer",
                                            UseNLoops=self.n_loops)
        if self.flight_time_estimation:
            wire_hit_preparer.param(dict(flightTimeEstimation=self.flight_time_estimation))
 
        return path

execute()

execute ( self )

inherited

Create the basf2 path then run the job

Reimplemented in ReadOrGenerateEventsRun.

Definition at line 50 of file minimal.py.

    def execute(self):
        """Create the basf2 path then run the job"""
        # Create path and run #
        
        path = self.create_path()
        self.adjust_path(path)
        self.run(path)
 

name()

name ( self )

inherited

provide name of this object

Definition at line 41 of file minimal.py.

    def name(self):
        """provide name of this object"""
        return self.__class__.__name__
 

run()

run ( self, path )

inherited

Process the basf2 path

Reimplemented in PostProcessingRunMixin.

Definition at line 58 of file minimal.py.

    def run(self, path):
        """Process the basf2 path"""
        # Run basf2 module path #
        
        get_logger().info('Start processing')
        basf2.print_path(path)
        basf2.process(path)
        get_logger().info("\n%s", str(basf2.statistics))
 

Member Data Documentation

description

str description = "Empty execution of basf2"

staticinherited

Description of the run setup to be displayed on command line.

Definition at line 33 of file minimal.py.

flight_time_estimation

str flight_time_estimation = ""

static

Used option for the initial flight time estimation.

Definition at line 18 of file wirehit_preparation.py.

n_loops

n_loops = float("nan")

static

Loop limit above which on wire hits are prepared for the track finder - Uses MC information.

Definition at line 21 of file wirehit_preparation.py.

---

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

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