FacetFilterTrainingRun Class Reference

Inheritance diagram for FacetFilterTrainingRun:

Collaboration diagram for FacetFilterTrainingRun:

Public Member Functions
def	identifier (self)
def	create_argument_parser (self, **kwds)
def	create_path (self)
def	configure (self, arguments)
def	execute (self)
def	name (self)
def	configure_and_execute_from_commandline (self)
def	run (self, path)
def	configure_from_commandline (self)
def	adjust_path (self, path)

Public Attributes
	task
	Post-process events according to the user's desired task (train, eval, explore)
	variables
	Signal some variables to select in the classification analysis.
	root_input_file
	generating events, so there is no ROOT input file

Static Public Attributes
int	n_events = 100
	Suggested number for this analysis.
string	generator_module = "generic"
	Suggested generator module.
string	task = "explore"
	Default task set to explore.
string	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.
string	description = "Simulate events using various generator and detector setups from command line."
	Description of the run setup to be displayed on command line.
string	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.
	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

Run for recording facets encountered at the filter

Definition at line 24 of file trainFacetFilter.py.

Member Function Documentation

adjust_path()

def adjust_path (   self,   path  )

inherited

Hook that gives the opportunity to check the path for consistency before processing it

Reimplemented in HarvestingRunMixin.

Definition at line 95 of file minimal.py.

configure()

def configure (   self,   arguments  )

inherited

Configure for basf2 job; disable ROOT input if simulating events

Reimplemented from EmptyRun.

Reimplemented in CDCDisplayRun.

Definition at line 123 of file event_generation.py.

configure_and_execute_from_commandline()

def configure_and_execute_from_commandline (   self )

inherited

Configure basf2 job script from command-line arguments then run it

Definition at line 46 of file minimal.py.

configure_from_commandline()

def configure_from_commandline (   self )

inherited

Convert the command-line arguments to a basf2 job script

Definition at line 68 of file minimal.py.

create_argument_parser()

def create_argument_parser	(		self,
		**	kwds
	)

Convert command-line arguments to basf2 argument list

Reimplemented from ReadOrGenerateEventsRun.

Definition at line 50 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()

def 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 73 of file trainFacetFilter.py.

execute()

def execute (   self )

inherited

Run the basf2 job

Reimplemented from EmptyRun.

Definition at line 131 of file event_generation.py.

identifier()

def identifier

(

self

)

Database identifier of the filter being trained

Definition at line 46 of file trainFacetFilter.py.

name()

def name (   self )

inherited

provide name of this object

Definition at line 42 of file minimal.py.

run()

def run (   self,   path  )

inherited

Process the basf2 path

Reimplemented in PostProcessingRunMixin.

Definition at line 59 of file minimal.py.

---

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

• tracking/trackFindingCDC/train/trainFacetFilter.py