HarvestingRunMixin Class Reference

Inheritance diagram for HarvestingRunMixin:

Collaboration diagram for HarvestingRunMixin:

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	name (self)
def	configure_and_execute_from_commandline (self)
def	execute (self)
def	configure_from_commandline (self)
def	configure (self, arguments)
def	create_path (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	create_path (self)

Static Public Attributes
	output_file_name = None
	Disable the writing of an 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.
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.

Detailed Description

Harvester to select crops, postprocess, and inspect

Definition at line 8 of file run.py.

Member Function Documentation

adjust_path()

def adjust_path	(		self,
			path
	)

Add the harvester to the basf2 path

Reimplemented from EmptyRun.

Definition at line 58 of file run.py.

configure() [1/2]

def configure (   self,   arguments  )

inherited

Save the command-line arguments as key-value pairs

Reimplemented in CDCDisplayRun, and ReadOrGenerateEventsRun.

Definition at line 67 of file minimal.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 67 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 39 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 39 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 61 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 61 of file minimal.py.

create_argument_parser()

def create_argument_parser	(		self,
		**	kwds
	)

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

Reimplemented from PostProcessingRunMixin.

Reimplemented in ElossHarvestingRun, SegmentFitValidationRun, SegmentPairFitValidationRun, and LegendreBinningValidationRun.

Definition at line 18 of file run.py.

create_path() [1/2]

def create_path (   self )

inherited

Create a new basf2 path

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

Definition at line 83 of file minimal.py.

create_path() [2/2]

def create_path (   self )

inherited

Create a new basf2 path

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

Definition at line 83 of file minimal.py.

execute() [1/2]

def execute (   self )

inherited

Create the basf2 path then run the job

Reimplemented in ReadOrGenerateEventsRun.

Definition at line 44 of file minimal.py.

execute() [2/2]

def execute (   self )

inherited

Create the basf2 path then run the job

Reimplemented in ReadOrGenerateEventsRun.

Definition at line 44 of file minimal.py.

harvesting_module()

def harvesting_module	(		self,
			path = None
	)

This virtual method must be overridden by the inheriting class

Reimplemented in ElossHarvestingRun, SegmentFitValidationRun, SegmentPairFitValidationRun, and LegendreBinningValidationRun.

Definition at line 14 of file run.py.

name() [1/2]

def name (   self )

inherited

provide name of this object

Definition at line 35 of file minimal.py.

name() [2/2]

def name (   self )

inherited

provide name of this object

Definition at line 35 of file minimal.py.

pickle_crops()

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

Save the raw crops as a pickle file

Definition at line 33 of file run.py.

postprocess()

def postprocess

(

self

)

Post-process the crops

Reimplemented from PostProcessingRunMixin.

Definition at line 43 of file run.py.

run() [1/2]

def run (   self,   path  )

inherited

Post-process the basf2 job output

Reimplemented from EmptyRun.

Definition at line 38 of file mixins.py.

run() [2/2]

def run (   self,   path  )

inherited

Post-process the basf2 job output

Reimplemented from EmptyRun.

Definition at line 38 of file mixins.py.

unpickle_crops()

def unpickle_crops

(

self

)

Load the raw crops from a pickle file

Definition at line 38 of file run.py.

---

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

• tracking/scripts/tracking/harvest/run.py