CDCDisplayRun Class Reference

Inheritance diagram for CDCDisplayRun:

Collaboration diagram for CDCDisplayRun:

Public Member Functions
def	__init__ (self)
def	cdc_display_module (self)
def	create_argument_parser (self, **kwds)
def	configure (self, arguments)
def	create_path (self)
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
	output_folder = tempfile.gettempdir()
	Destination folder for displays.
bool	iteractive = True
	Switch to show the event display after each event. More...
bool	show_all_drawoptions = False
	Switch to also show draw command line options only related to the cellular automaton track finder.
string	filename_prefix = ""
	Prefix of the output files.
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.

Private Attributes
	_cdc_display_module
	Use the CDCSVGDisplay module to draw the CDC and tracks/hits.

Detailed Description

Prepare and execute a basf2 job to read generated events or generate new events then display the CDC tracks

Definition at line 17 of file display.py.

Constructor & Destructor Documentation

__init__()

def __init__

(

self

)

Constructor

Definition at line 32 of file display.py.

    def __init__(self):
        """Constructor"""
        super().__init__()
        
        self._cdc_display_module = cdcdisplay.CDCSVGDisplayModule(self.output_folder)
 

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.

cdc_display_module()

def cdc_display_module

(

self

)

Get the display module

Definition at line 39 of file display.py.

configure()

def configure	(		self,
			arguments
	)

Configure the basf2 job script using the translated command-line arguments

Reimplemented from ReadOrGenerateEventsRun.

Definition at line 122 of file display.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
	)

Translate the command-lne arguments to basf2-job parameter

Reimplemented from ReadOrGenerateTrackedEventsRun.

Definition at line 44 of file display.py.

create_path()

def create_path

(

self

)

Create the basf2 path

Reimplemented from ReadOrGenerateTrackedEventsRun.

Definition at line 150 of file display.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

iteractive

bool iteractive = True

static

Switch to show the event display after each event.

Run in batch mode for false

Definition at line 24 of file display.py.

tracking_coverage

dictionary tracking_coverage

staticinherited

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/trackFindingCDC/scripts/trackfindingcdc/run/display.py