HarvestingRunMixin Class Reference

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

Static Public Attributes
None	output_file_name = None
	Disable the writing of an output ROOT file.

Detailed Description

Harvester to select crops, postprocess, and inspect

Definition at line 16 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 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
 
 

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, LegendreBinningValidationRun, SegmentFitValidationRun, and SegmentPairFitValidationRun.

Definition at line 26 of file run.py.

    def create_argument_parser(self, **kwds):
        """Parse the arguments and append them to the harvester's list"""
        argument_parser = super().create_argument_parser(**kwds)
        harvesting_argument_group = argument_parser.add_argument_group("Harvest arguments")
 
        harvesting_argument_group.add_argument(
            "-o",
            "--output",
            dest="output_file_name",
            default=argparse.SUPPRESS,
            help="File name for the harvest products"
        )
 
        return argument_parser
 

harvesting_module()

def harvesting_module	(		self,
			path = None
	)

This virtual method must be overridden by the inheriting class

Reimplemented in ElossHarvestingRun, LegendreBinningValidationRun, SegmentFitValidationRun, and SegmentPairFitValidationRun.

Definition at line 22 of file run.py.

    def harvesting_module(self, path=None):
        """This virtual method must be overridden by the inheriting class"""
        raise RuntimeError("Override the harvesting_module method")
 

pickle_crops()

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

Save the raw crops as a pickle file

Definition at line 41 of file run.py.

    def pickle_crops(self, harvesting_module, crops, **kwds):
        """Save the raw crops as a pickle file"""
        with open(self.output_file_name + ".pickle", "wb") as pickle_file:
            pickle.dump(crops, pickle_file)
 

postprocess()

def postprocess

(

self

)

Post-process the crops

Reimplemented from PostProcessingRunMixin.

Definition at line 51 of file run.py.

    def postprocess(self):
        """Post-process the crops"""
        if self.postprocess_only:
            harvesting_module = self.harvesting_module()
            if self.output_file_name:
                harvesting_module.output_file_name = self.output_file_name
            try:
                crops = self.unpickle_crops()
            except FileNotFoundError:
                print("Crops pickle file not found. Create it now.")
            else:
                harvesting_module.refine(crops)
 
        super().postprocess()
 

unpickle_crops()

def unpickle_crops

(

self

)

Load the raw crops from a pickle file

Definition at line 46 of file run.py.

    def unpickle_crops(self):
        """Load the raw crops from a pickle file"""
        with open(self.output_file_name + ".pickle", "rb") as pickle_file:
            return pickle.load(pickle_file)
 

Member Data Documentation

output_file_name

None output_file_name = None

static

Disable the writing of an output ROOT file.

Reimplemented in ElossHarvestingRun, LegendreBinningValidationRun, SegmentFitValidationRun, and SegmentPairFitValidationRun.

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