Inheritance diagram for SegmentQuadTreeRun:

Public Member Functions
	create_path (self)

	create_argument_parser (self, **kwds)

	configure (self, arguments)

	execute (self)

	name (self)

	configure_and_execute_from_commandline (self)

	run (self, path)

	configure_from_commandline (self)

	adjust_path (self, path)

Static Public Attributes
	display_module_segments
	Use CDCSVGDisplay to draw the MCTrackCand segments.

	draw_gftrackcand_trajectories
	Do not draw the genfit MCTrackCand trajectories.

	draw_gftrackcands
	Draw the genfit MCTrackCands.

	draw_clusters
	Do not draw the associated clusters.

	track_cands_store_array_name
	Tell the plotter where to find the information.

	display_module_tracks
	Use CDCSVGDisplay to draw the TrackCand information.

	display_module_mc
	Use CDCSVGDisplay to draw the MC tracks.

	draw_segments_mctrackid
	Draw the track IDs.

	plotter_module = SegmentQuadTreePlotter()
	Convert the information to QuadTree segments then draw these.

	draw_quad_tree_content
	Draw the QuadTree segments.

	draw_segment_intersection
	Draw the segment intersections.

	draw_mc_information
	Draw the MC information.

	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.

Detailed Description


 Create segments and plot them in a segment quad tree

Definition at line 20 of file segment_quad_tree.py.

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

◆ configure()

configure	(		self,
			arguments )

inherited


Configure for basf2 job; disable ROOT input if simulating events

Reimplemented from EmptyRun.

Definition at line 122 of file event_generation.py.

    def configure(self, arguments):
        """Configure for basf2 job; disable ROOT input if simulating events"""
        super().configure(arguments)
        if self.simulation_output:
            get_logger().info("Requested to simulation run. Deactivate input file")
            
            self.root_input_file = None
 

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

inherited


Convert command-line arguments to basf2 argument list

Reimplemented from MinimalRun.

Reimplemented in ClusterFilterValidationRun, SegmentPairCreationValidationRun, ReadOrGenerateTrackedEventsRun, TrackingValidationRun, and FacetFilterTrainingRun.

Definition at line 55 of file event_generation.py.

    def create_argument_parser(self, **kwds):
        """Convert command-line arguments to basf2 argument list"""
        argument_parser = super().create_argument_parser(**kwds)
 
        setup_argument_group = argument_parser.add_argument_group("Detector setup arguments")
        setup_argument_group.add_argument(
            '-d',
            '--detector',
            dest='detector_setup',
            default=argparse.SUPPRESS,
            metavar='DETECTOR_SETUP_NAME',
            choices=utilities.NonstrictChoices(detector_setups_by_short_name.keys()),
            help=('Name of the detector setup to be used')
        )
 
        setup_argument_group.add_argument(
            '-c',
            '--component',
            dest='components',
            nargs='+',
            default=argparse.SUPPRESS,
            metavar='COMPONENTS',
            action='store',
            help=('Overrides the components of the detector setup')
        )
 
        generator_argument_group = argument_parser.add_argument_group("Generator arguments")
        generator_argument_group.add_argument(
            '-g',
            '--generator',
            dest='generator_module',
            default=argparse.SUPPRESS,
            metavar='GENERATOR_NAME',
            choices=utilities.NonstrictChoices(valid_generator_short_names),
            help='Name module or short name of the generator to be used.',
        )
 
        simulation_argument_group = argument_parser.add_argument_group("Simulation arguments")
        simulation_argument_group.add_argument(
            '-b',
            '--bkg-file',
            dest='bkg_files',
            nargs='+',
            default=self.bkg_files,
            metavar='BACKGROUND_DIRECTORY',
            help='Path to folder of files or to a file containing the background to be used. ' +
                 'Can be given multiple times.',
        )
 
        simulation_argument_group.add_argument(
            '--disable-deltas',
            action='store_true',
            help='Disable the generation of delta rays in the simulation'
        )
 
        simulation_argument_group.add_argument(
            '-so',
            '--simulation-output',
            nargs='?',
            default=self.simulation_output,
            const=self.root_input_file,
            dest='simulation_output',
            help='Only generate and simulate the events and write them to the given output file. Skip rest of the path.'
        )
 
        return argument_parser
 

◆ create_path()

create_path ( self )


 Make SegmentFinding and QuadTreeFinding and plotting/display/validation

Reimplemented from ReadOrGenerateEventsRun.

Definition at line 72 of file segment_quad_tree.py.

    def create_path(self):
        """ Make SegmentFinding and QuadTreeFinding and plotting/display/validation"""
        main_path = super().create_path()
 
        add_mc_track_finder(main_path)
        main_path.add_module("TFCDC_WireHitPreparer")
        main_path.add_module("TFCDC_ClusterPreparer")
 
        segment_finder = basf2.register_module("TFCDC_SegmentFinderFacetAutomaton")
        segment_finder.param({
            "WriteFacets": True,
            "SegmentOrientation": "none",
        })
        main_path.add_module(segment_finder)
 
        # main_path.add_module(Filler())
 
        segment_quad_tree = basf2.register_module("SegmentQuadTree")
        segment_quad_tree.param({
            "Level": 4,
            "MinimumItems": 1,
            "DoPostprocessing": True,
        })
        segment_quad_tree.set_log_level(basf2.LogLevel.DEBUG)
        segment_quad_tree.set_debug_level(100)
        main_path.add_module(segment_quad_tree)
        main_path.add_module(self.display_module_tracks)
 
        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

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

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

◆ display_module_mc

display_module_mc

static

Initial value:

=  CDCSVGDisplayModule(
        
    )

Use CDCSVGDisplay to draw the MC tracks.

Definition at line 51 of file segment_quad_tree.py.

◆ display_module_segments

display_module_segments

static

Initial value:

=  CDCSVGDisplayModule(
        
    )

Use CDCSVGDisplay to draw the MCTrackCand segments.

Definition at line 25 of file segment_quad_tree.py.

◆ display_module_tracks

display_module_tracks

static

Initial value:

=  CDCSVGDisplayModule(
        
    )

Use CDCSVGDisplay to draw the TrackCand information.

Definition at line 40 of file segment_quad_tree.py.

◆ draw_clusters

draw_clusters

static

Do not draw the associated clusters.

Definition at line 35 of file segment_quad_tree.py.

◆ draw_gftrackcand_trajectories

draw_gftrackcand_trajectories

static

Do not draw the genfit MCTrackCand trajectories.

Draw the genfit MCTrackCand trajectories.

Definition at line 31 of file segment_quad_tree.py.

◆ draw_gftrackcands

draw_gftrackcands

static

Draw the genfit MCTrackCands.

Draw the genfit TrackCands.

Definition at line 33 of file segment_quad_tree.py.

◆ draw_mc_information

draw_mc_information

static

Draw the MC information.

Definition at line 70 of file segment_quad_tree.py.

◆ draw_quad_tree_content

draw_quad_tree_content

static

Draw the QuadTree segments.

Definition at line 66 of file segment_quad_tree.py.

◆ draw_segment_intersection

draw_segment_intersection

static

Draw the segment intersections.

Definition at line 68 of file segment_quad_tree.py.

◆ draw_segments_mctrackid

draw_segments_mctrackid

static

Draw the track IDs.

Definition at line 59 of file segment_quad_tree.py.

◆ generator_module

generator_module = None

staticinherited

By default, do not generate events.

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

◆ plotter_module

plotter_module = SegmentQuadTreePlotter()

static

Convert the information to QuadTree segments then draw these.

Definition at line 64 of file segment_quad_tree.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.

◆ simulation_output

simulation_output = None

staticinherited

By default, do no store the simulation output.

Definition at line 53 of file event_generation.py.

◆ track_cands_store_array_name

track_cands_store_array_name

static

Tell the plotter where to find the information.

Definition at line 37 of file segment_quad_tree.py.

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

tracking/trackFindingCDC/scripts/trackfindingcdc/quadtree/segment_quad_tree.py

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ adjust_path()

◆ configure()

◆ configure_and_execute_from_commandline()

◆ configure_from_commandline()

◆ create_argument_parser()

◆ create_path()

◆ execute()

◆ name()

◆ run()

Member Data Documentation

◆ allow_input

◆ bkg_files

◆ components

◆ description

◆ detector_setup

◆ disable_deltas

◆ display_module_mc

◆ display_module_segments

◆ display_module_tracks

◆ draw_clusters

◆ draw_gftrackcand_trajectories

◆ draw_gftrackcands

◆ draw_mc_information

◆ draw_quad_tree_content

◆ draw_segment_intersection

◆ draw_segments_mctrackid

◆ generator_module

◆ n_events

◆ n_events_to_skip

◆ n_processes

◆ plotter_module

◆ random_seed

◆ root_input_file

◆ simulation_output

◆ track_cands_store_array_name