extractor_dict.expMetaData Class Reference

Inheritance diagram for extractor_dict.expMetaData:

Public Member Functions
def	__init__ (self, expname, inputfile)
def	translateKey (self, key)
def	md_gen (self, mdart, md0={})
def	getmetadata (self, md0={})
Public Member Functions inherited from extractor_dict.MetaData
def	__init__ (self, inputfile)
def	extract_metadata_to_pipe (self)
def	get_job (self, proc)

Public Attributes
	expname
	translateKeyf
	md
Public Attributes inherited from extractor_dict.MetaData
	inputfile

Additional Inherited Members
Static Public Member Functions inherited from extractor_dict.MetaData
def	wait_for_subprocess (jobinfo, q)
def	mdart_gen (jobtuple)
def	md_handle_application (md)

Detailed Description

Class to hold/interpret experiment-specific metadata

Definition at line 98 of file extractor_dict.py.

Constructor & Destructor Documentation

def extractor_dict.expMetaData.__init__	(		self,
			expname,
			inputfile
	)

Definition at line 100 of file extractor_dict.py.

    def __init__(self, expname, inputfile):
        MetaData.__init__(self, inputfile)
        self.expname = expname
        #self.exp_md_keyfile = expname + '_metadata_key'
        try:
            #translateMetaData = __import__("experiment_utilities", "MetaDataKey")
            from experiment_utilities import MetaDataKey
        except ImportError:
            print("You have not defined an experiment-specific metadata and key-translating module in experiment_utilities. Exiting")
            raise

        metaDataModule = MetaDataKey()
        self.metadataList, self.translateKeyf = metaDataModule.metadataList(), metaDataModule.translateKey

Member Function Documentation

def extractor_dict.expMetaData.getmetadata	(		self,
			md0 = {}
	)

Get metadata from input file and return as python dictionary.
Calls other methods in class and returns metadata dictionary

Definition at line 235 of file extractor_dict.py.

    def getmetadata(self, md0={}):
        """ Get metadata from input file and return as python dictionary.
        Calls other methods in class and returns metadata dictionary"""
        proc = self.extract_metadata_to_pipe()
        jobt = self.get_job(proc)
        mdart = self.mdart_gen(jobt)
        return self.md_gen(mdart, md0)  

def extractor_dict.expMetaData.md_gen	(		self,
			mdart,
			md0 = {}
	)

Loop through art metdata, generate metadata dictionary

Definition at line 118 of file extractor_dict.py.

    def md_gen(self, mdart, md0={}):
        """Loop through art metdata, generate metadata dictionary"""
        # define an empty python dictionary which will hold sam metadata.
        # Some fields can be copied directly from art metadata to sam metadata.
        # Other fields require conversion.
        md = {}

        # Loop over art metadata.
        for mdkey in mdart.keys():
            mdval = mdart[mdkey]

            # Skip some art-specific fields.

            if mdkey == 'file_format_version':
                pass
            elif mdkey == 'file_format_era':
                pass

            # Ignore primary run_type field (if any).
            # Instead, get run_type from runs field.

            elif mdkey == 'run_type':
                pass

            # Ignore data_stream for now.

            elif mdkey == 'data_stream':
                pass

            # Ignore process_name for now.

            elif mdkey == 'process_name':
                pass

            # Application family/name/version.

            elif mdkey == 'applicationFamily':
                if not md.has_key('application'):
                    md['application'] = {}
                md['application']['family'] = mdval
            elif mdkey == 'StageName':
                if not md.has_key('application'):
                    md['application'] = {}
                md['application']['name'] = mdval
            elif mdkey == 'applicationVersion':
                if not md.has_key('application'):
                    md['application'] = {}
                md['application']['version'] = mdval

            # Parents.

            elif mdkey == 'parents':
                mdparents = []
                for parent in mdval:
                    parent_dict = {'file_name': parent}
                    mdparents.append(parent_dict)
                md['parents'] = mdparents

            # Other fields where the key or value requires minor conversion.

            elif mdkey == 'first_event':
                md[mdkey] = mdval[2]
            elif mdkey == 'last_event':
                md[mdkey] = mdval[2]
            elif mdkey == 'lbneMCGenerators':
                md['lbne_MC.generators']  = mdval
            elif mdkey == 'lbneMCOscillationP':
                md['lbne_MC.oscillationP']  = mdval
            elif mdkey == 'lbneMCTriggerListVersion':
                md['lbne_MC.trigger-list-version']  = mdval
            elif mdkey == 'lbneMCBeamEnergy':
                md['lbne_MC.beam_energy']  = mdval
            elif mdkey == 'lbneMCBeamFluxID':
                md['lbne_MC.beam_flux_ID']  = mdval
            elif mdkey == 'lbneMCName':
                md['lbne_MC.name']  = mdval
            elif mdkey == 'lbneMCDetectorType':
                md['lbne_MC.detector_type']  = mdval
            elif mdkey == 'lbneMCNeutrinoFlavors':
                md['lbne_MC.neutrino_flavors']  = mdval
            elif mdkey == 'lbneMCMassHierarchy':
                md['lbne_MC.mass_hierarchy']  = mdval
            elif mdkey == 'lbneMCMiscellaneous':
                md['lbne_MC.miscellaneous']  = mdval
            elif mdkey == 'lbneMCGeometryVersion':
                md['lbne_MC.geometry_version']  = mdval
            elif mdkey == 'lbneMCOverlay':
                md['lbne_MC.overlay']  = mdval
            elif mdkey == 'lbneDataRunMode':
                md['lbne_data.run_mode']  = mdval
            elif mdkey == 'lbneDataDetectorType':
                md['lbne_data.detector_type']  = mdval
            elif mdkey == 'lbneDataName':
                md['lbne_data.name']  = mdval

            # For all other keys, copy art metadata directly to sam metadata.
            # This works for run-tuple (run, subrun, runtype) and time stamps.

            else:
                md[mdkey] = mdart[mdkey]


        # Get the other meta data field parameters
        md['file_name'] = self.inputfile.split("/")[-1]
        if 'file_size' in md0:
            md['file_size'] = md0['file_size']
        else:
            md['file_size'] = os.path.getsize(self.inputfile)
        if 'crc' in md0:
            md['crc'] = md0['crc']
        else:
            md['crc'] = root_metadata.fileEnstoreChecksum(self.inputfile)

        # In case we ever want to check out what md is for any instance of MetaData by calling instance.md
        self.md = md
        return self.md

def extractor_dict.expMetaData.translateKey	(		self,
			key
	)

Returns the output of the imported translateKey function (as translateKeyf) called on key

Definition at line 114 of file extractor_dict.py.

    def translateKey(self, key):
        """Returns the output of the imported translateKey function (as translateKeyf) called on key"""
        return self.translateKeyf(key)

Member Data Documentation

extractor_dict.expMetaData.expname

Definition at line 102 of file extractor_dict.py.

extractor_dict.expMetaData.md

Definition at line 232 of file extractor_dict.py.

extractor_dict.expMetaData.translateKeyf

Definition at line 112 of file extractor_dict.py.

---

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

• duneutil/python/extractor_dict.py