Reference Manual

Functions
def	deserialize_iovs

def	discover

def	discover_plugins

def	output

def	supress_output

Variables
tuple	args = parser.parse_args()

string	description

	filename = None

	input_params = None

tuple	iovDict = yaml.safe_load( args.iovs )

tuple	parser = ArgumentParser(description=description, formatter_class=RawTextHelpFormatter)

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

list	tags = []

Function Documentation

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 output().

 
 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

getPayloadData.deserialize_iovs

def deserialize_iovs

Definition: getPayloadData.py:65

getPayloadData.output

def output

Definition: getPayloadData.py:203

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 bitset_utilities.append(), DeadROC_duringRun.dir, discover_plugins(), and output().

 
 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)

bitset_utilities::append

boost::dynamic_bitset append(const boost::dynamic_bitset<> &bs1, const boost::dynamic_bitset<> &bs2)

this method takes two bitsets bs1 and bs2 and returns result of bs2 appended to the end of bs1 ...

Definition: bitset_append.cc:10

getPayloadData.discover

def discover

Definition: getPayloadData.py:158

DeadROC_duringRun.dir

string dir

Definition: DeadROC_duringRun.py:23

getPayloadData.discover_plugins

def discover_plugins

Definition: getPayloadData.py:116

getPayloadData.output

def output

Definition: getPayloadData.py:203

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 if(), output(), 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

python.rootplot.root2matplotlib.replace

def replace

Definition: root2matplotlib.py:444

if(conf_.getParameter< bool >("UseStripCablingDB"))

Definition: SiStripLAProfileBooker.cc:72

getPayloadData.discover_plugins

def discover_plugins

Definition: getPayloadData.py:116

getPayloadData.output

def output

Definition: getPayloadData.py:203

def getPayloadData.output	(	description,
		param
	)

Definition at line 203 of file getPayloadData.py.

References print().

Referenced by deserialize_iovs(), discover(), and discover_plugins().

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

void print(TMatrixD &m, const char *label=nullptr, bool mathematicaFormat=false)

Definition: Utilities.cc:47

getPayloadData.output

def output

Definition: getPayloadData.py:203

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 validate-o2o-wbm.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

getPayloadData.supress_output

def supress_output

Definition: getPayloadData.py:22

validate-o2o-wbm.f

tuple f

Definition: validate-o2o-wbm.py:27

Variable Documentation

tuple getPayloadData.args = parser.parse_args()

Definition at line 260 of file getPayloadData.py.

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.

Referenced by optutl::VariableMapCont._checkKey(), cms::cuda.abortOnCudaError(), cms::cuda.abortOnNvmlError(), edm::eventsetup::looper.addFinderTo(), edm::eventsetup.addProviderTo(), edm::eventsetup::looper.addProviderTo(), edm::eventsetup::ComponentMaker< T, TComponent >.addTo(), edm::EventProcessor.beginJob(), edm.checkForModuleDependencyCorrectness(), ConfFitterBuilder< O >.ConfFitterBuilder(), ConfRecoBuilder< O >.ConfRecoBuilder(), sistrip::SpyEventMatcher.constructSource(), edm::eventsetup::ComponentMakerBaseHelper.createComponentDescription(), SiStripHistoId.createHistoId(), SiStripHistoId.createHistoLayer(), cms::cuda.cudaCheck_(), SiStripConfigDb.deviceAddress(), ExpressionHisto< T >.initialize(), edm::SubProcess.keepOnlyConsumedUnscheduledModules(), edm.nonConsumedUnscheduledModules(), ExceptionHandler.Notify(), cms::cuda.nvmlCheck_(), optutl::CommandLineParser.printOptionValues(), edm::PathsAndConsumesOfModules.removeModules(), edm::WorkerT< T >.resolvePutIndicies(), SiStripCondObjBuilderFromDb.setValuesCabling(), TwoObjectVariable< LHS, lLHS, RHS, lRHS, Calculator >.TwoObjectVariable(), edm.validateTopLevelParameterSets(), l1tVertexFinder::VertexNTupler.VertexNTupler(), npstat::StorableHistoNDFunctor< Numeric, Axis, Converter >.write(), npstat::StorableInterpolationFunctor< Numeric, Axis, Converter >.write(), edm::OutputModuleCommunicatorT< T >.writeLumiAsync(), edm::OutputModuleCommunicatorT< T >.writeProcessBlockAsync(), and edm::OutputModuleCommunicatorT< T >.writeRunAsync().

Functions

Variables

Function Documentation

Variable Documentation