HarvestingRun Class Reference

Inheritance diagram for HarvestingRun:

Collaboration diagram for HarvestingRun:

Public Member Functions
def	harvesting_module (self, path=None)
def	create_argument_parser (self, **kwds)
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	configure_and_execute_from_commandline (self)
def	configure_and_execute_from_commandline (self)
def	execute (self)
def	execute (self)
def	configure_from_commandline (self)
def	configure_from_commandline (self)
def	configure (self, arguments)
def	configure (self, arguments)
def	create_path (self)
def	create_path (self)
def	create_argument_parser (self, **kwds)
def	configure (self, arguments)
def	execute (self)
def	create_path (self)
def	name (self)
def	configure_and_execute_from_commandline (self)
def	configure_from_commandline (self)

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

Static Public Attributes
	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	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

Harvester to generate MC events followed by crop selection, postprocessing, inspection

Definition at line 77 of file run.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.

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

def create_argument_parser (   self, **  kwds  )

inherited

Parse the arguments and append them to the harvester's list

Reimplemented from PostProcessingRunMixin.

Reimplemented in SegmentPairFitValidationRun, SegmentFitValidationRun, LegendreBinningValidationRun, and ElossHarvestingRun.

Definition at line 26 of file run.py.

create_argument_parser() [2/2]

def create_argument_parser (   self, **  kwds  )

inherited

Convert command-line arguments to basf2 argument list

Reimplemented from MinimalRun.

Reimplemented in FacetFilterTrainingRun, SegmentPairFitValidationRun, SegmentPairCreationValidationRun, SegmentFitValidationRun, LegendreBinningValidationRun, ElossHarvestingRun, ClusterFilterValidationRun, CDCDisplayRun, TrackingValidationRun, and ReadOrGenerateTrackedEventsRun.

Definition at line 56 of file event_generation.py.

create_path() [1/3]

def create_path (   self )

inherited

Create and configure the basf2 path

Reimplemented from MinimalRun.

Reimplemented in TrackFilterTrainingRun, SegmentTrackFilterTrainingRun, RealisticTrackRelationFilterTrainingRun, RealisticSegmentRelationFilterTrainingRun, RealisticSegmentPairRelationFilterTrainingRun, RealisticSegmentPairFilterTrainingRun, RealisticAxialSegmentPairFilterTrainingRun, FeasibleTrackRelationFilterTrainingRun, FeasibleSegmentRelationFilterTrainingRun, FeasibleSegmentPairFilterTrainingRun, FeasibleAxialSegmentPairFilterTrainingRun, FacetRelationFilterTrainingRun, FacetFilterTrainingRun, BackgroundClusterFilterTrainingRun, SegmentPairFitValidationRun, SegmentPairCreationValidationRun, SegmentFitValidationRun, FitValidation, LegendreBinningValidationRun, ElossHarvestingRun, ClusterFilterValidationRun, CDCDisplayRun, SegmentQuadTreeRun, TrackingValidationRun, and ReadOrGenerateTrackedEventsRun.

Definition at line 141 of file event_generation.py.

create_path() [2/3]

def create_path (   self )

inherited

Create a new basf2 path

Reimplemented in TrackFilterTrainingRun, SegmentTrackFilterTrainingRun, RealisticTrackRelationFilterTrainingRun, RealisticSegmentRelationFilterTrainingRun, RealisticSegmentPairRelationFilterTrainingRun, RealisticSegmentPairFilterTrainingRun, RealisticAxialSegmentPairFilterTrainingRun, FeasibleTrackRelationFilterTrainingRun, FeasibleSegmentRelationFilterTrainingRun, FeasibleSegmentPairFilterTrainingRun, FeasibleAxialSegmentPairFilterTrainingRun, FacetRelationFilterTrainingRun, FacetFilterTrainingRun, BackgroundClusterFilterTrainingRun, SegmentPairFitValidationRun, SegmentPairCreationValidationRun, SegmentFitValidationRun, FitValidation, LegendreBinningValidationRun, ElossHarvestingRun, ClusterFilterValidationRun, WireHitPreparerRunMixin, CDCDisplayRun, SegmentQuadTreeRun, TrackingValidationRun, ReadOrGenerateTrackedEventsRun, RootOutputRunMixin, MinimalRun, and ReadOrGenerateEventsRun.

Definition at line 90 of file minimal.py.

create_path() [3/3]

def create_path (   self )

inherited

Create a new basf2 path

Reimplemented in TrackFilterTrainingRun, SegmentTrackFilterTrainingRun, RealisticTrackRelationFilterTrainingRun, RealisticSegmentRelationFilterTrainingRun, RealisticSegmentPairRelationFilterTrainingRun, RealisticSegmentPairFilterTrainingRun, RealisticAxialSegmentPairFilterTrainingRun, FeasibleTrackRelationFilterTrainingRun, FeasibleSegmentRelationFilterTrainingRun, FeasibleSegmentPairFilterTrainingRun, FeasibleAxialSegmentPairFilterTrainingRun, FacetRelationFilterTrainingRun, FacetFilterTrainingRun, BackgroundClusterFilterTrainingRun, SegmentPairFitValidationRun, SegmentPairCreationValidationRun, SegmentFitValidationRun, FitValidation, LegendreBinningValidationRun, ElossHarvestingRun, ClusterFilterValidationRun, WireHitPreparerRunMixin, CDCDisplayRun, SegmentQuadTreeRun, TrackingValidationRun, ReadOrGenerateTrackedEventsRun, RootOutputRunMixin, MinimalRun, and ReadOrGenerateEventsRun.

Definition at line 90 of file minimal.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  )

inherited

This virtual method must be overridden by the inheriting class

Reimplemented in SegmentPairFitValidationRun, SegmentFitValidationRun, LegendreBinningValidationRun, and ElossHarvestingRun.

Definition at line 22 of file run.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.

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/scripts/tracking/harvest/run.py