MinimalRun Class Reference

Inheritance diagram for MinimalRun:

Collaboration diagram for MinimalRun:

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	description = "Minimally populated execution of basf2"
	Description of this object. More...
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.

Detailed Description

Configure for a minimal basf2 job

Definition at line 101 of file minimal.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
	)

Convert command-line arguments to basf2 argument list

Reimplemented from EmptyRun.

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

Definition at line 122 of file minimal.py.

create_path()

def create_path

(

self

)

Create and configure the basf2 path

Reimplemented from EmptyRun.

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

Definition at line 173 of file minimal.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.

Member Data Documentation

description

string description = "Minimally populated execution of basf2"

static

Description of this object.

Configure for a minimal basf2 job

Definition at line 105 of file minimal.py.

---

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

• tracking/scripts/tracking/run/minimal.py