CDCDisplayRun Class Reference

Inheritance 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)

Static Public Attributes
tempfile	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.

Protected 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 16 of file display.py.

Constructor & Destructor Documentation

__init__()

def __init__

(

self

)

Constructor

Reimplemented from EmptyRun.

Definition at line 31 of file display.py.

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

Member Function Documentation

cdc_display_module()

def 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()

def 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)
 

create_argument_parser()

def 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()

def 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

Member Data Documentation

_cdc_display_module

_cdc_display_module

protected

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

Definition at line 35 of file display.py.

filename_prefix

str filename_prefix = ""

static

Prefix of the output files.

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

output_folder

tempfile output_folder = tempfile.gettempdir()

static

Destination folder for displays.

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

---

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

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