SaveTreeRefiner Class Reference

Inheritance diagram for SaveTreeRefiner:

Public Member Functions
	__init__ (self, name=None, title=None)
	refine (self, harvesting_module, crops, tdirectory=None, groupby_part_name=None, groupby_value=None, **kwds)
	add_branch (self, output_ttree, part_name, parts)
	__get__ (self, harvesting_module, cls=None)
	__call__ (self, harvesting_module, crops=None, *args, **kwds)

Public Attributes
	name = name
	cached name for this TTree
	title = title
	cached title for this TTree
	refiner_function = refiner_function
	cached copy of the instance's refiner function

Static Public Attributes
str	default_name = "{module.id}_tree"
	default name for this TTree
str	default_title = "Tree of {module.id}"
	default title for this TTree

Detailed Description

Refiner for ROOT TTrees

Definition at line 817 of file refiners.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			name = None,
			title = None )

Constructor for this refiner

Definition at line 825 of file refiners.py.

                 title=None):
        """Constructor for this refiner"""
        super().__init__()
 
        ## cached name for this TTree
        self.name = name
        ## cached title for this TTree
        self.title = title
 

Member Function Documentation

__call__()

__call__ ( self, harvesting_module, crops = None, * args, ** kwds )

inherited

implementation of the function-call of the Refiner instance
     r = Refiner()
     r(harvester) # decoration
     r(harvester, crops, args, keywords) # refinement

Definition at line 55 of file refiners.py.

    def __call__(self, harvesting_module, crops=None, *args, **kwds):
        """implementation of the function-call of the Refiner instance
             r = Refiner()
             r(harvester) # decoration
             r(harvester, crops, args, keywords) # refinement
        """
        if crops is None:
            # Decoration mode
            harvesting_module.refiners.append(self)
            return harvesting_module
        else:
            # Refining mode
            return self.refine(harvesting_module, crops, *args, **kwds)
 

__get__()

__get__ ( self, harvesting_module, cls = None )

inherited

Getter of the Refiner instance

Definition at line 42 of file refiners.py.

    def __get__(self, harvesting_module, cls=None):
        """Getter of the Refiner instance"""
        if harvesting_module is None:
            # Class access
            return self
        else:
            # Instance access
            refine = self.refine
 
            def bound_call(*args, **kwds):
                return refine(harvesting_module, *args, **kwds)
            return bound_call
 

add_branch()

add_branch	(		self,
			output_ttree,
			part_name,
			parts )

Add a TBranch to the TTree

Definition at line 867 of file refiners.py.

    def add_branch(self, output_ttree, part_name, parts):
        """Add a TBranch to the TTree"""
        input_value = np.zeros(1, dtype=float)
 
        branch_type_spec = f'{part_name}/D'
        tbranch = output_ttree.Branch(part_name, input_value, branch_type_spec)
 
        if output_ttree.GetNbranches() == 1:
            # On filling of the first branch we need to use the fill method of the TTree
            # For all other branches we can use the one of the branch
            # #justrootthings
            for value in parts:
                input_value[0] = value
                output_ttree.Fill()
 
        else:
            for value in parts:
                input_value[0] = value
                tbranch.Fill()
 
        output_ttree.GetEntry(0)
        output_ttree.ResetBranchAddress(tbranch)
        also_subbranches = True  # No subbranches here but we drop the buffers just in case.
        output_ttree.DropBranchFromCache(tbranch, also_subbranches)
 
 

refine()

refine	(		self,
			harvesting_module,
			crops,
			tdirectory = None,
			groupby_part_name = None,
			groupby_value = None,
		**	kwds )

Process the TTree

Reimplemented from Refiner.

Definition at line 836 of file refiners.py.

               **kwds):
        """Process the TTree"""
 
        replacement_dict = dict(
            refiner=self,
            module=harvesting_module,
            groupby_key='_' + groupby_part_name + groupby_value if groupby_part_name else "",
            groupby=groupby_part_name,  # deprecated
            groupby_value=groupby_value,  # deprecated
        )
 
        with root_cd(tdirectory):
            name = self.name or self.default_name
            title = self.title or self.default_title
 
            name = formatter.format(name, **replacement_dict)
            title = formatter.format(title, **replacement_dict)
 
            output_ttree = ROOT.TTree(root_save_name(name), title)
            for part_name, parts in iter_items_sorted_for_key(crops):
                self.add_branch(output_ttree, part_name, parts)
 
            output_ttree.FlushBaskets()
            output_ttree.Write()
 

Member Data Documentation

default_name

str default_name = "{module.id}_tree"

static

default name for this TTree

Definition at line 821 of file refiners.py.

default_title

str default_title = "Tree of {module.id}"

static

default title for this TTree

Definition at line 823 of file refiners.py.

name

name = name

cached name for this TTree

Definition at line 832 of file refiners.py.

refiner_function

refiner_function = refiner_function

inherited

cached copy of the instance's refiner function

Definition at line 40 of file refiners.py.

title

title = title

cached title for this TTree

Definition at line 834 of file refiners.py.

---

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

• tracking/scripts/tracking/harvest/refiners.py