Inheritance diagram for MinimalRun:

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
bool	allow_input = True
	By default, this basf2 job can read events from an input ROOT TFile.

int	n_events = 10000
	By default, process 10000 events.

	root_input_file = None
	By default, there is no input ROOT TFile.

	random_seed = None
	By default, the random-number seed is unassigned.

int	n_processes = 0
	By default, no parallel processing.

int	n_events_to_skip = 0
	By default, do not skip any events at the start of the input ROOT TFile.

str	description = "Empty execution of basf2"
	Description of the run setup to be displayed on command line.

Detailed Description


Configure for a minimal basf2 job

Definition at line 100 of file minimal.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 HarvestingRunMixin, 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 CDCDisplayRun, and 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 )


Convert command-line arguments to basf2 argument list

Reimplemented from EmptyRun.

Reimplemented in ClusterFilterValidationRun, CDCDisplayRun, ElossHarvestingRun, LegendreBinningValidationRun, SegmentFitValidationRun, SegmentPairFitValidationRun, SegmentPairCreationValidationRun, ReadOrGenerateEventsRun, ReadOrGenerateTrackedEventsRun, TrackingValidationRun, and FacetFilterTrainingRun.

Definition at line 121 of file minimal.py.

    def create_argument_parser(self, **kwds):
        """Convert command-line arguments to basf2 argument list"""
        argument_parser = super().create_argument_parser(**kwds)
        master_argument_group = argument_parser.add_argument_group("Master arguments")
 
        if self.allow_input:
            master_argument_group.add_argument(
                '-i',
                '--input',
                default=argparse.SUPPRESS,
                dest='root_input_file',
                help='File path to the ROOT file from which the simulated events shall be loaded.'
            )
 
        master_argument_group.add_argument(
            '-n',
            '--events',
            dest='n_events',
            default=self.n_events,
            type=int,
            help='Number of events to be generated',
        )
 
        master_argument_group.add_argument(
            '-r',
            '--random-seed',
            dest='random_seed',
            default=argparse.SUPPRESS,
            type=str,
            help='The random number generator seed to be set before the processing starts.',
        )
 
        master_argument_group.add_argument(
            '-p',
            '--processes',
            dest='n_processes',
            default=argparse.SUPPRESS,
            type=int,
            help='The number of parallel processes to be used for processing.',
        )
 
        master_argument_group.add_argument(
            '--n-events-to-skip',
            dest='n_events_to_skip',
            default=argparse.SUPPRESS,
            type=int,
            help='The number of events to skip',
        )
 
        return argument_parser
 

◆ create_path()

create_path ( self )


Create and configure the basf2 path

Reimplemented from EmptyRun.

Reimplemented in ClusterFilterValidationRun, CDCDisplayRun, FitValidation, ElossHarvestingRun, LegendreBinningValidationRun, SegmentFitValidationRun, SegmentPairFitValidationRun, SegmentQuadTreeRun, SegmentPairCreationValidationRun, ReadOrGenerateEventsRun, ReadOrGenerateTrackedEventsRun, TrackingValidationRun, BackgroundClusterFilterTrainingRun, FacetFilterTrainingRun, FacetRelationFilterTrainingRun, FeasibleAxialSegmentPairFilterTrainingRun, FeasibleSegmentPairFilterTrainingRun, FeasibleSegmentRelationFilterTrainingRun, FeasibleTrackRelationFilterTrainingRun, RealisticAxialSegmentPairFilterTrainingRun, RealisticSegmentPairFilterTrainingRun, RealisticSegmentPairRelationFilterTrainingRun, RealisticSegmentRelationFilterTrainingRun, RealisticTrackRelationFilterTrainingRun, SegmentTrackFilterTrainingRun, and TrackFilterTrainingRun.

Definition at line 172 of file minimal.py.

    def create_path(self):
        """Create and configure the basf2 path"""
        path = super().create_path()
 
        if self.random_seed is not None:
            basf2.set_random_seed(self.random_seed)
 
        environment = Belle2.Environment.Instance()
        environment.setNumberEventsOverride(self.n_events)
 
        # If there is no input file is the EventInfoSetter as master module
        if not self.root_input_file:
            # Master module: EventInfoSetter
            path.add_module('EventInfoSetter',
                            evtNumList=[self.n_events],
                            runList=[1],
                            expList=[0],
                            skipNEvents=self.n_events_to_skip
                            )
 
        else:
            # Master module: RootInput
            path.add_module('RootInput',
                            inputFileName=self.root_input_file,
                            skipNEvents=self.n_events_to_skip)
 
        # Progress module
        path.add_module('Progress')
 
        if self.n_processes:
            environment = Belle2.Environment.Instance()
            environment.setNumberProcessesOverride(self.n_processes)
 
        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.

41 def name(self):

42 """provide name of this object"""

43 return self.__class__.__name__

44

◆ 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

◆ allow_input

bool allow_input = True

static

By default, this basf2 job can read events from an input ROOT TFile.

Definition at line 109 of file minimal.py.

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

◆ n_events

n_events = 10000

static

By default, process 10000 events.

Definition at line 111 of file minimal.py.

◆ n_events_to_skip

int n_events_to_skip = 0

static

By default, do not skip any events at the start of the input ROOT TFile.

Definition at line 119 of file minimal.py.

◆ n_processes

n_processes = 0

static

By default, no parallel processing.

Definition at line 117 of file minimal.py.

◆ random_seed

random_seed = None

static

By default, the random-number seed is unassigned.

Definition at line 115 of file minimal.py.

◆ root_input_file

root_input_file = None

static

By default, there is no input ROOT TFile.

Definition at line 113 of file minimal.py.

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

tracking/scripts/tracking/run/minimal.py

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ adjust_path()

◆ configure()

◆ configure_and_execute_from_commandline()

◆ configure_from_commandline()

◆ create_argument_parser()

◆ create_path()

◆ execute()

◆ name()

◆ run()

Member Data Documentation

◆ allow_input

◆ description

◆ n_events

◆ n_events_to_skip

◆ n_processes

◆ random_seed

◆ root_input_file