Inheritance diagram for StateRecordingTask:

Public Member Functions
	output (self)

	requires (self)

	create_state_recording_path (self, layer, records1_fname, records2_fname, records3_fname)

	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.

	random_seed = b2luigi.Parameter()
	Random basf2 seed.

	n_events = b2luigi.IntParameter()
	Number of events to generate for training.

	layer = b2luigi.IntParameter()
	Layer on which to toggle for recording the information for training.

str	batch_system = 'lsf'
	batch system

str	queue = 's'
	queue

Detailed Description

Record the data for the three state filters for the CDCToSVDSpacePointCKF.

This task requires that the events used for training have been simulated before, which is done using the
``SplitMergeSimTask``.

Definition at line 389 of file combined_cdc_to_svd_ckf_mva_training.py.

Member Function Documentation

◆ create_path()

create_path ( self )

Create basf2 path to process with event generation and simulation.

Definition at line 507 of file combined_cdc_to_svd_ckf_mva_training.py.

    def create_path(self):
        """
        Create basf2 path to process with event generation and simulation.
        """
        return self.create_state_recording_path(
            layer=self.layer,
            records1_fname=self.get_output_file_name("records1.root"),
            records2_fname=self.get_output_file_name("records2.root"),
            records3_fname=self.get_output_file_name("records3.root"),
        )
 

◆ create_state_recording_path()

create_state_recording_path	(	self,
		layer,
		records1_fname,
		records2_fname,
		records3_fname )

Create a path for the recording. To record the data for the SVD state filters, CDC tracks are required, and these must
be truth matched before. The data have to recorded for each layer of the SVD, i.e. layers 3 to 6, but also an artificial
layer 7.

:param layer: The layer for which the data are recorded.
:param records1_fname: Name of the records1 file.
:param records2_fname: Name of the records2 file.
:param records3_fname: Name of the records3 file.

Definition at line 426 of file combined_cdc_to_svd_ckf_mva_training.py.

    def create_state_recording_path(self, layer, records1_fname, records2_fname, records3_fname):
        """
        Create a path for the recording. To record the data for the SVD state filters, CDC tracks are required, and these must
        be truth matched before. The data have to recorded for each layer of the SVD, i.e. layers 3 to 6, but also an artificial
        layer 7.
 
        :param layer: The layer for which the data are recorded.
        :param records1_fname: Name of the records1 file.
        :param records2_fname: Name of the records2 file.
        :param records3_fname: Name of the records3 file.
        """
        path = basf2.create_path()
 
        # get all the file names from the list of input files that are meant for training
        file_list = [fname for fname in self.get_all_input_file_names()
                     if "generated_mc_N" in fname and "training" 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"])
 
        add_track_finding(path, reco_tracks="CDCRecoTracks", components=["CDC"], prune_temporary_tracks=False)
 
        path.add_module('TrackFinderMCTruthRecoTracks',
                        RecoTracksStoreArrayName="MCRecoTracks",
                        WhichParticles=[],
                        UsePXDHits=True,
                        UseSVDHits=True,
                        UseCDCHits=True)
 
        path.add_module("MCRecoTracksMatcher", UsePXDHits=False, UseSVDHits=False, UseCDCHits=True,
                        mcRecoTracksStoreArrayName="MCRecoTracks",
                        prRecoTracksStoreArrayName="CDCRecoTracks")
        path.add_module("DAFRecoFitter", recoTracksStoreArrayName="CDCRecoTracks")
 
        path.add_module("CDCToSVDSpacePointCKF",
                        inputRecoTrackStoreArrayName="CDCRecoTracks",
                        outputRecoTrackStoreArrayName="VXDRecoTracks",
                        outputRelationRecoTrackStoreArrayName="CDCRecoTracks",
 
                        relationCheckForDirection="backward",
                        reverseSeed=False,
                        writeOutDirection="backward",
 
                        firstHighFilter="truth",
                        firstEqualFilter="recording",
                        firstEqualFilterParameters={"treeName": "records1", "rootFileName":
                                                    records1_fname, "returnWeight": 1.0},
                        firstLowFilter="none",
                        firstHighUseNStates=0,
                        firstToggleOnLayer=layer,
 
                        advanceHighFilter="advance",
 
                        secondHighFilter="truth",
                        secondEqualFilter="recording",
                        secondEqualFilterParameters={"treeName": "records2", "rootFileName":
                                                     records2_fname, "returnWeight": 1.0},
                        secondLowFilter="none",
                        secondHighUseNStates=0,
                        secondToggleOnLayer=layer,
 
                        updateHighFilter="fit",
 
                        thirdHighFilter="truth",
                        thirdEqualFilter="recording",
                        thirdEqualFilterParameters={"treeName": "records3", "rootFileName": records3_fname},
                        thirdLowFilter="none",
                        thirdHighUseNStates=0,
                        thirdToggleOnLayer=layer,
 
                        filter="none",
                        exportTracks=False,
 
                        enableOverlapResolving=False)
 
        return 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 407 of file combined_cdc_to_svd_ckf_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.
        """
        for record_fname in ["records1.root", "records2.root", "records3.root"]:
            yield self.add_to_output(record_fname)
 

◆ remove_output()

remove_output ( self )

Default function from base b2luigi.Task class.

Definition at line 518 of file combined_cdc_to_svd_ckf_mva_training.py.

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

◆ requires()

requires ( self )

This task only requires that the input files have been created.

Definition at line 415 of file combined_cdc_to_svd_ckf_mva_training.py.

    def requires(self):
        """
        This task only requires that the input files have been created.
        """
        yield SplitNMergeSimTask(
            bkgfiles_dir=SummaryTask.bkgfiles_by_exp[self.experiment_number],
            experiment_number=self.experiment_number,
            random_seed=self.random_seed,
            n_events=self.n_events,
        )
 

Member Data Documentation

◆ batch_system

str batch_system = 'lsf'

staticinherited

batch system

Definition at line 189 of file combined_cdc_to_svd_ckf_mva_training.py.

◆ experiment_number

experiment_number = b2luigi.IntParameter()

static

Experiment number of the conditions database, e.g.

defines simulation geometry

Definition at line 397 of file combined_cdc_to_svd_ckf_mva_training.py.

◆ job_name

job_name = self.task_id

inherited

set the job name (inherited variable)

Definition at line 197 of file combined_cdc_to_svd_ckf_mva_training.py.

◆ layer

layer = b2luigi.IntParameter()

static

Layer on which to toggle for recording the information for training.

Definition at line 405 of file combined_cdc_to_svd_ckf_mva_training.py.

◆ n_events

n_events = b2luigi.IntParameter()

static

Number of events to generate for training.

Definition at line 402 of file combined_cdc_to_svd_ckf_mva_training.py.

◆ queue

str queue = 's'

staticinherited

queue

Definition at line 191 of file combined_cdc_to_svd_ckf_mva_training.py.

◆ random_seed

random_seed = b2luigi.Parameter()

static

Random basf2 seed.

It is further used to read of the production process to preserve clearness in the b2luigi output.

Definition at line 400 of file combined_cdc_to_svd_ckf_mva_training.py.

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

tracking/scripts/ckf_training/cdc_to_svd_spacepoint/combined_cdc_to_svd_ckf_mva_training.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ create_path()

◆ create_state_recording_path()

◆ output()

◆ remove_output()

◆ requires()

Member Data Documentation

◆ batch_system

◆ experiment_number

◆ job_name

◆ layer

◆ n_events

◆ queue

◆ random_seed