Inheritance diagram for CDCDisplayRun:

Public Member Functions
	__init__ (self)

	cdc_display_module (self)

	create_argument_parser (self, **kwds)

	configure (self, arguments)

	create_path (self)

	execute (self)

	name (self)

	configure_and_execute_from_commandline (self)

	run (self, path)

	configure_from_commandline (self)

	adjust_path (self, path)

Public Attributes
	cdc_display_module

Static Public Attributes
	output_folder = tempfile.gettempdir()
	Destination folder for displays.

bool	iteractive = True
	Switch to show the event display after each event.

bool	show_all_drawoptions = False
	Switch to also show draw command line options only related to the cellular automaton track finder.

str	filename_prefix = ""
	Prefix of the output files.

	finder_module = None
	Name of the finder module to be used - can be everything that is accepted by tracking.run.utilities.extend_path.

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

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.

str	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.

	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.

str	description = "Empty execution of basf2"
	Description of the run setup to be displayed on command line.

Protected Attributes
	_cdc_display_module = cdcdisplay.CDCSVGDisplayModule(self.output_folder)
	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 16 of file display.py.

Constructor & Destructor Documentation

◆ init()

__init__ ( self )


Constructor

Definition at line 31 of file display.py.

    def __init__(self):
        """Constructor"""
        super().__init__()
        ## Use the CDCSVGDisplay module to draw the CDC and tracks/hits
        self._cdc_display_module = cdcdisplay.CDCSVGDisplayModule(self.output_folder)
 

Member Function Documentation

◆ adjust_path()

adjust_path	(		self,
			path )

inherited


Hook that gives the opportunity to check the path for consistency before processing it

Reimplemented in HarvestingRunMixin, VXDTF2TrackingValidation, and VXDTF2TrackingValidationBkg.

Definition at line 94 of file minimal.py.

    def adjust_path(self, path):
        """Hook that gives the opportunity to check the path for consistency before processing it"""
 
# Minimal run stub defining some general parameters

◆ cdc_display_module()

cdc_display_module ( self )


Get the display module

Definition at line 38 of file display.py.

    def cdc_display_module(self):
        """Get the display module"""
        cdc_display_module = self._cdc_display_module
        return cdc_display_module
 

◆ configure()

configure	(		self,
			arguments )


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

Reimplemented from ReadOrGenerateEventsRun.

Definition at line 121 of file display.py.

    def configure(self, arguments):
        """Configure the basf2 job script using the translated command-line arguments"""
        super().configure(arguments)
 
        cdc_display_module = self.cdc_display_module
 
        cdc_display_module.output_folder = arguments.output_folder
        cdc_display_module.interactive = arguments.interactive
 
        cdc_display_module.use_python = arguments.use_python
        cdc_display_module.use_cpp = not arguments.use_python
        cdc_display_module.use_time_in_filename = arguments.use_time_in_filename
        cdc_display_module.filename_prefix = arguments.filename_prefix
 
        if self.show_all_drawoptions:
            drawoptions = cdc_display_module.all_drawoptions
        else:
            drawoptions = cdc_display_module.drawoptions
 
        for option in drawoptions:
            try:
                is_active_option = getattr(arguments, option)
            except AttributeError:
                continue
            else:
                print('Setting', option, 'to', is_active_option)
                setattr(cdc_display_module, option, is_active_option)
 

◆ configure_and_execute_from_commandline()

configure_and_execute_from_commandline ( self )

inherited


Configure basf2 job script from command-line arguments then run it

Definition at line 45 of file minimal.py.

    def configure_and_execute_from_commandline(self):
        """Configure basf2 job script from command-line arguments then run it"""
        self.configure_from_commandline()
        self.execute()
 

◆ configure_from_commandline()

configure_from_commandline ( self )

inherited


Convert the command-line arguments to a basf2 job script

Definition at line 67 of file minimal.py.

    def configure_from_commandline(self):
        """Convert the command-line arguments to a basf2 job script"""
        argument_parser = self.create_argument_parser()
        arguments = argument_parser.parse_args()
        self.configure(arguments)
 

◆ create_argument_parser()

create_argument_parser	(		self,
		**	kwds )


Translate the command-lne arguments to basf2-job parameter

Reimplemented from ReadOrGenerateTrackedEventsRun.

Definition at line 43 of file display.py.

    def create_argument_parser(self, **kwds):
        """Translate the command-lne arguments to basf2-job parameter"""
        argument_parser = super().create_argument_parser(**kwds)
 
        argument_parser.add_argument(
            '-o',
            '--output-folder',
            dest='output_folder',
            default=self.output_folder,
            help='Folder where the output files are written to. If the folder does not exist create it. '
        )
 
        argument_parser.add_argument(
            '--non-interactive',
            dest='interactive',
            action='store_false',
            help='Run in batch mode and do not show each event.'
        )
 
        argument_parser.add_argument(
            '--use-python',
            dest='use_python',
            action='store_true',
            help='Swtich to activate the legacy implementation written in python'
        )
 
        argument_parser.add_argument(
            "--use_time_in_filename",
            action='store_true',
            help='Use the current time in the names of the generated files'
        )
 
        argument_parser.add_argument(
            "-pf",
            '--filename_prefix',
            default=self.filename_prefix,
            help='Prefix to the names of the generated files'
        )
 
        argument_parser.add_argument(
            '-m',
            '--mc-tracks',
            action='store_const',
            dest='finder_module',
            const='TrackFinderMCTruthRecoTracks',
            default=self.finder_module,
            help='Generate the mc tracks using the TrackFinderMCTruthRecoTracks. Short hand for -f TrackFinderMCTruthRecoTracks'
        )
 
        subparser_description = \
            """
Various options to configure what shall be drawn in the display.
Note that some options are only relevant, if the cellular automaton finder in the CDC has been run before.
"""
        draw_argument_group = argument_parser.add_argument_group(
            title='Draw options',
            description=subparser_description
        )
 
        cdc_display_module = self.cdc_display_module
 
        if self.show_all_drawoptions:
            drawoptions = cdc_display_module.all_drawoptions
        else:
            drawoptions = cdc_display_module.drawoptions
 
        for option in sorted(drawoptions):
            options_flag = f"--{option.replace('_', '-')} "
 
            draw_argument_group.add_argument(
                options_flag,
                dest=option,
                action='store_true',
                default=getattr(cdc_display_module, option)
            )
 
        return argument_parser
 

◆ create_path()

create_path ( self )


Create the basf2 path

Reimplemented from ReadOrGenerateTrackedEventsRun.

Definition at line 149 of file display.py.

    def create_path(self):
        """Create the basf2 path"""
        main_path = super().create_path()
        main_path.add_module(self.cdc_display_module)
        return main_path

◆ execute()

execute ( self )

inherited


Run the basf2 job

Reimplemented from EmptyRun.

Definition at line 130 of file event_generation.py.

    def execute(self):
        """Run the basf2 job"""
        if not self.simulation_output:
            super().execute()
            return
 
        # Run only simulation
        path = ReadOrGenerateEventsRun.create_path(self)
        self.run(path)
 

◆ name()

name ( self )

inherited


provide name of this object

Definition at line 41 of file minimal.py.

41 def name(self):

42 """provide name of this object"""

43 return self.__class__.__name__

44

◆ run()

run	(		self,
			path )

inherited


Process the basf2 path

Reimplemented in PostProcessingRunMixin.

Definition at line 58 of file minimal.py.

    def run(self, path):
        """Process the basf2 path"""
        # Run basf2 module path #
        
        get_logger().info('Start processing')
        basf2.print_path(path)
        basf2.process(path)
        get_logger().info("\n%s", str(basf2.statistics))
 

Member Data Documentation

◆ _cdc_display_module

_cdc_display_module = cdcdisplay.CDCSVGDisplayModule(self.output_folder)

protected

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

Definition at line 35 of file display.py.

◆ allow_input

bool allow_input = True

staticinherited

By default, this basf2 job can read events from an input ROOT TFile.

Definition at line 109 of file minimal.py.

◆ bkg_files

list bkg_files = []

staticinherited

By default, no background overlay.

Definition at line 47 of file event_generation.py.

◆ cdc_display_module

cdc_display_module

Definition at line 152 of file display.py.

◆ components

components = None

staticinherited

By default, do specific components.

Definition at line 49 of file event_generation.py.

◆ description

str description = "Empty execution of basf2"

staticinherited

Description of the run setup to be displayed on command line.

Definition at line 33 of file minimal.py.

◆ detector_setup

str detector_setup = "Default"

staticinherited

By default, use the default detector setup.

Definition at line 45 of file event_generation.py.

◆ disable_deltas

bool disable_deltas = False

staticinherited

By default, do not disable delta-ray generation.

Definition at line 51 of file event_generation.py.

◆ filename_prefix

str filename_prefix = ""

static

Prefix of the output files.

Definition at line 29 of file display.py.

◆ finder_module

finder_module = None

staticinherited

Name of the finder module to be used - can be everything that is accepted by tracking.run.utilities.extend_path.

Reimplemented in CDCAutomaton, CDCAutomaton, CDCCombined, CDCCombined, CDCCR, CDCFull, CDCFull, CDCLegendre, CDCLegendre, CombinedSVDTrackingValidation, CombinedSVDTrackingValidationBkg, CosmicsAxialHough, CosmicsHough, InvertedFullBkg, fullTrackingValidation_plusECL, Full, SVDHoughTrackingValidation, SVDHoughTrackingValidationBkg, toCDCCKFValidationBkg, toCDCfromEclCKF, toCDCfromEclCKF, and StandardReconstructionEventsRun.

Definition at line 32 of file tracked_event_generation.py.

◆ fit_tracks

bool fit_tracks = False

staticinherited

By default, do not add the track fitting to the execution.

Definition at line 47 of file tracked_event_generation.py.

◆ generator_module

generator_module = None

staticinherited

By default, do not generate events.

Definition at line 43 of file event_generation.py.

◆ iteractive

bool iteractive = True

static

Switch to show the event display after each event.

Run in batch mode for false

Definition at line 23 of file display.py.

◆ mc_tracking

bool mc_tracking = True

staticinherited

By default, do MC track finding and track matching.

Definition at line 50 of file tracked_event_generation.py.

◆ n_events

n_events = 10000

staticinherited

By default, process 10000 events.

Definition at line 111 of file minimal.py.

◆ n_events_to_skip

int n_events_to_skip = 0

staticinherited

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

n_processes = 0

staticinherited

By default, no parallel processing.

Definition at line 117 of file minimal.py.

◆ output_folder

output_folder = tempfile.gettempdir()

static

Destination folder for displays.

Definition at line 20 of file display.py.

◆ random_seed

random_seed = None

staticinherited

By default, the random-number seed is unassigned.

Definition at line 115 of file minimal.py.

◆ root_input_file

root_input_file = None

staticinherited

By default, there is no input ROOT TFile.

Definition at line 113 of file minimal.py.

◆ show_all_drawoptions

bool show_all_drawoptions = False

static

Switch to also show draw command line options only related to the cellular automaton track finder.

Definition at line 26 of file display.py.

◆ simulation_output

simulation_output = None

staticinherited

By default, do no store the simulation output.

Definition at line 53 of file event_generation.py.

◆ tracking_coverage

dict 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 35 of file tracked_event_generation.py.

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

tracking/trackFindingCDC/scripts/trackfindingcdc/run/display.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ adjust_path()

◆ cdc_display_module()

◆ configure()

◆ configure_and_execute_from_commandline()

◆ configure_from_commandline()

◆ create_argument_parser()

◆ create_path()

◆ execute()

◆ name()

◆ run()

Member Data Documentation

◆ _cdc_display_module

◆ allow_input

◆ bkg_files

◆ cdc_display_module

◆ components

◆ description

◆ detector_setup

◆ disable_deltas

◆ filename_prefix

◆ finder_module

◆ fit_tracks

◆ generator_module

◆ iteractive

◆ mc_tracking

◆ n_events

◆ n_events_to_skip

◆ n_processes

◆ output_folder

◆ random_seed

◆ root_input_file

◆ show_all_drawoptions

◆ simulation_output

◆ tracking_coverage

◆ init()