Mixins._Labelable Class Reference

Inheritance diagram for Mixins._Labelable:

Public Member Functions
def	__str__ (self)
def	dumpSequenceConfig (self)
def	dumpSequencePython
def	hasLabel_ (self)
def	label (self)
def	label_ (self)
def	setLabel

Private Member Functions
def	_findDependencies (self, knownDeps, presentDeps)

Private Attributes
	__label

Detailed Description

A 'mixin' used to denote that the class can be paired with a label (e.g. an EDProducer)

Definition at line 525 of file Mixins.py.

Member Function Documentation

__str__()

def Mixins._Labelable.__str__

(

self

)

Definition at line 554 of file Mixins.py.

References Mixins._Labelable.__label, and str.

    def __str__(self):
        #this is probably a bad idea
        # I added this so that when we ask a path to print
        # we will see the label that has been assigned
        return str(self.__label)

_findDependencies()

def Mixins._Labelable._findDependencies (   self,   knownDeps,   presentDeps  )

private

Definition at line 566 of file Mixins.py.

References MagneticFieldMapESProducer.label_, TrackerInteractionGeometryESProducer.label_, CTPPSPixelDAQMappingAnalyzer.label_, TestCUDAProducerCPU.label_, TestCUDAProducerGPU.label_, TestCUDAProducerGPUFirst.label_, SiPhase2OuterTrackerLorentzAngleReader.label_, TestCUDAAnalyzerGPU.label_, SiPhase2BadStripChannelReader.label_, mkfit::ReducedTrack.label_, SiStripLorentzAngleReader.label_, TestCUDAProducerGPUtoCPU.label_, edm::eventsetup::ComponentDescription.label_, TestCUDAProducerGPUEW.label_, pat::TriggerFilter.label_, XMLIdealMagneticFieldGeometryESProducer.label_, PythiaFilterHT.label_, WriteCTPPSTotemDAQMappingMask.label_, TestCUDAProducerGPUEWTask.label_, ESDigiToRaw.label_, WriteCTPPSPixelAnalysisMask.label_, WriteCTPPSPixelDAQMapping.label_, VertexCompositeCandidateCollectionSelector.label_, RetrieveCTPPSBeamParameters.label_, CTPPSPixelRawToDigi.label_, HistoProviderDQM.label_, SiStripDelayESProducer::TokenSign.label_, VertexMonitor.label_, PythiaMomDauFilter.label_, RandomEngineState.label_, edm::ConsumesInfo.label_, StripSubClusterShapeFilterBase.label_, edm::test::ProcessBlock.label_, SiPixelStatusManager.label_, edm::SecSourceAnalyzer.label_, edm::InputTag.label_, TPGCheck.label_, SiPixelStatusHarvester.label_, DDDetectorESProducer.label_, reco::Centrality.label_, edm::test::Run.label_, PPSPixelDigiAnalyzer.label_, edm::test::LuminosityBlock.label_, pat::TauJetCorrFactors.label_, edm::test::Event.label_, EffPurFromHistos2D.label_, EcalTrigPrimAnalyzer.label_, edm::DataMixingSiStripWorker.label_, edm::DataMixingSiPixelWorker.label_, edm::DataMixingPileupCopy.label_, StallStatistics.label_, SiPixelCalibDigiProducer.label_, edm::DataMixingSiStripRawWorker.label_, EffPurFromHistos.label_, TopSingleLepton_miniAOD::MonitorEnsemble.label_, SingleTopTChannelLepton_miniAOD::MonitorEnsemble.label_, edm::HiMixingWorkerBase.label_, npstat::UniformAxis.label_, edm::ParameterDescriptionBase.label_, edm::messagedrop::StringProducerWithPhase.label_, PileupJetIdAlgo::AlgoGBRForestsAndConstants.label_, edm::DataMixingEMWorker.label_, fwlite::ObjectCountSelector< Collection >.label_, edm::DataMixingHcalWorker.label_, pat::JetCorrFactors.label_, edm::DataMixingHcalDigiWorkerProd.label_, pat::JetCorrFactorsProducer.label_, TopSingleLepton::MonitorEnsemble.label_, edm::DataMixingMuonWorker.label_, npstat::NUHistoAxis.label_, pat::helper::AnyNumberAssociationAdaptor.label_, SingleTopTChannelLepton::MonitorEnsemble.label_, edm::DataMixingEMDigiWorker.label_, TopDiLeptonOffline::MonitorEnsemble.label_, edm::DataMixingHcalDigiWorker.label_, HLTObjectsMonitor.label_, npstat::GridAxis.label_, SummaryGenerator.label_, npstat::HistoAxis.label_, edm::GenericConsumer.label_, edm::service::RandomNumberGeneratorService::LabelAndEngine.label_, templateHelper::SiPixelTitles_Display< PayloadType, StoreType, TransientType >.label_, ALPAKA_ACCELERATOR_NAMESPACE::ProducerBaseAdaptor< TProducer, Tr >.label_, edm::MixingWorker< T >.label_, edm::DataMixingModule.label_, AlignPCLThresholdPlotHelper::AlignPCLThresholds_DisplayBase< PayloadType >.label_, templateHelper::SiPixelHeaderTable< PayloadType, StoreType, TransientType >.label_, mkfit::TrackBase.label_, gainCalibHelper::SiPixelGainCalibrationValues< myType, PayloadType >.label_, templateHelper::SiPixelIDs< PayloadType, myType >.label_, AlignPCLThresholdPlotHelper::AlignPCLThresholds_CompareBase< PayloadType, nIOVs, ntags >.label_, templateHelper::SiPixelFullPixelIDMap< PayloadType, StoreType, TransientType >.label_, SiPixelQualityBadFractionMap.label_, Mixins._Labelable.label_(), gainCalibHelper::SiPixelGainCalibrationValuesPerRegion< isBarrel, myType, PayloadType >.label_, fwlite::Scanner< Collection >.label_, gainCalibHelper::SiPixelGainCalibrationValuesComparisonPerRegion< isBarrel, myType, nIOVs, ntags, PayloadType >.label_, SiPixelDynamicInefficiencyFullPixelMap< theFactor >.label_, templateHelper::SiPixelTemplateHeaderInfo< PayloadType, StoreType, TransientType, myType, myParam >.label_, SiPixelDynamicInefficiencyPUPixelMaps.label_, gainCalibHelper::SiPixelGainCalibrationCorrelations< PayloadType >.label_, SiPixelLorentzAngleFullPixelMap.label_, gainCalibHelper::SiPixelGainCalibrationValuesByPart< myType, PayloadType >.label_, SiPixelDynamicInefficiencyPUParametrization.label_, PixelAlignmentComparisonMapBase< coord, ntags, nIOVs >.label_, SiPixelLorentzAngleFullMapCompareBase< nIOVs, ntags >.label_, gainCalibHelper::SiPixelGainCalibrationValueComparisonBase< myType, PayloadType >.label_, SiPixelDynamicInefficiencyPUParamComparisonBase< nIOVs, ntags >.label_, gainCalibHelper::SiPixelGainCalibDiffAndRatioBase< myType, nIOVs, ntags, PayloadType >.label_, gainCalibHelper::SiPixelGainCalibrationMap< myType, PayloadType, myDetType >.label_, gainCalibHelper::SiPixelGainCalibrationByRegionComparisonBase< myType, PayloadType, nIOVs, ntags >.label_, and str.

    def _findDependencies(self,knownDeps,presentDeps):
        #print 'in labelled'
        myDeps=knownDeps.get(self.label_(),None)
        if myDeps!=None:
            if presentDeps != myDeps:
                raise RuntimeError("the module "+self.label_()+" has two dependencies \n"
                                   +str(presentDeps)+"\n"
                                   +str(myDeps)+"\n"
                                   +"Please modify sequences to rectify this inconsistency")
        else:
            myDeps=set(presentDeps)
            knownDeps[self.label_()]=myDeps
        presentDeps.add(self.label_())

dumpSequenceConfig()

def Mixins._Labelable.dumpSequenceConfig

(

self

)

Definition at line 559 of file Mixins.py.

References Mixins._Labelable.__label, and str.

    def dumpSequenceConfig(self):
        return str(self.__label)

dumpSequencePython()

def Mixins._Labelable.dumpSequencePython	(		self,
			options
	)

Definition at line 561 of file Mixins.py.

References Mixins._Labelable.__label, and str.

    def dumpSequencePython(self, options:PrintOptions=PrintOptions()):
        if options.isCfg:
            return 'process.'+str(self.__label)
        else:
            return str(self.__label)

hasLabel_()

def Mixins._Labelable.hasLabel_	(		self,
			bool
	)

Definition at line 531 of file Mixins.py.

References Mixins._Labelable.__label.

Referenced by Modules.SwitchProducer.__addParameter(), Modules.SwitchProducer.__setattr__(), SequenceTypes._ModuleSequenceType.dumpSequenceConfig(), SequenceTypes._ModuleSequenceType.dumpSequencePython(), SequenceTypes._TaskBase.fillContents(), and Mixins._Labelable.setLabel().

    def hasLabel_(self) -> bool:
        return hasattr(self, "_Labelable__label") and self.__label is not None

label()

def Mixins._Labelable.label	(		self,
			str
	)

Definition at line 551 of file Mixins.py.

References Mixins._Labelable.__label.

    def label(self) -> str:
        #print "WARNING: _Labelable::label() needs to be changed to label_()"
        return self.__label

label_()

def Mixins._Labelable.label_	(		self,
			str
	)

Definition at line 527 of file Mixins.py.

References Mixins._Labelable.__label.

Referenced by Modules.SwitchProducer.__addParameter(), SequenceTypes.DummyModule.__repr__(), Modules.SwitchProducer.__setattr__(), Mixins._Labelable._findDependencies(), and Mixins._Labelable.setLabel().

    def label_(self) -> str:
        if not hasattr(self, "_Labelable__label"):
           raise RuntimeError("module has no label.  Perhaps it wasn't inserted into the process?")
        return self.__label

setLabel()

def Mixins._Labelable.setLabel	(		self,
			label
	)

Definition at line 533 of file Mixins.py.

References Mixins._Labelable.hasLabel_(), MagneticFieldMapESProducer.label_, TrackerInteractionGeometryESProducer.label_, CTPPSPixelDAQMappingAnalyzer.label_, TestCUDAProducerCPU.label_, TestCUDAProducerGPU.label_, TestCUDAProducerGPUFirst.label_, SiPhase2OuterTrackerLorentzAngleReader.label_, TestCUDAAnalyzerGPU.label_, SiPhase2BadStripChannelReader.label_, mkfit::ReducedTrack.label_, SiStripLorentzAngleReader.label_, TestCUDAProducerGPUtoCPU.label_, edm::eventsetup::ComponentDescription.label_, TestCUDAProducerGPUEW.label_, pat::TriggerFilter.label_, XMLIdealMagneticFieldGeometryESProducer.label_, PythiaFilterHT.label_, WriteCTPPSTotemDAQMappingMask.label_, TestCUDAProducerGPUEWTask.label_, ESDigiToRaw.label_, WriteCTPPSPixelAnalysisMask.label_, RetrieveCTPPSBeamParameters.label_, WriteCTPPSPixelDAQMapping.label_, VertexCompositeCandidateCollectionSelector.label_, CTPPSPixelRawToDigi.label_, HistoProviderDQM.label_, SiStripDelayESProducer::TokenSign.label_, VertexMonitor.label_, PythiaMomDauFilter.label_, RandomEngineState.label_, edm::ConsumesInfo.label_, StripSubClusterShapeFilterBase.label_, edm::test::ProcessBlock.label_, SiPixelStatusManager.label_, edm::SecSourceAnalyzer.label_, edm::InputTag.label_, SiPixelStatusHarvester.label_, TPGCheck.label_, DDDetectorESProducer.label_, reco::Centrality.label_, edm::test::Run.label_, PPSPixelDigiAnalyzer.label_, edm::test::LuminosityBlock.label_, pat::TauJetCorrFactors.label_, edm::test::Event.label_, EffPurFromHistos2D.label_, EcalTrigPrimAnalyzer.label_, edm::DataMixingSiStripWorker.label_, edm::DataMixingSiPixelWorker.label_, StallStatistics.label_, edm::DataMixingPileupCopy.label_, SiPixelCalibDigiProducer.label_, edm::DataMixingSiStripRawWorker.label_, EffPurFromHistos.label_, edm::HiMixingWorkerBase.label_, SingleTopTChannelLepton_miniAOD::MonitorEnsemble.label_, TopSingleLepton_miniAOD::MonitorEnsemble.label_, npstat::UniformAxis.label_, edm::ParameterDescriptionBase.label_, edm::messagedrop::StringProducerWithPhase.label_, PileupJetIdAlgo::AlgoGBRForestsAndConstants.label_, edm::DataMixingEMWorker.label_, edm::DataMixingHcalWorker.label_, fwlite::ObjectCountSelector< Collection >.label_, pat::JetCorrFactors.label_, edm::DataMixingHcalDigiWorkerProd.label_, pat::JetCorrFactorsProducer.label_, TopSingleLepton::MonitorEnsemble.label_, edm::DataMixingMuonWorker.label_, pat::helper::AnyNumberAssociationAdaptor.label_, npstat::NUHistoAxis.label_, SingleTopTChannelLepton::MonitorEnsemble.label_, edm::DataMixingEMDigiWorker.label_, TopDiLeptonOffline::MonitorEnsemble.label_, edm::DataMixingHcalDigiWorker.label_, HLTObjectsMonitor.label_, npstat::GridAxis.label_, SummaryGenerator.label_, npstat::HistoAxis.label_, edm::GenericConsumer.label_, edm::service::RandomNumberGeneratorService::LabelAndEngine.label_, templateHelper::SiPixelTitles_Display< PayloadType, StoreType, TransientType >.label_, ALPAKA_ACCELERATOR_NAMESPACE::ProducerBaseAdaptor< TProducer, Tr >.label_, edm::MixingWorker< T >.label_, edm::DataMixingModule.label_, AlignPCLThresholdPlotHelper::AlignPCLThresholds_DisplayBase< PayloadType >.label_, templateHelper::SiPixelHeaderTable< PayloadType, StoreType, TransientType >.label_, mkfit::TrackBase.label_, gainCalibHelper::SiPixelGainCalibrationValues< myType, PayloadType >.label_, templateHelper::SiPixelIDs< PayloadType, myType >.label_, AlignPCLThresholdPlotHelper::AlignPCLThresholds_CompareBase< PayloadType, nIOVs, ntags >.label_, templateHelper::SiPixelFullPixelIDMap< PayloadType, StoreType, TransientType >.label_, SiPixelQualityBadFractionMap.label_, Mixins._Labelable.label_(), gainCalibHelper::SiPixelGainCalibrationValuesPerRegion< isBarrel, myType, PayloadType >.label_, fwlite::Scanner< Collection >.label_, gainCalibHelper::SiPixelGainCalibrationValuesComparisonPerRegion< isBarrel, myType, nIOVs, ntags, PayloadType >.label_, SiPixelDynamicInefficiencyFullPixelMap< theFactor >.label_, templateHelper::SiPixelTemplateHeaderInfo< PayloadType, StoreType, TransientType, myType, myParam >.label_, gainCalibHelper::SiPixelGainCalibrationCorrelations< PayloadType >.label_, SiPixelDynamicInefficiencyPUPixelMaps.label_, SiPixelLorentzAngleFullPixelMap.label_, gainCalibHelper::SiPixelGainCalibrationValuesByPart< myType, PayloadType >.label_, SiPixelDynamicInefficiencyPUParametrization.label_, PixelAlignmentComparisonMapBase< coord, ntags, nIOVs >.label_, SiPixelLorentzAngleFullMapCompareBase< nIOVs, ntags >.label_, gainCalibHelper::SiPixelGainCalibrationValueComparisonBase< myType, PayloadType >.label_, SiPixelDynamicInefficiencyPUParamComparisonBase< nIOVs, ntags >.label_, gainCalibHelper::SiPixelGainCalibDiffAndRatioBase< myType, nIOVs, ntags, PayloadType >.label_, gainCalibHelper::SiPixelGainCalibrationMap< myType, PayloadType, myDetType >.label_, gainCalibHelper::SiPixelGainCalibrationByRegionComparisonBase< myType, PayloadType, nIOVs, ntags >.label_, and str.

Referenced by SequenceTypes.DummyModule.__init__(), and SequenceTypes.DummyBooleanModule.__init__().

    def setLabel(self,label:str):
        if self.hasLabel_() :
            if self.label_() != label and label is not None :
                msg100 = "Attempting to change the label of a Labelable object, possibly an attribute of the Process\n"
                msg101 = "Old label = "+self.label_()+"  New label = "+label+"\n"
                msg102 = "Type = "+str(type(self))+"\n"
                msg103 = "Some possible solutions:\n"
                msg104 = "  1. Clone modules instead of using simple assignment. Cloning is\n"
                msg105 = "  also preferred for other types when possible.\n"
                msg106 = "  2. Declare new names starting with an underscore if they are\n"
                msg107 = "  for temporaries you do not want propagated into the Process. The\n"
                msg108 = "  underscore tells \"from x import *\" and process.load not to import\n"
                msg109 = "  the name.\n"
                msg110 = "  3. Reorganize so the assigment is not necessary. Giving a second\n"
                msg111 = "  name to the same object usually causes confusion and problems.\n"
                msg112 = "  4. Compose Sequences: newName = cms.Sequence(oldName)\n"
                raise ValueError(msg100+msg101+msg102+msg103+msg104+msg105+msg106+msg107+msg108+msg109+msg110+msg111+msg112)
        self.__label = label

Member Data Documentation

__label

Mixins._Labelable.__label

private

Definition at line 550 of file Mixins.py.

Referenced by Mixins._Labelable.__str__(), Mixins._ValidatingListBase._labelIfAny(), Mixins._Labelable.dumpSequenceConfig(), Mixins._Labelable.dumpSequencePython(), SequenceVisitors.PathValidator.enter(), SequenceVisitors.EndPathValidator.enter(), SequenceVisitors.FinalPathValidator.enter(), Mixins._Labelable.hasLabel_(), Mixins._Labelable.label(), Mixins._Labelable.label_(), SequenceVisitors.PathValidator.setLabel(), SequenceVisitors.EndPathValidator.setLabel(), and SequenceVisitors.FinalPathValidator.setLabel().