BrowseTFileOnTerminateRunMixin Class Reference

Inheritance diagram for BrowseTFileOnTerminateRunMixin:

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

Static Public Attributes
	output_file_name = None
	There is no default for the name of the output TFile.
bool	show_results = False
	By default, do not show the browsing results.
bool	postprocess_only = False
	By default, browse the output TFile too.
str	description = "Empty execution of basf2"
	Description of the run setup to be displayed on command line.

Detailed Description

Browse interactively the basf2 job output

Definition at line 56 of file mixins.py.

Member Function Documentation

adjust_path()

adjust_path ( self, path )

inherited

Hook that gives the opportunity to check the path for consistency before processing it

Reimplemented in VXDTF2TrackingValidation, and VXDTF2TrackingValidationBkg.

Definition at line 94 of file minimal.py.

    def adjust_path(self, path):
        """Hook that gives the opportunity to check the path for consistency before processing it"""
 
# Minimal run stub defining some general parameters
 
 

configure()

configure ( self, arguments )

inherited

Save the command-line arguments as key-value pairs

Reimplemented in ReadOrGenerateEventsRun.

Definition at line 73 of file minimal.py.

    def configure(self, arguments):
        """Save the command-line arguments as key-value pairs"""
        # Simply translate the arguments that have
        # the same name as valid instance arguments
        for (key, value) in list(vars(arguments).items()):
            if value is None:
                continue
            if hasattr(self, key):
                get_logger().info("Setting %s to %s", key, value)
                setattr(self, key, value)
 

configure_and_execute_from_commandline()

configure_and_execute_from_commandline ( self )

inherited

Configure basf2 job script from command-line arguments then run it

Definition at line 45 of file minimal.py.

    def configure_and_execute_from_commandline(self):
        """Configure basf2 job script from command-line arguments then run it"""
        self.configure_from_commandline()
        self.execute()
 

configure_from_commandline()

configure_from_commandline ( self )

inherited

Convert the command-line arguments to a basf2 job script

Definition at line 67 of file minimal.py.

    def configure_from_commandline(self):
        """Convert the command-line arguments to a basf2 job script"""
        argument_parser = self.create_argument_parser()
        arguments = argument_parser.parse_args()
        self.configure(arguments)
 

create_argument_parser()

create_argument_parser	(		self,
		**	kwds )

Parse the command-line TFile-browsing arguments

Reimplemented from PostProcessingRunMixin.

Reimplemented in ClusterFilterValidationRun, SegmentPairCreationValidationRun, and TrackingValidationRun.

Definition at line 64 of file mixins.py.

    def create_argument_parser(self, **kwds):
        """Parse the command-line TFile-browsing arguments"""
        argument_parser = super().create_argument_parser(**kwds)
 
        postprocess_argument_group = argument_parser
        for group in argument_parser._action_groups:
            if group.title == "Postprocessing arguments":
                postprocess_argument_group = group
                break
 
        postprocess_argument_group.add_argument(
            '-s',
            '--show',
            action='store_true',
            default=self.show_results,
            dest='show_results',
            help='Show generated plots in a TBrowser immediately.',)
 
        return argument_parser
 

create_path()

create_path ( self )

inherited

Create a new basf2 path

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

Definition at line 89 of file minimal.py.

    def create_path(self):
        """Create a new basf2 path"""
        path = basf2.create_path()
        return path
 

execute()

execute ( self )

inherited

Create the basf2 path then run the job

Reimplemented in ReadOrGenerateEventsRun.

Definition at line 50 of file minimal.py.

    def execute(self):
        """Create the basf2 path then run the job"""
        # Create path and run #
        
        path = self.create_path()
        self.adjust_path(path)
        self.run(path)
 

name()

name ( self )

inherited

provide name of this object

Definition at line 41 of file minimal.py.

    def name(self):
        """provide name of this object"""
        return self.__class__.__name__
 

postprocess()

postprocess

(

self

)

Browse the TFile interactively

Reimplemented from PostProcessingRunMixin.

Definition at line 84 of file mixins.py.

    def postprocess(self):
        """Browse the TFile interactively"""
        if self.show_results and self.output_file_name:
            with root_utils.root_open(self.output_file_name) as tfile:
                root_utils.root_browse(tfile)
                input("Close with return key.")
 
        super().postprocess()
 
 

run()

run ( self, path )

inherited

Post-process the basf2 job output

Reimplemented from EmptyRun.

Definition at line 45 of file mixins.py.

    def run(self, path):
        """Post-process the basf2 job output"""
        if not self.postprocess_only:
            super().run(path)
 
        self.postprocess()
 

Member Data Documentation

description

str description = "Empty execution of basf2"

staticinherited

Description of the run setup to be displayed on command line.

Definition at line 33 of file minimal.py.

output_file_name

output_file_name = None

static

There is no default for the name of the output TFile.

Definition at line 60 of file mixins.py.

postprocess_only

bool postprocess_only = False

staticinherited

By default, browse the output TFile too.

Post-process the basf2 job output

Definition at line 29 of file mixins.py.

show_results

bool show_results = False

static

By default, do not show the browsing results.

Definition at line 62 of file mixins.py.

---

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

• tracking/scripts/tracking/run/mixins.py