ReadOrGenerateEventsRun Class Reference

Inheritance diagram for ReadOrGenerateEventsRun:

Collaboration diagram for ReadOrGenerateEventsRun:

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

Public Attributes
	root_input_file
	generating events, so there is no ROOT input file

Static Public Attributes
string	description = "Simulate events using various generator and detector setups from command line."
	Description of the run setup to be displayed on command line.
	generator_module = None
	By default, do not generate events.
string	detector_setup = "Default"
	By default, use the default detector setup.
list	bkg_files = []
	By default, no background overlay.
	components = None
	By default, do specific components.
bool	disable_deltas = False
	By default, do not disable delta-ray generation.
	simulation_output = None
	By default, do no store the simulation output.
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.
	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

Read generated events or generate new events

Definition at line 26 of file event_generation.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 88 of file minimal.py.

configure()

def configure	(		self,
			arguments
	)

Configure for basf2 job; disable ROOT input if simulating events

Reimplemented from EmptyRun.

Reimplemented in CDCDisplayRun.

Definition at line 114 of file event_generation.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 39 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 61 of file minimal.py.

create_argument_parser()

def create_argument_parser	(		self,
		**	kwds
	)

Convert command-line arguments to basf2 argument list

Reimplemented from MinimalRun.

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

Definition at line 47 of file event_generation.py.

create_path()

def create_path

(

self

)

Create and configure the basf2 path

Reimplemented from MinimalRun.

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

Definition at line 132 of file event_generation.py.

execute()

def execute

(

self

)

Run the basf2 job

Reimplemented from EmptyRun.

Definition at line 122 of file event_generation.py.

name()

def name (   self )

inherited

provide name of this object

Definition at line 35 of file minimal.py.

run()

def run (   self,   path  )

inherited

Process the basf2 path

Reimplemented in PostProcessingRunMixin.

Definition at line 52 of file minimal.py.

---

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

• tracking/scripts/tracking/run/event_generation.py