ValidationAndOptimisationTask Class Reference

Inheritance diagram for ValidationAndOptimisationTask:

Public Member Functions
	output (self)
	requires (self)
	create_optimisation_and_validation_path (self)
	create_path (self)
	remove_output (self)

Public Attributes
	job_name = self.task_id
	set the job name (inherited variable)

Static Public Attributes
	experiment_number = b2luigi.IntParameter()
	Experiment number of the conditions database, e.g.
	n_events_training = b2luigi.IntParameter()
	Number of events to generate for the training data set.
	fast_bdt_option
	FastBDT option to use to train the StateFilters.
	n_events_testing = b2luigi.IntParameter()
	Number of events to generate for the testing, validation, and optimisation data set.
	result_filter_cut = b2luigi.FloatParameter()
	Value of the cut on the MVA classifier output for a result candidate.
str	batch_system = 'lsf'
	batch system
str	queue = 's'
	queue

Detailed Description

Validate the performance of the trained filters by trying various combinations of FastBDT options, as well as cut values for
the states, the number of best candidates kept after each filter, and similar for the result filter.

Definition at line 590 of file cdc_and_svd_ckf_merger_mva_training.py.

Member Function Documentation

create_optimisation_and_validation_path()

create_optimisation_and_validation_path

(

self

)

Create a path to validate the trained filters.

Definition at line 642 of file cdc_and_svd_ckf_merger_mva_training.py.

    def create_optimisation_and_validation_path(self):
        """
        Create a path to validate the trained filters.
        """
        path = basf2.create_path()
 
        # get all the file names from the list of input files that are meant for optimisation / validation
        file_list = [fname for fname in self.get_all_input_file_names()
                     if "generated_mc_N" in fname and "optimisation" in fname and fname.endswith(".root")]
        path.add_module("RootInput", inputFileNames=file_list)
 
        path.add_module("Gearbox")
        path.add_module("Geometry")
        path.add_module("SetupGenfitExtrapolation")
 
        add_hit_preparation_modules(path, components=["SVD"])
 
        cdc_reco_tracks = "CDCRecoTracks"
        svd_reco_tracks = "SVDRecoTracks"
        reco_tracks = "RecoTracks"
        mc_reco_tracks = "MCRecoTracks"
 
        # CDC track finding and MC matching
        add_cdc_track_finding(path, output_reco_tracks=cdc_reco_tracks)
 
        path.add_module("DAFRecoFitter", recoTracksStoreArrayName=cdc_reco_tracks)
 
        # SVD track finding and MC matching
        add_svd_standalone_tracking(path, reco_tracks=svd_reco_tracks)
 
        direction = "backward"
        fbdt_string = create_fbdt_option_string(self.fast_bdt_option)
 
        # write the tracking MVA filter parameters and the cut on MVA classifier to be applied on a local db
        iov = [0, 0, 0, -1]
        write_tracking_mva_filter_payloads_to_db(
            f"trk_CDCToSVDSeedResultFilterParameter{fbdt_string}",
            iov,
            f"trk_CDCToSVDSeedResultFilter{fbdt_string}",
            self.result_filter_cut)
 
        basf2.conditions.prepend_testing_payloads("localdb/database.txt")
        result_filter_parameters = {"DBPayloadName": f"trk_CDCToSVDSeedResultFilterParameter{fbdt_string}"}
 
        path.add_module(
            "CDCToSVDSeedCKF",
            inputRecoTrackStoreArrayName=cdc_reco_tracks,
            fromRelationStoreArrayName=cdc_reco_tracks,
            toRelationStoreArrayName=svd_reco_tracks,
            relatedRecoTrackStoreArrayName=svd_reco_tracks,
            cdcTracksStoreArrayName=cdc_reco_tracks,
            vxdTracksStoreArrayName=svd_reco_tracks,
            relationCheckForDirection=direction,
            reverseSeed=False,
            firstHighFilterParameters={
                "direction": direction},
            advanceHighFilterParameters={
                "direction": direction},
            writeOutDirection=direction,
            endEarly=False,
            filter='mva_with_relations',
            filterParameters=result_filter_parameters
            )
 
        path.add_module('RelatedTracksCombiner',
                        VXDRecoTracksStoreArrayName=svd_reco_tracks,
                        CDCRecoTracksStoreArrayName=cdc_reco_tracks,
                        recoTracksStoreArrayName=reco_tracks)
 
        path.add_module('TrackFinderMCTruthRecoTracks',
                        RecoTracksStoreArrayName=mc_reco_tracks,
                        WhichParticles=[],
                        UsePXDHits=True,
                        UseSVDHits=True,
                        UseCDCHits=True)
 
        path.add_module("MCRecoTracksMatcher", UsePXDHits=False, UseSVDHits=True, UseCDCHits=True,
                        mcRecoTracksStoreArrayName=mc_reco_tracks,
                        prRecoTracksStoreArrayName=reco_tracks)
 
        path.add_module(
            CombinedTrackingValidationModule(
                output_file_name=self.get_output_file_name(
                    f"cdc_svd_merger_ckf_validation{fbdt_string}{self.result_filter_cut}.root"),
                reco_tracks_name=reco_tracks,
                mc_reco_tracks_name=mc_reco_tracks,
                name="",
                contact="",
                expert_level=200))
 
        return path
 

create_path()

create_path

(

self

)

Create basf2 path to process with event generation and simulation.

Definition at line 734 of file cdc_and_svd_ckf_merger_mva_training.py.

    def create_path(self):
        """
        Create basf2 path to process with event generation and simulation.
        """
        return self.create_optimisation_and_validation_path()
 

output()

output

(

self

)

Generate list of output files that the task should produce.
The task is considered finished if and only if the outputs all exist.

Definition at line 614 of file cdc_and_svd_ckf_merger_mva_training.py.

    def output(self):
        """
        Generate list of output files that the task should produce.
        The task is considered finished if and only if the outputs all exist.
        """
        fbdt_string = create_fbdt_option_string(self.fast_bdt_option)
        yield self.add_to_output(
            f"cdc_svd_merger_ckf_validation{fbdt_string}{self.result_filter_cut}.root")
 

remove_output()

remove_output

(

self

)

Default function from base b2luigi.Task class.

Definition at line 740 of file cdc_and_svd_ckf_merger_mva_training.py.

    def remove_output(self):
        """
        Default function from base b2luigi.Task class.
        """
        self._remove_output()
 
 

requires()

requires

(

self

)

This task requires trained result filters, and that an independent data set for validation was created using the
``SplitMergeSimTask`` with the random seed optimisation.

Definition at line 623 of file cdc_and_svd_ckf_merger_mva_training.py.

    def requires(self):
        """
        This task requires trained result filters, and that an independent data set for validation was created using the
        ``SplitMergeSimTask`` with the random seed optimisation.
        """
        yield CKFResultFilterTeacherTask(
            result_filter_records_name="filter_records.root",
            experiment_number=self.experiment_number,
            n_events_training=self.n_events_training,
            fast_bdt_option=self.fast_bdt_option,
            random_seed='training'
        )
        yield SplitNMergeSimTask(
            bkgfiles_dir=SummaryTask.bkgfiles_by_exp[self.experiment_number],
            experiment_number=self.experiment_number,
            n_events=self.n_events_testing,
            random_seed="optimisation",
        )
 

Member Data Documentation

batch_system

str batch_system = 'lsf'

staticinherited

batch system

Definition at line 177 of file cdc_and_svd_ckf_merger_mva_training.py.

experiment_number

experiment_number = b2luigi.IntParameter()

static

Experiment number of the conditions database, e.g.

defines simulation geometry.

Definition at line 597 of file cdc_and_svd_ckf_merger_mva_training.py.

fast_bdt_option

fast_bdt_option

static

Initial value:

=  b2luigi.ListParameter(
        # ## 
 
 
    )

FastBDT option to use to train the StateFilters.

Definition at line 601 of file cdc_and_svd_ckf_merger_mva_training.py.

job_name

job_name = self.task_id

inherited

set the job name (inherited variable)

Definition at line 185 of file cdc_and_svd_ckf_merger_mva_training.py.

n_events_testing

n_events_testing = b2luigi.IntParameter()

static

Number of events to generate for the testing, validation, and optimisation data set.

Definition at line 607 of file cdc_and_svd_ckf_merger_mva_training.py.

n_events_training

n_events_training = b2luigi.IntParameter()

static

Number of events to generate for the training data set.

Definition at line 599 of file cdc_and_svd_ckf_merger_mva_training.py.

queue

str queue = 's'

staticinherited

queue

Definition at line 179 of file cdc_and_svd_ckf_merger_mva_training.py.

result_filter_cut

result_filter_cut = b2luigi.FloatParameter()

static

Value of the cut on the MVA classifier output for a result candidate.

Definition at line 609 of file cdc_and_svd_ckf_merger_mva_training.py.

---

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

• tracking/scripts/ckf_training/cdc_and_svd_merger/cdc_and_svd_ckf_merger_mva_training.py