RunMixin Class Reference

Inheritance diagram for RunMixin:

Collaboration diagram for RunMixin:

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

Static Public Attributes
string	description = "Empty execution of basf2"
	Description of the run setup to be displayed on command line.

Detailed Description

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

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()

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  )

inherited

Parse the command-line arguments to a basf2 job script

Reimplemented in FacetFilterTrainingRun, SegmentPairFitValidationRun, SegmentPairCreationValidationRun, SegmentFitValidationRun, LegendreBinningValidationRun, ElossHarvestingRun, ClusterFilterValidationRun, WireHitPreparerRunMixin, TrainingRunMixin, CDCDisplayRun, TrackingValidationRun, ReadOrGenerateTrackedEventsRun, RootOutputRunMixin, BrowseTFileOnTerminateRunMixin, PostProcessingRunMixin, MinimalRun, ReadOrGenerateEventsRun, and HarvestingRunMixin.

Definition at line 85 of file minimal.py.

create_path()

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()

def execute (   self )

inherited

Create the basf2 path then run the job

Reimplemented in ReadOrGenerateEventsRun.

Definition at line 51 of file minimal.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/scripts/tracking/run/mixins.py