Inheritance diagram for ClusterFilterValidationRun:

Public Member Functions
	create_argument_parser (self, **kwds)

	create_path (self)

	postprocess (self)

	run (self, path)

	name (self)

	configure_and_execute_from_commandline (self)

	execute (self)

	configure_from_commandline (self)

	configure (self, arguments)

	adjust_path (self, path)

Static Public Attributes
	cluster_preparation_module = basf2.register_module("TFCDC_ClusterPreparer")
	basf2 module for CDC cluster preparation

bool	py_profile = True
	create a python profile

	output_file_name = None
	There is no default for the name of the output TFile.

bool	show_results = False
	By default, do not show the browsing results.

bool	postprocess_only = False
	By default, browse the output TFile too.

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

	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.

Detailed Description

Prepare and execute a basf2 job to read generated events or generate new events then validate the CDC cluster filter

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

Save the command-line arguments as key-value pairs

Reimplemented in ReadOrGenerateEventsRun.

Definition at line 73 of file minimal.py.

    def configure(self, arguments):
        """Save the command-line arguments as key-value pairs"""
        # Simply translate the arguments that have
        # the same name as valid instance arguments
        for (key, value) in list(vars(arguments).items()):
            if value is None:
                continue
            if hasattr(self, key):
                get_logger().info("Setting %s to %s", key, value)
                setattr(self, key, value)
 

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

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

Reimplemented from BrowseTFileOnTerminateRunMixin.

Definition at line 41 of file clusterFilterValidation.py.

    def create_argument_parser(self, **kwds):
        """Configure the basf2 job script using the translated command-line arguments"""
        argument_parser = super().create_argument_parser(**kwds)
        return argument_parser
 

◆ create_path()

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

Definition at line 46 of file clusterFilterValidation.py.

    def create_path(self):
        """
        Sets up a path that plays back pregenerated events or generates events
        based on the properties in the base class.
        """
        main_path = super().create_path()
 
        cluster_preparation_module = self.get_basf2_module(self.cluster_preparation_module)
        main_path.add_module(cluster_preparation_module)
 
        # main_path.add_module(AxialStereoPairFitterModule())
        validation_module = ClusterFilterValidationModule(output_file_name=self.output_file_name)
        if self.py_profile:
            main_path.add_module(metamodules.PyProfilingModule(validation_module))
        else:
            main_path.add_module(validation_module)
 
        return main_path
 
 

◆ execute()

execute ( self )

inherited

Create the basf2 path then run the job

Reimplemented in ReadOrGenerateEventsRun.

Definition at line 50 of file minimal.py.

    def execute(self):
        """Create the basf2 path then run the job"""
        # Create path and run #
        
        path = self.create_path()
        self.adjust_path(path)
        self.run(path)
 

◆ name()

name ( self )

inherited

provide name of this object

Definition at line 41 of file minimal.py.

    def name(self):
        """provide name of this object"""
        return self.__class__.__name__
 

◆ postprocess()

postprocess ( self )

inherited

Browse the TFile interactively

Reimplemented from PostProcessingRunMixin.

Definition at line 84 of file mixins.py.

    def postprocess(self):
        """Browse the TFile interactively"""
        if self.show_results and self.output_file_name:
            with root_utils.root_open(self.output_file_name) as tfile:
                root_utils.root_browse(tfile)
                input("Close with return key.")
 
        super().postprocess()
 
 

◆ run()

run	(		self,
			path )

inherited

Post-process the basf2 job output

Reimplemented from EmptyRun.

Definition at line 45 of file mixins.py.

    def run(self, path):
        """Post-process the basf2 job output"""
        if not self.postprocess_only:
            super().run(path)
 
        self.postprocess()
 

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.

◆ cluster_preparation_module

cluster_preparation_module = basf2.register_module("TFCDC_ClusterPreparer")

static

basf2 module for CDC cluster preparation

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

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

◆ output_file_name

output_file_name = None

staticinherited

There is no default for the name of the output TFile.

Definition at line 60 of file mixins.py.

◆ postprocess_only

bool postprocess_only = False

staticinherited

By default, browse the output TFile too.

Post-process the basf2 job output

Definition at line 29 of file mixins.py.

◆ py_profile

bool py_profile = True

static

create a python profile

Definition at line 37 of file clusterFilterValidation.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_results

bool show_results = False

staticinherited

By default, do not show the browsing results.

Definition at line 62 of file mixins.py.

◆ simulation_output

simulation_output = None

staticinherited

By default, do no store the simulation output.

Definition at line 53 of file event_generation.py.

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

tracking/trackFindingCDC/studies/clusterFilter/clusterFilterValidation.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()

◆ postprocess()

◆ run()

Member Data Documentation

◆ allow_input

◆ bkg_files

◆ cluster_preparation_module

◆ components

◆ description

◆ detector_setup

◆ disable_deltas

◆ generator_module

◆ n_events

◆ n_events_to_skip

◆ n_processes

◆ output_file_name

◆ postprocess_only

◆ py_profile

◆ random_seed

◆ root_input_file

◆ show_results

◆ simulation_output