Inheritance diagram for FacetFilterTrainingRun:

Public Member Functions
	identifier (self)

	create_argument_parser (self, **kwds)

	create_path (self)

	configure (self, arguments)

	execute (self)

	name (self)

	configure_and_execute_from_commandline (self)

	run (self, path)

	configure_from_commandline (self)

	adjust_path (self, path)

Public Attributes
list	variables
	Signal some variables to select in the classification analysis.

Static Public Attributes
str	task = "explore"
	Default task set to explore.

str	truth = "truth_positive"
	Name of the truth variables.

bool	flight_time_reestimation = False
	Option whether to reestimate the drift length.

bool	facet_least_square_fit = False
	Option whether to use the least square fit to the hit triplet.

	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


Run for recording facets encountered at the filter

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

◆ configure()

configure	(		self,
			arguments )

inherited


Configure for basf2 job; disable ROOT input if simulating events

Reimplemented from EmptyRun.

Reimplemented in CDCDisplayRun.

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 )


Convert command-line arguments to basf2 argument list

Reimplemented from ReadOrGenerateEventsRun.

Definition at line 49 of file trainFacetFilter.py.

    def create_argument_parser(self, **kwds):
        """Convert command-line arguments to basf2 argument list"""
 
        argument_parser = super().create_argument_parser(**kwds)
 
        argument_parser.add_argument(
            "-fr",
            "--flight-time-reestimation",
            action="store_true",
            dest="flight_time_reestimation",
            help="Switch to reestimate drift length before fitting."
        )
 
        argument_parser.add_argument(
            "-fl",
            "--facet-least-square-fit",
            action="store_true",
            dest="facet_least_square_fit",
            help="Switch to fit the facet with least square method for the drift length update"
        )
 
        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 ReadOrGenerateEventsRun.

Definition at line 72 of file trainFacetFilter.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.
        """
 
        path = super().create_path()
 
        
        if self.task == "train":
            var_sets = [
                "mva",
                "filter(truth)",
            ]
 
        elif self.task == "eval":
            var_sets = [
                "filter(chi2)",
                "filter(realistic)",
                "filter(mva)",
                "filter(truth)",
            ]
 
        elif self.task == "explore":
            var_sets = [
                "basic",
                "truth",
                "bend",
                "fit",
                "filter(truth)",
                "filter(realistic)",
                "filter(chi2)",
            ]
 
            
            self.variables = [
                "curv",
                "curv_pull",
                "middle_phi_pull",
                "middle_chi2",
                "fit_0_phi0_sigma",
                "chi2_0",
                "chi2_0_per_s",
                "fit_1_phi0_sigma",
                "chi2_1",
                "chi2_1_per_s",
                "fit_phi0_sigma",
                "chi2 chi2_per_s",
                "realistic_accept",
                "chi2_accept",
            ]
 
        path.add_module("TFCDC_WireHitPreparer",
                        flightTimeEstimation="outwards",
                        UseNLoops=1.0)
 
        path.add_module("TFCDC_ClusterPreparer")
 
        path.add_module("TFCDC_SegmentFinderFacetAutomaton",
                        FacetUpdateDriftLength=self.flight_time_reestimation,
                        FacetLeastSquareFit=self.facet_least_square_fit,
                        FacetFilter="unionrecording",
                        FacetFilterParameters={
                            "rootFileName": self.sample_file_name,
                            "varSets": var_sets,
                        },
                        FacetRelationFilter="none")
 
        return 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)
 

◆ identifier()

identifier ( self )


Database identifier of the filter being trained

Definition at line 45 of file trainFacetFilter.py.

45 def identifier(self):

46 """Database identifier of the filter being trained"""

47 return "trackfindingcdc_FacetFilter.xml"

48

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

◆ facet_least_square_fit

bool facet_least_square_fit = False

static

Option whether to use the least square fit to the hit triplet.

Definition at line 42 of file trainFacetFilter.py.

◆ flight_time_reestimation

bool flight_time_reestimation = False

static

Option whether to reestimate the drift length.

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

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

◆ task

str task = "explore"

static

Default task set to explore.

Definition at line 33 of file trainFacetFilter.py.

◆ truth

str truth = "truth_positive"

static

Name of the truth variables.

Definition at line 36 of file trainFacetFilter.py.

◆ variables

list variables

Initial value:

=  [
                "curv",
                "curv_pull",
                "middle_phi_pull",
                "middle_chi2",
                "fit_0_phi0_sigma",
                "chi2_0",
                "chi2_0_per_s",
                "fit_1_phi0_sigma",
                "chi2_1",
                "chi2_1_per_s",
                "fit_phi0_sigma",
                "chi2 chi2_per_s",
                "realistic_accept",
                "chi2_accept",
            ]

Signal some variables to select in the classification analysis.

Definition at line 107 of file trainFacetFilter.py.

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

tracking/trackFindingCDC/train/trainFacetFilter.py

Public Member Functions

Public Attributes

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

◆ identifier()

◆ name()

◆ run()

Member Data Documentation

◆ allow_input

◆ bkg_files

◆ components

◆ description

◆ detector_setup

◆ disable_deltas

◆ facet_least_square_fit

◆ flight_time_reestimation

◆ generator_module

◆ n_events

◆ n_events_to_skip

◆ n_processes

◆ random_seed

◆ root_input_file

◆ simulation_output

◆ task

◆ truth

◆ variables