ReadOrGenerateTrackedEventsRun Class Reference

Inheritance diagram for ReadOrGenerateTrackedEventsRun:

Collaboration diagram for ReadOrGenerateTrackedEventsRun:

Public Member Functions
def	create_argument_parser (self, **kwds)
def	create_path (self)
def	configure (self, arguments)
def	execute (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 = "Apply tracking to presimulated events or events generated on the fly."
	Description of the run setup to be displayed on command line.
	finder_module = None
	Name of the finder module to be used - can be everything that is accepted by tracking.run.utilities.extend_path.
dictionary	tracking_coverage
	States which detectors the finder module covers like as a dictionary like. More...
bool	fit_tracks = False
	By default, do not add the track fitting to the execution.
bool	mc_tracking = True
	By default, do MC track finding and track matching.
	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

 Apply tracking to presimulated events or events generated on the fly 

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

configure()

def configure (   self,   arguments  )

inherited

Configure for basf2 job; disable ROOT input if simulating events

Reimplemented from EmptyRun.

Reimplemented in CDCDisplayRun.

Definition at line 123 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 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 ReadOrGenerateEventsRun.

Reimplemented in CDCDisplayRun, and TrackingValidationRun.

Definition at line 53 of file tracked_event_generation.py.

    def create_argument_parser(self, **kwds):
        """Convert command-line arguments to basf2 argument list"""
        argument_parser = super().create_argument_parser(**kwds)
 
        tracking_argument_group = argument_parser.add_argument_group("Tracking setup arguments")
 
        tracking_argument_group.add_argument(
            '-f',
            '--finder',
            choices=utilities.NonstrictChoices(finder_modules_by_short_name.keys()),
            default=self.finder_module,
            dest='finder_module',
            help='Name of the finder module to be evaluated.',)
 
        tracking_argument_group.add_argument(
            '--fit',
            action="store_true",
            default=self.fit_tracks,
            dest='fit_tracks',
            help='Apply the fitting to the found tracks'
        )
 
        return argument_parser
 

create_path()

def create_path

(

self

)

Sets up a path that plays back pregenerated events or generates events
   based on the properties in the base class.

Reimplemented from ReadOrGenerateEventsRun.

Reimplemented in CDCDisplayRun, and TrackingValidationRun.

Definition at line 77 of file tracked_event_generation.py.

execute()

def execute (   self )

inherited

Run the basf2 job

Reimplemented from EmptyRun.

Definition at line 131 of file event_generation.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

tracking_coverage

dictionary tracking_coverage

static

Initial value:

=  {
        'UsePXDHits': True,
        'UseSVDHits': True,
        'UseCDCHits': True,
        'UseOnlyAxialCDCHits': False,
        'UseOnlyBeforeTOP': True,
        'UseReassignedHits': True,
        'UseNLoops': 1,
        'WhichParticles': [],
    }

States which detectors the finder module covers like as a dictionary like.

Definition at line 36 of file tracked_event_generation.py.

---

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

• tracking/scripts/tracking/run/tracked_event_generation.py