ClusterFilterValidationRun Class Reference

Inheritance diagram for ClusterFilterValidationRun:

Collaboration diagram for ClusterFilterValidationRun:

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

Public Attributes
	root_input_file
	generating events, so there is no ROOT input file

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
string	output_file_name = "ClusterFilterValidation.root"
	output ROOT file
bool	show_results = False
	By default, do not show the browsing results.
bool	postprocess_only = False
	By default, browse the output TFile too.
string	description = "Empty execution of basf2"
	Description of the run setup to be displayed on command line.
string	generator_module = "EvtGenInput"
	Use EvtGen for the event generator.
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.
int	n_events = 10000
	By default, process 10000 events.
	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 35 of file clusterFilterValidation.py.

Member Function Documentation

adjust_path() [1/2]

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.

adjust_path() [2/2]

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() [1/2]

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() [2/2]

def configure (   self,   arguments  )

inherited

Save the command-line arguments as key-value pairs

Reimplemented in CDCDisplayRun, and ReadOrGenerateEventsRun.

Definition at line 74 of file minimal.py.

configure_and_execute_from_commandline() [1/2]

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_and_execute_from_commandline() [2/2]

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() [1/2]

def configure_from_commandline (   self )

inherited

Convert the command-line arguments to a basf2 job script

Definition at line 68 of file minimal.py.

configure_from_commandline() [2/2]

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
	)

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

Reimplemented from BrowseTFileOnTerminateRunMixin.

Definition at line 45 of file clusterFilterValidation.py.

    def create_argument_parser(self, **kwds):
        """Configure the basf2 job script using the translated command-line arguments"""
        argument_parser = super(ClusterFilterValidationRun, self).create_argument_parser(**kwds)
        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 50 of file clusterFilterValidation.py.

execute() [1/2]

def execute (   self )

inherited

Run the basf2 job

Reimplemented from EmptyRun.

Definition at line 131 of file event_generation.py.

execute() [2/2]

def execute (   self )

inherited

Create the basf2 path then run the job

Reimplemented in ReadOrGenerateEventsRun.

Definition at line 51 of file minimal.py.

name() [1/2]

def name (   self )

inherited

provide name of this object

Definition at line 42 of file minimal.py.

name() [2/2]

def name (   self )

inherited

provide name of this object

Definition at line 42 of file minimal.py.

postprocess()

def postprocess (   self )

inherited

Browse the TFile interactively

Reimplemented from PostProcessingRunMixin.

Reimplemented in TrainingRunMixin, and HarvestingRunMixin.

Definition at line 85 of file mixins.py.

run()

def run (   self,   path  )

inherited

Post-process the basf2 job output

Reimplemented from EmptyRun.

Definition at line 46 of file mixins.py.

---

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

• tracking/trackFindingCDC/studies/clusterFilter/clusterFilterValidation.py