Inheritance diagram for ElossHarvestingRun:

[legend]

Collaboration diagram for ElossHarvestingRun:

[legend]

Public Member Functions
def	output_file_name (self)

def	harvesting_module (self, path=None)

def	create_argument_parser (self, **kwds)

def	create_path (self)

def	pickle_crops (self, harvesting_module, crops, **kwds)

def	unpickle_crops (self)

def	postprocess (self)

def	adjust_path (self, path)

def	run (self, path)

def	run (self, path)

def	name (self)

def	name (self)

def	name (self)

def	configure_and_execute_from_commandline (self)

def	configure_and_execute_from_commandline (self)

def	configure_and_execute_from_commandline (self)

def	execute (self)

def	execute (self)

def	execute (self)

def	configure_from_commandline (self)

def	configure_from_commandline (self)

def	configure_from_commandline (self)

def	configure (self, arguments)

def	configure (self, arguments)

def	configure (self, arguments)

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

Static Public Attributes
int	n_events = 10000
	number of events to generate

string	generator_module = "eloss_gun"
	use the eloss_gun particle generator

string	detector_setup = "TrackingDetectorConstB"
	use the tracking-detector subset with constant magnetic field for the geometry

	output_file_name = None
	Disable the writing of an output ROOT file. More...

bool	show_results = False
	By default, do not show the browsing results.

bool	postprocess_only = False
	By default, browse the output TFile too.

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	description = "Empty execution of basf2"
	Description of the run setup to be displayed on command line.

string	description = "Simulate events using various generator and detector setups from command line."
	Description of the run setup to be displayed on command line.

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

Harvester to generate, postprocess and inspect MC events for energy-loss evaluation

Definition at line 100 of file record.py.

Member Function Documentation

◆ adjust_path()

def adjust_path	(	self,
		path
	)

inherited

Add the harvester to the basf2 path

Reimplemented from EmptyRun.

Definition at line 66 of file run.py.

     def adjust_path(self, path):
         """Add the harvester to the basf2 path"""
         super().adjust_path(path)
         harvesting_module = self.harvesting_module()
         if self.output_file_name:
             harvesting_module.output_file_name = self.output_file_name
         harvesting_module.refiners.append(self.pickle_crops)
         path.add_module(harvesting_module)
         return path
  
  

◆ configure() [1/3]

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/3]

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

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/3]

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/3]

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

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/3]

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/3]

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

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

Definition at line 121 of file record.py.

     def create_argument_parser(self, **kwds):
         """Convert command-line arguments to basf2 argument list"""
         argument_parser = super().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 126 of file record.py.

◆ execute() [1/3]

def execute ( self )

inherited

Run the basf2 job

Reimplemented from EmptyRun.

Definition at line 131 of file event_generation.py.

◆ execute() [2/3]

def execute ( self )

inherited

Create the basf2 path then run the job

Reimplemented in ReadOrGenerateEventsRun.

Definition at line 51 of file minimal.py.

◆ execute() [3/3]

def execute ( self )

inherited

Create the basf2 path then run the job

Reimplemented in ReadOrGenerateEventsRun.

Definition at line 51 of file minimal.py.

◆ harvesting_module()

def harvesting_module	(	self,
		path = `None`
	)

Harvest and post-process the generated events

Reimplemented from HarvestingRunMixin.

Definition at line 114 of file record.py.

◆ name() [1/3]

def name ( self )

inherited

provide name of this object

Definition at line 42 of file minimal.py.

◆ name() [2/3]

def name ( self )

inherited

provide name of this object

Definition at line 42 of file minimal.py.

◆ name() [3/3]

def name ( self )

inherited

provide name of this object

Definition at line 42 of file minimal.py.

◆ output_file_name()

def output_file_name ( self )

Get the output ROOT filename

Definition at line 110 of file record.py.

◆ pickle_crops()

def pickle_crops	(		self,
			harvesting_module,
			crops,
		**	kwds
	)

inherited

Save the raw crops as a pickle file

Definition at line 41 of file run.py.

◆ postprocess()

def postprocess ( self )

inherited

Post-process the crops

Reimplemented from PostProcessingRunMixin.

Definition at line 51 of file run.py.

◆ run() [1/2]

def run	(	self,
		path
	)

inherited

Post-process the basf2 job output

Reimplemented from EmptyRun.

Definition at line 46 of file mixins.py.

◆ run() [2/2]

def run	(	self,
		path
	)

inherited

Post-process the basf2 job output

Reimplemented from EmptyRun.

Definition at line 46 of file mixins.py.

◆ unpickle_crops()

def unpickle_crops ( self )

inherited

Load the raw crops from a pickle file

Definition at line 46 of file run.py.

Member Data Documentation

◆ output_file_name

output_file_name = None

staticinherited

Disable the writing of an output ROOT file.

Harvester to select crops, postprocess, and inspect

Definition at line 20 of file run.py.

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

tracking/trackFindingCDC/studies/eloss/record.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ adjust_path()

◆ configure() [1/3]

◆ configure() [2/3]

◆ configure() [3/3]

◆ configure_and_execute_from_commandline() [1/3]

◆ configure_and_execute_from_commandline() [2/3]

◆ configure_and_execute_from_commandline() [3/3]

◆ configure_from_commandline() [1/3]

◆ configure_from_commandline() [2/3]

◆ configure_from_commandline() [3/3]

◆ create_argument_parser()

◆ create_path()

◆ execute() [1/3]

◆ execute() [2/3]

◆ execute() [3/3]

◆ harvesting_module()

◆ name() [1/3]

◆ name() [2/3]

◆ name() [3/3]

◆ output_file_name()

◆ pickle_crops()

◆ postprocess()

◆ run() [1/2]

◆ run() [2/2]

◆ unpickle_crops()

Member Data Documentation

◆ output_file_name