getPayloadData Namespace Reference

Functions
def	deserialize_iovs (db, plugin_name, plot_name, tags, time_type, input_params)
def	discover ()
def	discover_plugins ()
def	output (description, param)
def	supress_output (f)

Variables
	action
	args = parser.parse_args()
string	description
	filename = None
	help
	input_params = None
	iovDict = yaml.safe_load( args.iovs )
	parser = ArgumentParser(description=description, formatter_class=RawTextHelpFormatter)
def	result = deserialize_iovs(args.db, args.plugin, args.plot, tags, args.time_type, input_params)
list	tags = []

Function Documentation

deserialize_iovs()

def getPayloadData.deserialize_iovs	(		db,
			plugin_name,
			plot_name,
			tags,
			time_type,
			input_params
	)

Deserializes given iovs data and returns plot coordinates 

Definition at line 65 of file getPayloadData.py.

References createfilelist.int.

def deserialize_iovs(db, plugin_name, plot_name, tags, time_type, input_params):
    ''' Deserializes given iovs data and returns plot coordinates '''
    
    output('Starting to deserialize iovs: ', '')
    output('db: ', db)
    output('plugin name: ', plugin_name)
    output('plot name: ', plot_name)
    output('tags: ', tags)
    output('tag time type: ', time_type)
  
    plugin_base = import_module('pluginModule_PayloadInspector')
    output('PI plugin base: ', plugin_base)

    plugin_obj = import_module(plugin_name)
    output('PI plugin object: ', plugin_obj)

    # get plot method and execute it with given iovs
    plot = getattr(plugin_obj, plot_name)()
    output('plot object: ', plot)

    if db == "Prod":
        db_name = 'frontier://FrontierProd/CMS_CONDITIONS'
    elif db == 'Prep' :
        db_name = 'frontier://FrontierPrep/CMS_CONDITIONS'
    else:
        db_name = db

    output('full DB name: ', db_name)

    if input_params is not None:
        plot.setInputParamValues( input_params )

    modv = getattr(plugin_base,'ModuleVersion')

    success = False
    if modv.label == '1.0':
        if len(tags)==1:
            success = plot.process(db_name, tags[0][0], time_type, int(tags[0][1]), int(tags[0][2]) )
        elif len(tags)==2:
            success = plot.processTwoTags(db_name, tags[0][0], tags[1][0], int(tags[0][1]),int(tags[1][1]) )
    elif modv.label == '2.0':
        success = plot.process(db_name, tags)

    output('plot processed data successfully: ', success)
    if not success:
        return False

    result = plot.data()
    output('deserialized data: ', result)
    return result

discover()

def getPayloadData.discover

(

)

Discovers object types and plots for a given cmssw release
    Example:
    {
        "BasicPayload": [
            {"plot": "plot_BeamSpot_x", "plot_type": "History", 
             "single_iov": false, "plugin_name": "pluginBeamSpot_PayloadInspector",
             "title": "x vs run number"},
            ...
        ],
       ...
    }

Definition at line 158 of file getPayloadData.py.

References mps_setup.append, DeadROC_duringRun.dir, and discover_plugins().

def discover():
    ''' Discovers object types and plots for a given cmssw release
        Example:
        {
            "BasicPayload": [
                {"plot": "plot_BeamSpot_x", "plot_type": "History", 
                 "single_iov": false, "plugin_name": "pluginBeamSpot_PayloadInspector",
                 "title": "x vs run number"},
                ...
            ],
           ...
        }
    '''
    plugin_base = import_module('pluginModule_PayloadInspector') 
    modv = getattr(plugin_base,'ModuleVersion')
    result = {}
    for plugin_name in discover_plugins():
        output(' - plugin name: ', plugin_name)
        plugin_obj = import_module(plugin_name)
        output('*** PI plugin object: ', plugin_obj)
        for plot in dir(plugin_obj):
            if 'plot_' not in plot: continue # skip if method doesn't start with 'plot_' prefix
            output(' - plot name: ', plot)
            plot_method= getattr(plugin_obj, plot)()
            output(' - plot object: ', plot_method)
            payload_type = plot_method.payloadType()
            output(' - payload type: ', payload_type)
            plot_title = plot_method.title()
            output(' - plot title: ', plot_title)
            plot_type = plot_method.type()
            output(' - plot type: ', plot_type)
            single_iov = plot_method.isSingleIov()
            output(' - is single iov: ', single_iov)
            two_tags = plot_method.isTwoTags()
            output(' - is Two Tags: ', two_tags)
            plot_dict = { 'plot': plot, 'plugin_name': plugin_name, 'title': plot_title, 'plot_type': plot_type, 'single_iov': single_iov, 'two_tags': two_tags }
            if modv.label == '2.0':
                input_params = plot_method.inputParams()
                output(' - input params: ', len(input_params))
                plot_dict[ 'input_params'] = input_params
            result.setdefault(payload_type, []).append( plot_dict )
            output('currently discovered info: ', result)
    output('*** final output:', '')
    return json.dumps(result)

discover_plugins()

def getPayloadData.discover_plugins

(

)

Returns a list of Payload Inspector plugin names
    Example:
    ['pluginBasicPayload_PayloadInspector', 'pluginBeamSpot_PayloadInspector', 'pluginSiStrip_PayloadInspector']

Definition at line 116 of file getPayloadData.py.

References ALPAKA_ACCELERATOR_NAMESPACE::caPixelDoublets.if(), and python.rootplot.root2matplotlib.replace().

Referenced by discover().

def discover_plugins():
    ''' Returns a list of Payload Inspector plugin names
        Example:
        ['pluginBasicPayload_PayloadInspector', 'pluginBeamSpot_PayloadInspector', 'pluginSiStrip_PayloadInspector']
    '''
    architecture = os.environ.get('SCRAM_ARCH', None)
    output('architecture: ', architecture)

    plugins = []
    releases = [
        os.environ.get('CMSSW_BASE', None),
        os.environ.get('CMSSW_RELEASE_BASE', None),
        os.environ.get('CMSSW_FULL_RELEASE_BASE', None)
    ]

    for r in releases:
        if not r: continue # skip if release base is not specified
        output('* release: ', r)

        path = os.path.join(r, 'lib', architecture)
        output('* full release path: ', path)

        plugins += glob.glob(path + '/plugin*_PayloadInspector.so' )
        output('found plugins: ', plugins) 
        
        # If no plugins are found in the local release,
        # go find them in the release base (or full release base, in case of patches)
        if(len(plugins)==0):
            output('# plugins found:',len(plugins))
        else:
            if r: break # break loop if CMSSW_BASE is specified
  
    # extracts the object name from plugin path:
    # /afs/cern.ch/cms/slc6_amd64_gcc493/cms/cmssw/CMSSW_8_0_6/lib/slc6_amd64_gcc493/pluginBasicPayload_PayloadInspector.so
    # becomes pluginBasicPayload_PayloadInspector
    result = []
    for p in plugins:
         result.append(p.split('/')[-1].replace('.so', ''))

    output('discovered plugins: ', result)
    return result

output()

def getPayloadData.output	(		description,
			param
	)

Definition at line 203 of file getPayloadData.py.

References print().

def output(description, param):
    if args.verbose:
        print('')
        print(description, param)

supress_output()

def getPayloadData.supress_output

(

f

)

Temporarily disables stdout and stderr so that printouts from the plot
plugin does not compromise the purity of our ssh stream if 
args.suppress_output is true

Definition at line 22 of file getPayloadData.py.

References f.

def supress_output( f ):
    '''
    Temporarily disables stdout and stderr so that printouts from the plot
    plugin does not compromise the purity of our ssh stream if 
    args.suppress_output is true
    '''
    def decorated( *fargs, **fkwargs ):

        suppress = args.suppress_output
        if suppress:
            
            # Get rid of what is already there ( should be nothing for this script )
            sys.stdout.flush()

            # Save file descriptors so it can be reactivated later 
            saved_stdout = os.dup( 1 )
            saved_stderr = os.dup( 2 )

            # /dev/null is used just to discard what is being printed
            devnull = os.open( '/dev/null', os.O_WRONLY )

            # Duplicate the file descriptor for /dev/null
            # and overwrite the value for stdout (file descriptor 1)
            os.dup2( devnull, 1 )
            os.dup2( devnull, 2 )

        result = f( *fargs, **fkwargs )

        if suppress:

            # Close devnull after duplication (no longer needed)
            os.close( devnull )

            # Reenable stdout and stderr
            os.dup2( saved_stdout, 1 )
            os.dup2( saved_stderr, 2 )

        return result

    return decorated


@supress_output

Variable Documentation

action

getPayloadData.action

Definition at line 240 of file getPayloadData.py.

args

getPayloadData.args = parser.parse_args()

Definition at line 260 of file getPayloadData.py.

description

string getPayloadData.description

Initial value:

=  '''
    Payload Inspector - data visualisation tool which is integrated into the cmsDbBrowser.
    It allows to display plots and monitor the calibration and alignment data.

    You can access Payload Inspector with a link below:
    https://cms-conddb.cern.ch/cmsDbBrowser/payload_inspector/Prod

    This script is a part of the Payload Inspector service and is responsible for:
    a) discovering PI objects that are available in a given cmssw release
    b) deserializing payload data which is later used as plot coordinates
    c) testing new PI objects which are under development

    To test new PI objects please do the following:
    a) run ./getPayloadData.py --discover
    to check if your newly created object is found by the script.
    Please note that we strongly rely on naming conventions so if you don't
    see your object listed you probably misnamed it in objectType() method.
    Also all plot methods should start with "plot_" prefix.

    b) second step is to test if it returns data correctly:
    run ./getPayloadData.py --plugin YourPIPluginName --plot YourObjectPlot --tag tagName --time_type Run --iovs '{"start_iov": "201", "end_iov": "801"}' --db Prod --test 
  
    Here is an example for BasicPayload object:
    run ./getPayloadData.py --plugin pluginBasicPayload_PayloadInspector --plot plot_BasicPayload_data0 --tag BasicPayload_v2 --time_type Run --iovs '{"start_iov": "201", "end_iov": "801"}' --db Prod --test

    c) if it works correctly please make a pull request and once it's accepted
    go to cmsDbBrowser and wait for the next IB to test it.
    '''

Definition at line 210 of file getPayloadData.py.

filename

getPayloadData.filename = None

Definition at line 287 of file getPayloadData.py.

help

getPayloadData.help

Definition at line 240 of file getPayloadData.py.

input_params

getPayloadData.input_params = None

Definition at line 266 of file getPayloadData.py.

iovDict

getPayloadData.iovDict = yaml.safe_load( args.iovs )

Definition at line 272 of file getPayloadData.py.

parser

getPayloadData.parser = ArgumentParser(description=description, formatter_class=RawTextHelpFormatter)

Definition at line 239 of file getPayloadData.py.

result

def getPayloadData.result = deserialize_iovs(args.db, args.plugin, args.plot, tags, args.time_type, input_params)

Definition at line 278 of file getPayloadData.py.

tags

list getPayloadData.tags = []

Definition at line 270 of file getPayloadData.py.

Referenced by ParticleLevelProducer.addGenJet(), SiStripGainFromCalibTree.algoEndRun(), algorithm(), pat::CandidateSummaryTable.analyze(), MixCollectionValidation.bookHistograms(), MuonOffsetFromDD.build(), CaloTruthAccumulator.CaloTruthAccumulator(), edm::CFWriter.CFWriter(), ChainedJetCorrectorProducer.ChainedJetCorrectorProducer(), CondHDF5ESSource.CondHDF5ESSource(), ConvertingESProducerWithDependenciesT< CombinedRecord< DepsRecords... >, Target, Dependencies... >.ConvertingESProducerWithDependenciesT(), HLTConfigData.dump(), IsoTrig.fillDescriptions(), SmartSelectionMonitor.fillHisto(), SmartSelectionMonitor.fillProfile(), TriggerSummaryProducerAOD.fillTriggerObjectCollections(), models.generate(), L6SLBCorrectorImpl.getBTagInfoIndex(), SiStripSummaryCreator.getSummaryME(), DeDxEstimatorRekeyer.getTokens(), GoodSeedProducer.GoodSeedProducer(), FWPSetTableManager.handleEntry(), HGCalPassivePartial.HGCalPassivePartial(), edm::HiMixingModule.HiMixingModule(), cond::persistency::GLOBAL_TAG_MAP::Table.insert(), ConvertingESProducerWithDependenciesT< CombinedRecord< DepsRecords... >, Target, Dependencies... >::WalkConsumes< N >.iterate(), LightPFTrackProducer.LightPFTrackProducer(), LowPtGsfElectronSeedValueMapsProducer.LowPtGsfElectronSeedValueMapsProducer(), edm::MixingModule.MixingModule(), MtdTruthAccumulator.MtdTruthAccumulator(), L1TPhase2CorrelatorOffline::MultiCollection.MultiCollection(), edm.operator<<(), PFLinker.PFLinker(), PFNuclearProducer.PFNuclearProducer(), PFTrackProducer.PFTrackProducer(), PFV0Producer.PFV0Producer(), PixelClusterCountsAuditor.PixelClusterCountsAuditor(), ParticleLevelProducer.produce(), GenJetTauTaggerProducer.produce(), BTagProbabilityToDiscriminator.produce(), TriggerSummaryProducerAOD.produce(), pathelpers::RecordCache.RecordCache(), PPSTimingCalibrationPCLWorker.searchForProduct(), PPSDiamondSampicTimingCalibrationPCLWorker.searchForProduct(), cond::persistency::GLOBAL_TAG_MAP::Table.select(), ElectronHEEPIDValueMapProducer.setToken(), SuperclusValueMapProducer.setTokens(), SimHitTPAssociationProducer.SimHitTPAssociationProducer(), and TrackingTruthAccumulator.TrackingTruthAccumulator().