RootOutputRunMixin Class Reference

Inheritance diagram for RootOutputRunMixin:

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
	root_output_file = None
	There is no default for the name of the output TFile.
str	description = "Empty execution of basf2"
	Description of the run setup to be displayed on command line.

Detailed Description

Configure for basf2 job output ROOT TFile

Definition at line 94 of file mixins.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 )

Parse the command-line output-file-specification argument

Reimplemented from EmptyRun.

Definition at line 100 of file mixins.py.

    def create_argument_parser(self, **kwds):
        """Parse the command-line output-file-specification argument"""
        argument_parser = super().create_argument_parser(**kwds)
        argument_parser.add_argument(
            'root_output_file',
            help='Output file to which the simulated events shall be written.'
        )
 
        return argument_parser
 

create_path()

create_path

(

self

)

Create a new basf2 path and add the RootOutput module to it

Reimplemented from EmptyRun.

Definition at line 110 of file mixins.py.

    def create_path(self):
        """Create a new basf2 path and add the RootOutput module to it"""
        path = super().create_path()
 
        path.add_module(
            'RootOutput',
            outputFileName=self.root_output_file
        )
 
        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.

root_output_file

root_output_file = None

static

There is no default for the name of the output TFile.

Definition at line 98 of file mixins.py.

---

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

• tracking/scripts/tracking/run/mixins.py