RootQuantityExtract Class Reference

Public Member Functions
	__init__ (self, extractor=None)
	addExtractor (self, class_type, extractor)
	extract (self, obj)

Public Attributes
	extractor = extractor
	the dictionary used for data extraction, key is the ROOT type and value a list of extractors

Detailed Description

Class to automatically extract quantities from ROOT Objects

Definition at line 84 of file quantity_extract.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			extractor = None )

Initialize the class with a set of quantity extractors

Definition at line 89 of file quantity_extract.py.

    def __init__(self, extractor=None):
        """
        Initialize the class with a set of quantity extractors
        """
 
        
        self.extractor = extractor
 
        if self.extractor is None:
            # use default
            self.extractor = default_extractor()
 

Member Function Documentation

addExtractor()

addExtractor	(		self,
			class_type,
			extractor )

Adds an extractor to this class

@param class_type: the string you get when
running <root_object>.IsA().GetName()
This is used to map the correct extractor to
this root object

Definition at line 102 of file quantity_extract.py.

    def addExtractor(self, class_type, extractor):
        """
        Adds an extractor to this class
 
        @param class_type: the string you get when
        running <root_object>.IsA().GetName()
        This is used to map the correct extractor to
        this root object
        """
 
        # check if extractors for this type are already
        # registered
        if class_type in self.extractor:
            self.extractor[class_type].append(extractor)
        else:
            self.extractor[class_type] = [extractor]
 

extract()

extract	(		self,
			obj )

Extract quantities from a root object

@return: a dictionary of extracted quantities

Definition at line 119 of file quantity_extract.py.

    def extract(self, obj):
        """
        Extract quantities from a root object
 
        @return: a dictionary of extracted quantities
        """
        this_class_type = obj.IsA().GetName()
 
        if this_class_type in self.extractor:
            ext_list = self.extractor[this_class_type]
 
            # run list of extractors
            # convert the returned tuple list to a dictionary
            result = []
            for x in ext_list:
                # run the extractor
                result_list = x(obj)
                result += result_list
            # convert the list of tuples into a dictionary
            return dict(result)
        else:
            # no extractors available for this type
            return {}

Member Data Documentation

extractor

extractor = extractor

the dictionary used for data extraction, key is the ROOT type and value a list of extractors

Definition at line 96 of file quantity_extract.py.

---

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

• validation/scripts/quantity_extract.py