MinimalRun Class Reference

Inheritance diagram for MinimalRun:

Public Member Functions
def	create_argument_parser (self, **kwds)
def	create_path (self)

Static Public Attributes
str	description = "Minimally populated execution of basf2"
	Description of this object.
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.
None	root_input_file = None
	By default, there is no input ROOT TFile.
None	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.

Detailed Description

Configure for a minimal basf2 job

Definition at line 100 of file minimal.py.

Member Function Documentation

create_argument_parser()

def create_argument_parser	(		self,
		**	kwds
	)

Convert command-line arguments to basf2 argument list

Reimplemented from EmptyRun.

Reimplemented in ReadOrGenerateEventsRun, ReadOrGenerateTrackedEventsRun, TrackingValidationRun, CDCDisplayRun, ClusterFilterValidationRun, ElossHarvestingRun, LegendreBinningValidationRun, SegmentFitValidationRun, SegmentPairCreationValidationRun, SegmentPairFitValidationRun, 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()

def create_path

(

self

)

Create and configure the basf2 path

Reimplemented from EmptyRun.

Reimplemented in ReadOrGenerateEventsRun, ReadOrGenerateTrackedEventsRun, TrackingValidationRun, SegmentQuadTreeRun, CDCDisplayRun, ClusterFilterValidationRun, ElossHarvestingRun, LegendreBinningValidationRun, FitValidation, SegmentFitValidationRun, SegmentPairCreationValidationRun, SegmentPairFitValidationRun, 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

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 = "Minimally populated execution of basf2"

static

Description of this object.

Definition at line 104 of file minimal.py.

n_events

int 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

int n_processes = 0

static

By default, no parallel processing.

Definition at line 117 of file minimal.py.

random_seed

None random_seed = None

static

By default, the random-number seed is unassigned.

Definition at line 115 of file minimal.py.

root_input_file

None 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