Belle II Software  release-05-02-19
CDCCosmicSelectorModule Class Reference

The Class for. More...

#include <CDCCosmicSelectorModule.h>

Inheritance diagram for CDCCosmicSelectorModule:
Collaboration diagram for CDCCosmicSelectorModule:

Public Types

enum  EModulePropFlags {
  c_Input = 1,
  c_Output = 2,
  c_ParallelProcessingCertified = 4,
  c_HistogramManager = 8,
  c_InternalSerializer = 16,
  c_TerminateInAllProcesses = 32,
  c_DontCollectStatistics = 64
}
 Each module can be tagged with property flags, which indicate certain features of the module. More...
 
typedef ModuleCondition::EAfterConditionPath EAfterConditionPath
 Forward the EAfterConditionPath definition from the ModuleCondition.
 

Public Member Functions

 CDCCosmicSelectorModule ()
 Constructor.
 
void initialize () override
 Initialize variables, print info, and start CPU clock.
 
void event () override
 Actual digitization of all hits in the CDC. More...
 
virtual std::vector< std::string > getFileNames (__attribute__((unused)) bool outputFiles)
 Return a list of output filenames for this modules. More...
 
virtual void beginRun ()
 Called when entering a new run. More...
 
virtual void endRun ()
 This method is called if the current run ends. More...
 
virtual void terminate ()
 This method is called at the end of the event processing. More...
 
const std::string & getName () const
 Returns the name of the module. More...
 
const std::string & getType () const
 Returns the type of the module (i.e. More...
 
const std::string & getPackage () const
 Returns the package this module is in.
 
const std::string & getDescription () const
 Returns the description of the module.
 
void setName (const std::string &name)
 Set the name of the module. More...
 
void setPropertyFlags (unsigned int propertyFlags)
 Sets the flags for the module properties. More...
 
LogConfiggetLogConfig ()
 Returns the log system configuration.
 
void setLogConfig (const LogConfig &logConfig)
 Set the log system configuration.
 
void setLogLevel (int logLevel)
 Configure the log level.
 
void setDebugLevel (int debugLevel)
 Configure the debug messaging level.
 
void setAbortLevel (int abortLevel)
 Configure the abort log level.
 
void setLogInfo (int logLevel, unsigned int logInfo)
 Configure the printed log information for the given level. More...
 
void if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 Add a condition to the module. More...
 
void if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to add a condition to the module. More...
 
void if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to set the condition of the module. More...
 
bool hasCondition () const
 Returns true if at least one condition was set for the module.
 
const ModuleConditiongetCondition () const
 Return a pointer to the first condition (or nullptr, if none was set)
 
const std::vector< ModuleCondition > & getAllConditions () const
 Return all set conditions for this module.
 
bool evalCondition () const
 If at least one condition was set, it is evaluated and true returned if at least one condition returns true. More...
 
std::shared_ptr< PathgetConditionPath () const
 Returns the path of the last true condition (if there is at least one, else reaturn a null pointer). More...
 
Module::EAfterConditionPath getAfterConditionPath () const
 What to do after the conditional path is finished. More...
 
std::vector< std::shared_ptr< Path > > getAllConditionPaths () const
 Return all condition paths currently set (no matter if the condition is true or not).
 
bool hasProperties (unsigned int propertyFlags) const
 Returns true if all specified property flags are available in this module. More...
 
bool hasUnsetForcedParams () const
 Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.
 
const ModuleParamListgetParamList () const
 Return module param list.
 
template<typename T >
ModuleParam< T > & getParam (const std::string &name) const
 Returns a reference to a parameter. More...
 
bool hasReturnValue () const
 Return true if this module has a valid return value set.
 
int getReturnValue () const
 Return the return value set by this module. More...
 
std::shared_ptr< PathElementclone () const override
 Create an independent copy of this module. More...
 
std::shared_ptr< boost::python::list > getParamInfoListPython () const
 Returns a python list of all parameters. More...
 

Static Public Member Functions

static void exposePythonAPI ()
 Exposes methods of the Module class to Python.
 

Protected Member Functions

virtual void def_initialize ()
 Wrappers to make the methods without "def_" prefix callable from Python. More...
 
virtual void def_beginRun ()
 Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.
 
virtual void def_event ()
 Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.
 
virtual void def_endRun ()
 This method can receive that the current run ends as a call from the Python side. More...
 
virtual void def_terminate ()
 Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.
 
void setDescription (const std::string &description)
 Sets the description of the module. More...
 
void setType (const std::string &type)
 Set the module type. More...
 
template<typename T >
void addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
 Adds a new parameter to the module. More...
 
template<typename T >
void addParam (const std::string &name, T &paramVariable, const std::string &description)
 Adds a new enforced parameter to the module. More...
 
void setReturnValue (int value)
 Sets the return value for this module as integer. More...
 
void setReturnValue (bool value)
 Sets the return value for this module as bool. More...
 
void setParamList (const ModuleParamList &params)
 Replace existing parameter list.
 

Private Member Functions

std::list< ModulePtrgetModules () const override
 no submodules, return empty list
 
std::string getPathString () const override
 return the module name.
 
void setParamPython (const std::string &name, const boost::python::object &pyObj)
 Implements a method for setting boost::python objects. More...
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary. More...
 

Private Attributes

StoreArray< MCParticlem_mcParticles
 array of MCParticle
 
double m_xOfCounter
 x-pos. More...
 
double m_yOfCounter
 y-pos. More...
 
double m_zOfCounter
 z-pos. More...
 
double m_phiOfCounter
 phi-angle of counter (deg)
 
double m_wOfCounter
 full-width of counter (cm)
 
double m_lOfCounter
 full-length of counter (cm)
 
double m_propSpeed
 Light speed in counter (cm/ns)
 
int m_tof
 tof option
 
bool m_cryGenerator
 cry or cosmics generator
 
bool m_top
 top option
 
std::string m_name
 The name of the module, saved as a string (user-modifiable)
 
std::string m_type
 The type of the module, saved as a string.
 
std::string m_package
 Package this module is found in (may be empty).
 
std::string m_description
 The description of the module.
 
unsigned int m_propertyFlags
 The properties of the module as bitwise or (with |) of EModulePropFlags.
 
LogConfig m_logConfig
 The log system configuration of the module.
 
ModuleParamList m_moduleParamList
 List storing and managing all parameter of the module.
 
bool m_hasReturnValue
 True, if the return value is set.
 
int m_returnValue
 The return value.
 
std::vector< ModuleConditionm_conditions
 Module condition, only non-null if set.
 

Detailed Description

The Class for.

Definition at line 42 of file CDCCosmicSelectorModule.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags
inherited

Each module can be tagged with property flags, which indicate certain features of the module.

Enumerator
c_Input 

This module is an input module (reads data).

c_Output 

This module is an output module (writes data).

c_ParallelProcessingCertified 

This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)

c_HistogramManager 

This module is used to manage histograms accumulated by other modules.

c_InternalSerializer 

This module is an internal serializer/deserializer for parallel processing.

c_TerminateInAllProcesses 

When using parallel processing, call this module's terminate() function in all processes().

This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.

c_DontCollectStatistics 

No statistics is collected for this module.

Definition at line 79 of file Module.h.

Member Function Documentation

◆ beginRun()

virtual void beginRun ( )
inlinevirtualinherited

Called when entering a new run.

Called at the beginning of each run, the method gives you the chance to change run dependent constants like alignment parameters, etc.

This method can be implemented by subclasses.

Reimplemented in DQMHistAnalysisPXDTrackChargeModule, DQMHistOutputToEPICSModule, DQMHistInjectionModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisPXDCMModule, DQMHistAnalysisPXDReductionModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDDAQModule, DQMHistAnalysisPXDEffModule, DQMHistAnalysisPXDInjectionModule, DQMHistAnalysisTrackingModule, PXDDigitizerModule, ECLDQMInjectionModule, PXDGatedModeDQMModule, PXDDAQDQMModule, PXDInjectionDQMModule, PXDBgTupleProducerModule, PXDMCBgTupleProducerModule, DQMHistAnalysisSVDDoseModule, SVDDQMInjectionModule, PXDDQMEfficiencySelftrackModule, DQMHistComparitorModule, PXDDQMEfficiencyModule, PyModule, PXDGatedDHCDQMModule, SVDDQMDoseModule, PXDROIFinderAnalysisModule, AlignDQMModule, SVDDQMExpressRecoModule, DQMHistAnalysisInputRootFileModule, SVDDQMClustersOnTrackModule, SVDUnpackerDQMModule, TrackDQMModule, PXDTrackClusterDQMModule, PXDRawDQMModule, PXDclusterFilterModule, PXDdigiFilterModule, DQMHistAnalysisPXDERModule, PXDDQMCorrModule, PXDROIDQMModule, PXDDQMExpressRecoModule, DelayDQMModule, PXDDQMClustersModule, VXDDQMExpressRecoModule, vxdDigitMaskingModule, PXDRawDQMCorrModule, DAQMonitorModule, DQMHistAnalysisIPModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisExampleFlagsModule, V0ObjectsDQMModule, TRGCDCT3DUnpackerModule, TRGCDCTSFUnpackerModule, TRGGRLUnpackerModule, TRGCDCETFUnpackerModule, MaterialScanModule, TOPUnpackerModule, B2BIIConvertMdstModule, ECLWaveformFitModule, FindletModule< AFindlet >, FindletModule< FacetCreator >, FindletModule< TrackFinderAutomaton >, FindletModule< CKFToCDCFromEclFindlet >, FindletModule< CKFToSVDSeedFindlet >, FindletModule< CKFToCDCFindlet >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialStraightTrackFinder >, FindletModule< SegmentLinker >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentOrienter >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< CKFToSVDFindlet >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackRejecter >, FindletModule< SegmentCreatorMCTruth >, FindletModule< TrackFinderCosmics >, FindletModule< SuperClusterCreator >, FindletModule< HitBasedT0Extractor >, FindletModule< AsicBackgroundLibraryCreator >, FindletModule< TrackExporter >, FindletModule< ClusterPreparer >, FindletModule< CosmicsTrackMergerFindlet >, FindletModule< AxialTrackFinderHough >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackLinker >, FindletModule< TrackOrienter >, FindletModule< TrackFinder >, FindletModule< AxialTrackFinderLegendre >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< SegmentPairCreator >, FindletModule< HitReclaimer >, FindletModule< TrackQualityEstimator >, FindletModule< CKFToPXDFindlet >, FindletModule< StereoHitFinder >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< SegmentFitter >, FindletModule< SegmentRejecter >, FindletModule< WireHitPreparer >, FindletModule< SegmentTripleCreator >, FindletModule< SegmentTrackCombiner >, FindletModule< MCVXDCDCTrackMergerFindlet >, FindletModule< MonopoleStereoHitFinder >, FindletModule< TrackCombiner >, FindletModule< AxialSegmentPairCreator >, FindletModule< WireHitBackgroundDetector >, FindletModule< ClusterBackgroundDetector >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFindlet >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< TrackQualityAsserter >, FindletModule< WireHitCreator >, SVDBackgroundModule, TOPTimeBaseCalibratorModule, TOPTBCComparatorModule, B2BIIFixMdstModule, ECLChargedPIDModule, SVDDigitizerModule, ARICHNtupleModule, ECLDigitizerModule, BeamBkgTagSetterModule, PXDBackgroundModule, ParticleKinematicFitterModule, ECLShowerShapeModule, TOPGainEfficiencyCalculatorModule, SoftwareTriggerModule, ChargedPidMVAModule, ChargedPidMVAMulticlassModule, KLMClustersReconstructorModule, OpticalGunModule, SegmentNetworkProducerModule, TagVertexModule, KLMDQMModule, CDCDedxValidationModule, TOPDQMModule, CDCDQMModule, TOPDigitizerModule, TOPLaserHitSelectorModule, DQMHistAnalysisKLMModule, BKLMDigitAnalyzerModule, TOPModuleT0CalibratorModule, DQMHistAnalysisTRGGDLModule, GearboxModule, KLMUnpackerModule, TOPChannelT0CalibratorModule, TOPCommonT0CalibratorModule, ParticleVertexFitterModule, ECLCRFinderModule, KLMReconstructorModule, SVDUnpackerModule, TOPRawDigitConverterModule, DQMHistAnalysisCDCMonObjModule, ECLDigitizerPureCsIModule, ECLLocalRunCalibratorModule, KLMDigitizerModule, CDCCRTestModule, EKLMDataCheckerModule, TOPReconstructorModule, TrackFinderVXDBasicPathFinderModule, TrackFinderVXDCellOMatModule, ECLDataAnalysisModule, KLMPackerModule, FullSimModule, TOPChannelMaskerModule, TRGGDLUnpackerModule, HLTDQM2ZMQModule, ECLShowerCorrectorModule, MdstPIDModule, SVDCoGTimeEstimatorModule, ARICHDigitizerModule, ARICHDQMModule, BelleMCOutputModule, CsIDigitizerModule, DQMHistAnalysisARICHModule, ECLDQMModule, TOPAlignerModule, ARICHFillHitsModule, ARICHPackerModule, ARICHReconstructorModule, BeamBkgHitRateMonitorModule, BeamBkgMixerModule, CDCCosmicAnalysisModule, CDCUnpackerModule, ECLSplitterN1Module, PXDPerformanceModule, TOPPDFCheckerModule, ARICHRelateModule, CsIStudyModule, CDCPackerModule, DQMHistAnalysisMiraBelleModule, ECLDigitCalibratorModule, ECLDQMEXTENDEDModule, TOPPDFDebuggerModule, ARICHUnpackerModule, BKLMSimHistogrammerModule, SVDROIFinderAnalysisModule, VXDTFTrainingDataCollectorModule, ARICHMCParticlesModule, ARICHRateCalModule, TOPBackgroundModule, TOPTimeRecalibratorModule, TrackFinderMCTruthRecoTracksModule, ReprocessorModule, ECLChargedPIDDataAnalysisModule, ECLChargedPIDDataAnalysisValidationModule, EclDisplayModule, EvtGenDecayModule, EKLMADCModule, SVDDQMHitTimeModule, TOPDoublePulseGeneratorModule, SVDROIFinderModule, TRGCDCT3DConverterModule, TRGGRLMatchModule, BGOverlayExecutorModule, DQMHistAnalysisECLModule, ECLLocalMaximumFinderModule, SoftwareTriggerHLTDQMModule, SVDPackerModule, TOPBunchFinderModule, VXDSimpleClusterizerModule, ARICHRawUnpackerModule, NtuplePhase1_v6Module, TpcDigitizerModule, ExportGeometryModule, KLMClusterEfficiencyModule, CDCDedxDQMModule, SVDLocalCalibrationsMonitorModule, SVDPerformanceModule, TOPCalPulseGeneratorModule, TOPNtupleModule, TOPPackerModule, TOPWaveformFeatureExtractorModule, ExtModule, MCTrackCandClassifierModule, MuidModule, SPTCmomentumSeedRetrieverModule, TrackFinderVXDAnalizerModule, TRGTOPDQMModule, BeamBkgGeneratorModule, DQMHistAnalysisInputPVSrvModule, ECLClusterPSDModule, EventInfoPrinterModule, BKLMTrackingModule, KLMExpertModule, SVDOccupancyAnalysisModule, TOPInterimFENtupleModule, TOPMCTrackMakerModule, BGOverlayInputModule, CDCRecoTrackFilterModule, ECLBackgroundModule, EvtGenInputModule, OverrideGenerationFlagsModule, MCMatcherKLMClustersModule, PIDNtupleModule, SVDDataFormatCheckModule, SPTCvirtualIPRemoverModule, HitXPModule, arichBtestModule, BgoStudyModule, CsiStudy_v2Module, FANGSDigitizerModule, MicrotpcStudyModule, PlumeDigitizerModule, DQMHistAnalysisARICHMonObjModule, PXDClustersFromTracksModule, EventT0DQMModule, TOPXTalkChargeShareSetterModule, PXDROIFinderModule, VXDQualityEstimatorMVAModule, AnalysisPhase1StudyModule, DosiStudyModule, He3tubeStudyModule, ECLCovarianceMatrixModule, ECLFinalizerModule, ECLSplitterN2Module, KKGenInputModule, BKLMAnaModule, SVDLocalCalibrationsCheckModule, SVDClusterEvaluationTrueInfoModule, TOPTriggerDigitizerModule, TrackingPerformanceEvaluationModule, SecMapTrainerVXDTFModule, TRGECLRawdataAnalysisModule, TRGTOPUnpackerModule, BgoDigitizerModule, CsiDigitizer_v2Module, DosiDigitizerModule, TPCStudyModule, PinDigitizerModule, ECLShowerCalibratorModule, ECLUnpackerModule, MVAExpertModule, MVAMultipleExpertsModule, SVDLatencyCalibrationModule, SVDB4CommissioningPlotsModule, SVDClusterEvaluationModule, EffPlotsModule, SecMapTrainerBaseModule, He3DigitizerModule, DQMHistAnalysisMonObjModule, DQMHistSnapshotsModule, MCMatcherECLClustersModule, KlongValidationModule, TOPCosmicT0FinderModule, TrackQualityEstimatorMVAModule, BeamabortStudyModule, ClawStudyModule, ClawsStudyModule, PindiodeStudyModule, QcsmonitorStudyModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisHLTMonObjModule, IPDQMExpressRecoModule, PXDRawDQMChipsModule, SVDClusterCalibrationsMonitorModule, SVDMissingAPVsClusterCreatorModule, SectorMapBootstrapModule, CurlTaggerModule, BeamDigitizerModule, ECLPackerModule, EventLimiterModule, RandomBarrierModule, V0findingPerformanceEvaluationModule, DQMHistDeltaHistoModule, StatisticsSummaryModule, MVAPrototypeModule, DataWriterModule, SVDClusterFilterModule, SVDMaxStripTTreeModule, SVDShaperDigitsFromTracksModule, SVD3SamplesEmulatorModule, QualityEstimatorVXDModule, VXDQETrainingDataCollectorModule, MCMatcherTRGECLModule, TRGGDLModule, EventKinematicsModule, ClawDigitizerModule, ClawsDigitizerModule, ECLHitDebugModule, SubEventModule, SVDCoGTimeCalibrationsMonitorModule, SVDHotStripFinderModule, TOPLaserCalibratorModule, BeamSpotMonitorModule, TrackQETrainingDataCollectorModule, CDCTriggerNeuroDQMModule, TRGECLModule, FANGSStudyModule, QcsmonitorDigitizerModule, DQMHistAnalysisTOPModule, TOPChannelT0MCModule, B2BIIConvertBeamParamsModule, ProgressModule, TRGECLFAMModule, B2BIIMdstInputModule, CsiModule, CreateFieldMapModule, TRGGRLModule, DQMHistAnalysisSVDOnMiraBelleModule, Convert2RawDetModule, TRGGRLProjectsModule, TRGCDCModule, DQMHistAnalysisOutputMonObjModule, CosmicsAlignmentValidationModule, TRGCDCTSStreamModule, TRGGDLDQMModule, VXDMisalignmentModule, TreeFitterModule, DQMHistAnalysisInputModule, SwitchDataStoreModule, TRGECLQAMModule, TRGECLTimingCalModule, IoVDependentConditionModule, StatisticsTimingHLTDQMModule, PhysicsObjectsMiraBelleModule, KLMTriggerModule, cdcDQM7Module, DQMHistAnalysisInputSrvModule, SeqRootOutputModule, DQMHistAnalysisEventT0Module, DQMHistAnalysisSVDGeneralModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, HistoModule, TxModule, TRGGRLDQMModule, DQMHistAnalysisOutputNSMModule, DQMHistAnalysisPlotOnlyModule, DQMHistAnalysisSVDEfficiencyModule, RxModule, svdDumpModule, B2BIIMCParticlesMonitorModule, DQMHistAnalysisExampleModule, DQMHistAnalysisOutputRelayMsgModule, DQMHistAnalysisOutputFileModule, MCV0MatcherModule, TRGECLDQMModule, DQMHistAnalysisOutputModule, HistoManagerModule, SeqRootInputModule, TRGCDCT2DDQMModule, TRGCDCT3DDQMModule, TRGGDLSummaryModule, PhysicsObjectsDQMModule, TRGCDCTSFDQMModule, TRGGDLDSTModule, CalibrationCollectorModule, DQMHistAnalysisHLTModule, CDCTriggerUnpackerModule, ARICHBackgroundModule, TRGECLUnpackerModule, EvReductionModule, Raw2DsModule, RawInputModule, StorageDeserializerModule, BeamabortModule, BgoModule, CaveModule, ClawModule, CLAWSModule, DosiModule, FANGSModule, He3tubeModule, MicrotpcModule, Ph1bpipeModule, Ph1sustrModule, PindiodeModule, PlumeModule, QcsmonitorModule, SrsensorModule, SerializerModule, FastRbuf2DsModule, Ds2SampleModule, DeSerializerPXDModule, Rbuf2RbufModule, Rbuf2DsModule, TxSocketModule, DqmHistoManagerModule, Ds2RawModule, Ds2RawFileModule, Ds2RbufModule, StorageSerializerModule, GetEventFromSocketModule, ReceiveEventModule, ElapsedTimeModule, GenRawSendModule, MonitorDataCOPPERModule, RxSocketModule, CertifyParallelModule, SeqRootMergerModule, DAQPerfModule, MonitorDataModule, TrackAnaModule, and PartialSeqRootReaderModule.

Definition at line 149 of file Module.h.

◆ clone()

std::shared_ptr< PathElement > clone ( ) const
overridevirtualinherited

Create an independent copy of this module.

Note that parameters are shared, so changing them on a cloned module will also affect the original module.

Implements PathElement.

Definition at line 181 of file Module.cc.

◆ def_endRun()

virtual void def_endRun ( )
inlineprotectedvirtualinherited

This method can receive that the current run ends as a call from the Python side.

For regular C++-Modules that forwards the call to the regular endRun() method.

Reimplemented in PyModule.

Definition at line 441 of file Module.h.

◆ def_initialize()

virtual void def_initialize ( )
inlineprotectedvirtualinherited

Wrappers to make the methods without "def_" prefix callable from Python.

Overridden in PyModule. Wrapper method for the virtual function initialize() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 422 of file Module.h.

◆ endRun()

virtual void endRun ( )
inlinevirtualinherited

This method is called if the current run ends.

Use this method to store information, which should be aggregated over one run.

This method can be implemented by subclasses.

Reimplemented in DQMHistAnalysisPXDTrackChargeModule, DQMHistOutputToEPICSModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisSVDDoseModule, PyModule, DQMHistComparitorModule, TrackSetEvaluatorHopfieldNNDEVModule, DQMHistAnalysisInputRootFileModule, AlignDQMModule, SVDUnpackerDQMModule, DQMHistAnalysisPXDERModule, vxdDigitMaskingModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisExampleFlagsModule, TRGCDCT3DUnpackerModule, TRGCDCTSFUnpackerModule, TRGGRLUnpackerModule, TRGCDCETFUnpackerModule, TOPUnpackerModule, FindletModule< AFindlet >, FindletModule< FacetCreator >, FindletModule< TrackFinderAutomaton >, FindletModule< CKFToCDCFromEclFindlet >, FindletModule< CKFToSVDSeedFindlet >, FindletModule< CKFToCDCFindlet >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialStraightTrackFinder >, FindletModule< SegmentLinker >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentOrienter >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< CKFToSVDFindlet >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackRejecter >, FindletModule< SegmentCreatorMCTruth >, FindletModule< TrackFinderCosmics >, FindletModule< SuperClusterCreator >, FindletModule< HitBasedT0Extractor >, FindletModule< AsicBackgroundLibraryCreator >, FindletModule< TrackExporter >, FindletModule< ClusterPreparer >, FindletModule< CosmicsTrackMergerFindlet >, FindletModule< AxialTrackFinderHough >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackLinker >, FindletModule< TrackOrienter >, FindletModule< TrackFinder >, FindletModule< AxialTrackFinderLegendre >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< SegmentPairCreator >, FindletModule< HitReclaimer >, FindletModule< TrackQualityEstimator >, FindletModule< CKFToPXDFindlet >, FindletModule< StereoHitFinder >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< SegmentFitter >, FindletModule< SegmentRejecter >, FindletModule< WireHitPreparer >, FindletModule< SegmentTripleCreator >, FindletModule< SegmentTrackCombiner >, FindletModule< MCVXDCDCTrackMergerFindlet >, FindletModule< MonopoleStereoHitFinder >, FindletModule< TrackCombiner >, FindletModule< AxialSegmentPairCreator >, FindletModule< WireHitBackgroundDetector >, FindletModule< ClusterBackgroundDetector >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFindlet >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< TrackQualityAsserter >, FindletModule< WireHitCreator >, ECLWaveformFitModule, B2BIIConvertMdstModule, TOPTimeBaseCalibratorModule, TOPTBCComparatorModule, ECLChargedPIDModule, SVDBackgroundModule, ARICHNtupleModule, ECLDigitizerModule, BeamBkgTagSetterModule, TOPGainEfficiencyCalculatorModule, ECLShowerShapeModule, KLMClustersReconstructorModule, OpticalGunModule, ParticleKinematicFitterModule, PXDBackgroundModule, CDCDedxValidationModule, ARICHDigitizerModule, KLMDQMModule, TOPDQMModule, CDCDQMModule, TOPLaserHitSelectorModule, TOPModuleT0CalibratorModule, DQMHistAnalysisKLMModule, DQMHistAnalysisTRGGDLModule, BKLMDigitAnalyzerModule, TOPChannelT0CalibratorModule, TOPCommonT0CalibratorModule, KLMUnpackerModule, TOPRawDigitConverterModule, TOPReconstructorModule, ARICHFillHitsModule, DQMHistAnalysisCDCMonObjModule, KLMReconstructorModule, CDCCRTestModule, KLMDigitizerModule, ECLDigitizerPureCsIModule, EKLMDataCheckerModule, ARICHReconstructorModule, ECLLocalRunCalibratorModule, KLMPackerModule, MdstPIDModule, FullSimModule, ARICHDQMModule, CDCUnpackerModule, DQMHistAnalysisARICHModule, ECLCRFinderModule, TOPAlignerModule, TOPPDFDebuggerModule, ARICHPackerModule, BelleMCOutputModule, BeamBkgMixerModule, CDCPackerModule, TOPBackgroundModule, TOPPDFCheckerModule, ARICHRelateModule, BeamBkgHitRateMonitorModule, CsIDigitizerModule, DQMHistAnalysisMiraBelleModule, ARICHUnpackerModule, ARICHMCParticlesModule, ARICHRateCalModule, CDCCosmicAnalysisModule, ECLShowerCorrectorModule, SVDCoGTimeEstimatorModule, SVDUnpackerModule, SVDROIFinderAnalysisModule, ECLDataAnalysisModule, EclDisplayModule, TOPDoublePulseGeneratorModule, TOPWaveformQualityPlotterModule, BGOverlayExecutorModule, ECLChargedPIDDataAnalysisValidationModule, ECLDigitCalibratorModule, ECLSplitterN1Module, EvtGenDecayModule, EKLMADCModule, SVDROIFinderModule, TRGGDLUnpackerModule, ARICHRawUnpackerModule, NtuplePhase1_v6Module, ECLDQMModule, TOPCalPulseGeneratorModule, TOPNtupleModule, TOPPackerModule, TOPWaveformFeatureExtractorModule, TrackFinderMCTruthRecoTracksModule, VXDTFTrainingDataCollectorModule, BeamBkgGeneratorModule, EventInfoPrinterModule, BKLMSimHistogrammerModule, KLMClusterEfficiencyModule, PXDPerformanceModule, TOPInterimFENtupleModule, TOPMCTrackMakerModule, VXDSimpleClusterizerModule, BGOverlayInputModule, TpcDigitizerModule, ECLDQMEXTENDEDModule, PIDNtupleModule, SPTCvirtualIPRemoverModule, arichBtestModule, ReprocessorModule, CsIStudyModule, ECLChargedPIDDataAnalysisModule, OverrideGenerationFlagsModule, MCMatcherKLMClustersModule, PrintDataModule, SPTCmomentumSeedRetrieverModule, TrackFinderVXDAnalizerModule, TRGGRLMatchModule, DQMHistAnalysisARICHMonObjModule, ECLLocalMaximumFinderModule, CDCDedxDQMModule, FANGSDigitizerModule, CDCRecoTrackFilterModule, ECLClusterPSDModule, SVDLocalCalibrationsMonitorModule, TOPTriggerDigitizerModule, ExtModule, MCTrackCandClassifierModule, MuidModule, HLTDQM2ZMQModule, DQMHistAnalysisECLModule, IPDQMExpressRecoModule, BKLMTrackingModule, TOPCosmicT0FinderModule, HitXPModule, TRGCDCT3DConverterModule, DQMHistAnalysisMonObjModule, ECLBackgroundModule, EventT0DQMModule, SVDDataFormatCheckModule, TRGTOPDQMModule, BgoStudyModule, CsiStudy_v2Module, MicrotpcStudyModule, PlumeDigitizerModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisHLTMonObjModule, PXDClustersFromTracksModule, SVDPackerModule, SVDClusterEvaluationTrueInfoModule, TOPXTalkChargeShareSetterModule, SecMapTrainerVXDTFModule, AnalysisPhase1StudyModule, DosiStudyModule, He3tubeStudyModule, ECLCovarianceMatrixModule, ECLFinalizerModule, ECLSplitterN2Module, MCMatcherECLClustersModule, BKLMAnaModule, SVDHotStripFinderModule, SVDPerformanceModule, SecMapTrainerBaseModule, NoKickCutsEvalModule, TRGECLRawdataAnalysisModule, TRGTOPUnpackerModule, BgoDigitizerModule, CsiDigitizer_v2Module, DosiDigitizerModule, TPCStudyModule, PinDigitizerModule, HLTDs2ZMQModule, DQMHistAnalysisInputPVSrvModule, ECLShowerCalibratorModule, SVDLatencyCalibrationModule, SVDOccupancyAnalysisModule, TOPLaserCalibratorModule, PXDROIFinderModule, KlongValidationModule, TrackingPerformanceEvaluationModule, MCMatcherTRGECLModule, BeamabortStudyModule, ClawStudyModule, ClawsStudyModule, PindiodeStudyModule, QcsmonitorStudyModule, ECLHitDebugModule, ECLUnpackerModule, SVDClusterCalibrationsMonitorModule, TOPChannelT0MCModule, EffPlotsModule, CurlTaggerModule, BeamDigitizerModule, He3DigitizerModule, StatisticsSummaryModule, DataWriterModule, SVDB4CommissioningPlotsModule, SVDClusterEvaluationModule, SVDClusterFilterModule, SVDShaperDigitsFromTracksModule, SVD3SamplesEmulatorModule, RT2SPTCConverterModule, SVDROIDQMModule, TRGGDLModule, EventKinematicsModule, ClawDigitizerModule, ClawsDigitizerModule, DQMHistSnapshotsModule, ECLPackerModule, PrintEventRateModule, SVDCoGTimeCalibrationsMonitorModule, V0findingPerformanceEvaluationModule, TRGECLModule, CosmicsAlignmentValidationModule, FANGSStudyModule, QcsmonitorDigitizerModule, SectorMapBootstrapModule, CsiModule, DQMHistDeltaHistoModule, RandomBarrierModule, TRGGRLModule, GenfitVisModule, CDCTriggerNeuroDQMModule, TRGECLFAMModule, TRGGRLProjectsModule, B2BIIMdstInputModule, DQMHistAnalysisTOPModule, SubEventModule, TRGCDCModule, DQMHistAnalysisSVDOnMiraBelleModule, TRGCDCTSStreamModule, Convert2RawDetModule, TRGGDLDQMModule, DQMHistAnalysisOutputMonObjModule, TRGECLQAMModule, TRGECLTimingCalModule, MCV0MatcherModule, DQMHistAnalysisInputModule, cdcDQM7Module, SwitchDataStoreModule, PhysicsObjectsMiraBelleModule, HistoModule, TRGGRLDQMModule, KLMTriggerModule, DQMHistAnalysisEventT0Module, DQMHistAnalysisInputSrvModule, SeqRootOutputModule, DQMHistAnalysisSVDGeneralModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, TxModule, B2BIIMCParticlesMonitorModule, DQMHistAnalysisOutputNSMModule, DQMHistAnalysisPlotOnlyModule, DQMHistAnalysisSVDEfficiencyModule, RxModule, Root2BinaryModule, DQMHistAnalysisExampleModule, DQMHistAnalysisOutputRelayMsgModule, svdDumpModule, TRGECLDQMModule, DQMHistAnalysisOutputFileModule, TRGCDCT2DDQMModule, DQMHistAnalysisOutputModule, SeqRootInputModule, TRGCDCT3DDQMModule, TRGGDLSummaryModule, HistoManagerModule, TRGCDCTSFDQMModule, TRGGDLDSTModule, PhysicsObjectsDQMModule, CalibrationCollectorModule, ARICHBackgroundModule, TRGECLUnpackerModule, EvReductionModule, Raw2DsModule, RawInputModule, StorageDeserializerModule, BeamabortModule, BgoModule, CaveModule, ClawModule, CLAWSModule, DosiModule, FANGSModule, He3tubeModule, MicrotpcModule, Ph1bpipeModule, Ph1sustrModule, PindiodeModule, PlumeModule, QcsmonitorModule, SrsensorModule, SerializerModule, FastRbuf2DsModule, Ds2SampleModule, DeSerializerPXDModule, Rbuf2RbufModule, GenRawSendModule, Rbuf2DsModule, TxSocketModule, Ds2RawModule, Ds2RawFileModule, DqmHistoManagerModule, Ds2RbufModule, StorageSerializerModule, GetEventFromSocketModule, ReceiveEventModule, ElapsedTimeModule, MonitorDataCOPPERModule, Root2RawModule, RxSocketModule, CertifyParallelModule, SeqRootMergerModule, DAQPerfModule, MonitorDataModule, TrackAnaModule, and PartialSeqRootReaderModule.

Definition at line 168 of file Module.h.

◆ evalCondition()

bool evalCondition ( ) const
inherited

If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

If no condition or result value was defined, the method returns false. Otherwise, the condition is evaluated and true returned, if at least one condition returns true. To speed up the evaluation, the condition strings were already parsed in the method if_value().

Returns
True if at least one condition and return value exists and at least one condition expression was evaluated to true.

Definition at line 98 of file Module.cc.

◆ event()

void event ( )
overridevirtual

Actual digitization of all hits in the CDC.

The digitized hits are written into the DataStore.

Reimplemented from Module.

Definition at line 46 of file CDCCosmicSelectorModule.cc.

47 {
48  bool returnVal = false;
49 
50  int nMCPs = m_mcParticles.getEntries();
51  if (nMCPs == 0) {
52  B2ERROR("No. of MCParticles=0 in the current event.");
53  setReturnValue(returnVal);
54  return;
55  }
56 
57  /*
58  const double yOfCounter = -16.25 + 3.0;
59  const double wOfCounter = 3.5;
60  const double zminOfCounter = -1.5 - 15.5;
61  const double zmaxOfCounter = -1.5 + 15.5;
62  */
63 
64  // Loop over prim. charged MC particle
65  const double c = 29.9792458; //light speed (cm/ns)
66  double mass = 0.1056583715; //muon mass (GeV)
67  unsigned nPrimChgds = 0;
68 
69  for (int iMCPs = 0; iMCPs < nMCPs; ++iMCPs) {
70  MCParticle* m_P = m_mcParticles[iMCPs];
71 
72  // B2INFO("isPrimaryParticle= " << m_P->isPrimaryParticle());
73  if (!m_P->isPrimaryParticle()) continue;
74 
75  unsigned pid = abs(m_P->getPDG());
76  if (pid == 13) {
77  ++nPrimChgds;
78  } else if (pid == 11) {
79  ++nPrimChgds;
80  mass = 0.000510998928;
81  } else if (pid == 211) {
82  ++nPrimChgds;
83  mass = 0.13957018;
84  } else if (pid == 321) {
85  ++nPrimChgds;
86  mass = 0.493677;
87  } else if (pid == 2212) {
88  ++nPrimChgds;
89  mass = 0.938272046;
90  } else {
91  continue;
92  }
93 
94  // B2INFO("No .of prim. charged MC particles= " << nPrimChgds);
95  if (nPrimChgds > 1) continue;
96 
97  const TVector3 vertex = m_P->getProductionVertex();
98  const double vX0 = vertex.X();
99  const double vY0 = vertex.Y();
100  const double cosphi = cos(m_phiOfCounter * M_PI / 180.);
101  const double sinphi = sin(m_phiOfCounter * M_PI / 180.);
102  //(vx,vy) is prod. vertex in frame rotated in phi wrt lab. frame
103  const double vX = cosphi * vX0 + sinphi * vY0;
104  const double vY = -sinphi * vX0 + cosphi * vY0;
105  const double vZ = vertex.Z();
106 
107  // std::cout <<" "<< std::endl;
108  // std::cout <<"vr,vx,vy,yz= "<< sqrt(vX*vX + vY*vY) <<" "<<vX <<" "<< vY <<" "<< vZ << std::endl;
109 
110  const TVector3 momentum = m_P->getMomentum();
111  //(px,py) is momentum in frame rotated in phi wrt lab. frame
112  const double pX0 = momentum.X();
113  const double pY0 = momentum.Y();
114  const double pX = cosphi * pX0 + sinphi * pY0;
115  const double pY = -sinphi * pX0 + cosphi * pY0;
116  const double pZ = momentum.Z();
117 
118  double xi = -999.;
119  double yi = -999.;
120  double zi = -999.;
121 
122  //(x...,y...) is counter pos. in frame rotated in phi wrt lab. frame
123  const double xOfCounter = cosphi * m_xOfCounter + sinphi * m_yOfCounter;
124  const double yOfCounter = -sinphi * m_xOfCounter + cosphi * m_yOfCounter;
125 
126  if (pY != 0.) {
127  xi = (yOfCounter - vY) * (pX / pY) + vX;
128  yi = yOfCounter;
129  zi = (yOfCounter - vY) * (pZ / pY) + vZ;
130  } else {
131  //todo improve the following 3 lines and add check accept or not also in y-direction
132  xi = 0.;
133  yi = yOfCounter;
134  zi = -vX * (pZ / pX) + vZ;
135  }
136 
137  // std::cout << "xi,yi,zi= " << xi <<" "<< yi <<" "<< zi << std::endl;
138 
139  bool hitCounter = (fabs(xi - xOfCounter) < 0.5 * m_wOfCounter && fabs(zi - m_zOfCounter) < 0.5 * m_lOfCounter) ? true : false;
140 
141  //if hit, re-set the production time to zero at IP
142  if (hitCounter) {
143  // std::cout <<"checkxiyizi " << cosphi*xi-sinphi*yi<<" "<< sinphi*xi+cosphi *yi <<" "<< zi << std::endl;
144  returnVal = true;
145  const double p = sqrt(pX * pX + pY * pY + pZ * pZ);
146  const double cX = pX / p;
147  const double cY = pY / p;
148 
149  double fl = 0.;
150  if (m_tof == 1) {
151  fl = sqrt((xi - vX) * (xi - vX) + (yi - vY) * (yi - vY) + (zi - vZ) * (zi - vZ)); // fl to counter
152  // std::cout <<"fl= " << fl << std::endl;
153  } else if (m_tof == 2) {
154  fl = -(cX * vX + cY * vY) / (cX * cX + cY * cY); //fl to origin
155  } else {
156  B2FATAL("invalid tof option !");
157  }
158  // if (fl < 0.) B2FATAL("negative tof !");
159  // std::cout << "fl,flp,dif= " << fl <<" "<< flp <<" "<< fl-flp << std::endl;
160  // double dot = pX*(xi - vX) + pY*(yi - vY);
161  // if (dot < 0.) fl *= -1.;
162 
163  const double beta = p / sqrt(p * p + mass * mass);
164  double pTime = m_P->getProductionTime();
165  // const double pTimeOrg = pTime;
166 
167  if (m_cryGenerator) {
168  //calculate an intersection with y=0 plane
169  double xi4cry = -999.;
170  double yi4cry = 0.;
171  double zi4cry = -999.;
172  if (pY0 != 0.) {
173  xi4cry = (0. - vY0) * (pX0 / pY0) + vX0;
174  zi4cry = (0. - vY0) * (pZ / pY0) + vZ;
175  } else {
176  xi4cry = 0.;
177  zi4cry = -vX0 * (pZ / pX0) + vZ;
178  }
179 
180  const double fl4cry = sqrt((xi4cry - vX0) * (xi4cry - vX0) + (yi4cry - vY0) * (yi4cry - vY0) + (zi4cry - vZ) *
181  (zi4cry - vZ)); // fl to y=0 plane
182 
183  //reset production time (to the time which old CRY set) once
184  pTime += fl4cry / (c * beta);
185  }
186 
187  const double tofToCounter = fl / (c * beta);
188  const double topToPMT = m_top ? hypot(xi - xOfCounter, zi - (m_zOfCounter - 0.5 * m_lOfCounter)) / m_propSpeed : 0.;
189  /*
190  std::cout << "xi = " << xi << std::endl;
191  std::cout << "xOfCounter = " << xOfCounter << std::endl;
192  std::cout << "zi = " << zi << std::endl;
193  std::cout << "m_zOfCounter= " << m_zOfCounter << std::endl;
194  std::cout << "m_lOfCounter= " << m_lOfCounter << std::endl;
195  std::cout << "m_propSpeed = " << m_propSpeed << std::endl;
196  std::cout << "topToPMT = " << topToPMT << std::endl;
197  */
198  m_P->setProductionTime(pTime - tofToCounter - topToPMT);
199  // std::cout <<"org,mod= " << pTimeOrg << m_P->getProductionTime() << std::endl;
200  //if not hit, reverse the momentum vector so that the particle will not be simulated
201  //better to use condition in basf2...
202  } else {
203  // m_P->setMomentum(-1. * momentum);
204 
205  }
206  } // end loop over MCParticles
207  setReturnValue(returnVal);
208 }

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const
inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 135 of file Module.cc.

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const
inherited

Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).


Definition at line 115 of file Module.cc.

◆ getFileNames()

virtual std::vector<std::string> getFileNames ( __attribute__((unused)) bool  outputFiles)
inlinevirtualinherited

Return a list of output filenames for this modules.

This will be called when basf2 is run with "--dry-run" if the module has set either the c_Input or c_Output properties.

If the parameter outputFiles is false (for modules with c_Input) the list of input filenames should be returned (if any). If outputFiles is true (for modules with c_Output) the list of output files should be returned (if any).

If a module has sat both properties this member is called twice, once for each property.

The module should return the actual list of requested input or produced output filenames (including handling of input/output overrides) so that the grid system can handle input/output files correctly.

This function should return the same value when called multiple times. This is especially important when taking the input/output overrides from Environment as they get consumed when obtained so the finalized list of output files should be stored for subsequent calls.

Definition at line 136 of file Module.h.

◆ getName()

const std::string& getName ( ) const
inlineinherited

Returns the name of the module.

This can be changed via e.g. set_name() in the steering file to give more useful names if there is more than one module of the same type.

For identifying the type of a module, using getType() (or type() in Python) is recommended.

Definition at line 189 of file Module.h.

◆ getParamInfoListPython()

std::shared_ptr< boost::python::list > getParamInfoListPython ( ) const
inherited

Returns a python list of all parameters.

Each item in the list consists of the name of the parameter, a string describing its type, a python list of all default values and the description of the parameter.

Returns
A python list containing the parameters of this parameter list.

Definition at line 281 of file Module.cc.

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 383 of file Module.h.

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 43 of file Module.cc.

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

Returns true if all specified property flags are available in this module.

Parameters
propertyFlagsOred EModulePropFlags which should be compared with the module flags.

Definition at line 162 of file Module.cc.

◆ if_false()

void if_false ( const std::shared_ptr< Path > &  path,
EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End 
)
inherited

A simplified version to add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression "<1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters
pathShared pointer to the Path which will be executed if the return value is false.
afterConditionPathWhat to do after executing 'path'.

Definition at line 87 of file Module.cc.

◆ if_true()

void if_true ( const std::shared_ptr< Path > &  path,
EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End 
)
inherited

A simplified version to set the condition of the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression ">=1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters
pathShared pointer to the Path which will be executed if the return value is true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 92 of file Module.cc.

◆ if_value()

void if_value ( const std::string &  expression,
const std::shared_ptr< Path > &  path,
EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End 
)
inherited

Add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

See https://confluence.desy.de/display/BI/Software+ModCondTut or ModuleCondition for a description of the syntax.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

Parameters
expressionThe expression of the condition.
pathShared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 81 of file Module.cc.

◆ setDescription()

void setDescription ( const std::string &  description)
protectedinherited

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 216 of file Module.cc.

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

Parameters
logLevelThe log level (one of LogConfig::ELogLevel)
logInfoWhat kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 75 of file Module.cc.

◆ setName()

void setName ( const std::string &  name)
inlineinherited

Set the name of the module.

Note
The module name is set when using the REG_MODULE macro, but the module can be renamed before calling process() using the set_name() function in your steering file.
Parameters
nameThe name of the module

Definition at line 216 of file Module.h.

◆ setParamPython()

void setParamPython ( const std::string &  name,
const boost::python::object &  pyObj 
)
privateinherited

Implements a method for setting boost::python objects.

The method supports the following types: list, dict, int, double, string, bool The conversion of the python object to the C++ type and the final storage of the parameter value is done in the ModuleParam class.

Parameters
nameThe unique name of the parameter.
pyObjThe object which should be converted and stored as the parameter value.

Definition at line 236 of file Module.cc.

◆ setParamPythonDict()

void setParamPythonDict ( const boost::python::dict &  dictionary)
privateinherited

Implements a method for reading the parameter values from a boost::python dictionary.

The key of the dictionary has to be the name of the parameter and the value has to be of one of the supported parameter types.

Parameters
dictionaryThe python dictionary from which the parameter values are read.

Definition at line 251 of file Module.cc.

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 210 of file Module.cc.

◆ setReturnValue() [1/2]

void setReturnValue ( bool  value)
protectedinherited

Sets the return value for this module as bool.

The bool value is saved as an integer with the convention 1 meaning true and 0 meaning false. The value can be used in the steering file to divide the analysis chain into several paths.

Parameters
valueThe value of the return value.

Definition at line 229 of file Module.cc.

◆ setReturnValue() [2/2]

void setReturnValue ( int  value)
protectedinherited

Sets the return value for this module as integer.

The value can be used in the steering file to divide the analysis chain into several paths.

Parameters
valueThe value of the return value.

Definition at line 222 of file Module.cc.

◆ setType()

void setType ( const std::string &  type)
protectedinherited

Set the module type.

Only for use by internal modules (which don't use the normal REG_MODULE mechanism).

Definition at line 50 of file Module.cc.

◆ terminate()

virtual void terminate ( )
inlinevirtualinherited

This method is called at the end of the event processing.

This method is called only once after the event processing finished. Use this method for cleaning up, closing files, etc.

This method can be implemented by subclasses.

Reimplemented in ROIDQMModule, DQMHistAnalysisPXDTrackChargeModule, DQMHistOutputToEPICSModule, DQMHistInjectionModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisPXDCMModule, DQMHistAnalysisPXDReductionModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDDAQModule, DQMHistAnalysisPXDEffModule, PXDBgTupleProducerModule, PXDMCBgTupleProducerModule, PyModule, PXDDQMEfficiencyNtupleSelftrackModule, DQMHistComparitorModule, PXDDQMEfficiencyNtupleModule, DQMHistAnalysisInputRootFileModule, PXDROIFinderAnalysisModule, ROISenderModule, PXDUnpackerModule, PXDUnpackerOTModule, PXDPackerErrModule, PXDPackerModule, SVDDQMExpressRecoModule, DQMHistAnalysisPXDERModule, SVDDQMClustersOnTrackModule, PXDReadRawONSENModule, PXDReadRawBonnDAQMatchedModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisIPModule, PXDReadRawBonnDAQModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisExampleFlagsModule, TRGCDCT3DUnpackerModule, TRGCDCTSFUnpackerModule, TRGGRLUnpackerModule, TRGCDCETFUnpackerModule, CDCTriggerUnpackerModule, TOPUnpackerModule, FindletModule< AFindlet >, FindletModule< FacetCreator >, FindletModule< TrackFinderAutomaton >, FindletModule< CKFToCDCFromEclFindlet >, FindletModule< CKFToSVDSeedFindlet >, FindletModule< CKFToCDCFindlet >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialStraightTrackFinder >, FindletModule< SegmentLinker >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentOrienter >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< CKFToSVDFindlet >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackRejecter >, FindletModule< SegmentCreatorMCTruth >, FindletModule< TrackFinderCosmics >, FindletModule< SuperClusterCreator >, FindletModule< HitBasedT0Extractor >, FindletModule< AsicBackgroundLibraryCreator >, FindletModule< TrackExporter >, FindletModule< ClusterPreparer >, FindletModule< CosmicsTrackMergerFindlet >, FindletModule< AxialTrackFinderHough >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackLinker >, FindletModule< TrackOrienter >, FindletModule< TrackFinder >, FindletModule< AxialTrackFinderLegendre >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< SegmentPairCreator >, FindletModule< HitReclaimer >, FindletModule< TrackQualityEstimator >, FindletModule< CKFToPXDFindlet >, FindletModule< StereoHitFinder >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< SegmentFitter >, FindletModule< SegmentRejecter >, FindletModule< WireHitPreparer >, FindletModule< SegmentTripleCreator >, FindletModule< SegmentTrackCombiner >, FindletModule< MCVXDCDCTrackMergerFindlet >, FindletModule< MonopoleStereoHitFinder >, FindletModule< TrackCombiner >, FindletModule< AxialSegmentPairCreator >, FindletModule< WireHitBackgroundDetector >, FindletModule< ClusterBackgroundDetector >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFindlet >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< TrackQualityAsserter >, FindletModule< WireHitCreator >, SpacePoint2TrueHitConnectorModule, ECLWaveformFitModule, TOPTimeBaseCalibratorModule, B2BIIConvertMdstModule, TOPTBCComparatorModule, ECLChargedPIDModule, SVDBackgroundModule, B2BIIFixMdstModule, ARICHNtupleModule, ParticleLoaderModule, BeamBkgTagSetterModule, ECLDigitizerModule, SVDDigitizerModule, CDCTriggerHoughETFModule, TOPGainEfficiencyCalculatorModule, CDCTrigger2DFinderModule, OpticalGunModule, ARICHDigitizerModule, KLMClustersReconstructorModule, CDCDedxValidationModule, ParticleKinematicFitterModule, TOPDQMModule, ECLShowerShapeModule, KLMDQMModule, CDCDQMModule, TOPLaserHitSelectorModule, PXDBackgroundModule, TOPModuleT0CalibratorModule, DQMHistAnalysisTRGGDLModule, CDCDedxPIDModule, TOPChannelT0CalibratorModule, TOPCommonT0CalibratorModule, TOPReconstructorModule, DATCONTrackingModule, DQMHistAnalysisKLMModule, BKLMDigitAnalyzerModule, TOPRawDigitConverterModule, ARICHFillHitsModule, DQMHistAnalysisCDCMonObjModule, KLMUnpackerModule, KLMReconstructorModule, ARICHReconstructorModule, CDCCRTestModule, KLMDigitizerModule, SoftwareTriggerModule, EKLMDataCheckerModule, TOPPDFDebuggerModule, ARICHDQMModule, DQMHistAnalysisARICHModule, KLMPackerModule, MdstPIDModule, FullSimModule, TOPAlignerModule, TOPBackgroundModule, ARICHPackerModule, BeamBkgMixerModule, CDCUnpackerModule, ECLDigitizerPureCsIModule, TOPPDFCheckerModule, ARICHRelateModule, BelleMCOutputModule, BeamBkgHitRateMonitorModule, CDCPackerModule, DQMHistAnalysisMiraBelleModule, GFTC2SPTCConverterModule, ARICHUnpackerModule, ECLCRFinderModule, ARICHMCParticlesModule, ARICHRateCalModule, CsIDigitizerModule, TOPDoublePulseGeneratorModule, SVDROIFinderAnalysisModule, BGOverlayExecutorModule, CDCCosmicAnalysisModule, ECLDataAnalysisModule, EclDisplayModule, VXDDedxPIDModule, ARICHRawUnpackerModule, NtuplePhase1_v6Module, ECLChargedPIDDataAnalysisValidationModule, ECLShowerCorrectorModule, EvtGenDecayModule, EKLMADCModule, HitLevelInfoWriterModule, SVDCoGTimeEstimatorModule, TOPCalPulseGeneratorModule, TOPNtupleModule, TOPPackerModule, TOPWaveformFeatureExtractorModule, SVDROIFinderModule, ParticleWeightingLookUpCreatorModule, BeamBkgGeneratorModule, RootOutputModule, TOPInterimFENtupleModule, TOPMCTrackMakerModule, BGOverlayInputModule, CsIStudyModule, ECLDigitCalibratorModule, ECLSplitterN1Module, ProfileModule, KLMClusterEfficiencyModule, PIDNtupleModule, VXDTFTrainingDataCollectorModule, arichBtestModule, CDCDigitizerModule, FlavorTaggerInfoFillerModule, TpcDigitizerModule, ECLDQMModule, OverrideGenerationFlagsModule, BKLMSimHistogrammerModule, MCMatcherKLMClustersModule, DQMHistAnalysisARICHMonObjModule, PXDPerformanceModule, TOPBunchFinderModule, TOPTriggerDigitizerModule, TrackFinderVXDAnalizerModule, HLTDQM2ZMQModule, ECLChargedPIDDataAnalysisModule, ECLDQMEXTENDEDModule, FragmentationModule, TOPCosmicT0FinderModule, TRGGRLMatchModule, ReprocessorModule, FANGSDigitizerModule, CDCRecoTrackFilterModule, IPDQMExpressRecoModule, ECLLocalMaximumFinderModule, CDCDedxCorrectionModule, CDCDedxDQMModule, DQMHistAnalysisMonObjModule, ECLClusterPSDModule, ExtModule, MCTrackCandClassifierModule, MuidModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisHLTMonObjModule, BKLMTrackingModule, SVDROIFinderAnalysisDataModule, HitXPModule, DQMHistAnalysisECLModule, ECLBackgroundModule, BabayagaNLOInputModule, EventT0DQMModule, SVDDataFormatCheckModule, TOPLaserCalibratorModule, SecMapTrainerVXDTFModule, arichToNtupleModule, BgoStudyModule, CsiStudy_v2Module, MicrotpcStudyModule, PlumeDigitizerModule, RootInputModule, PXDClustersFromTracksModule, SVDClusterEvaluationTrueInfoModule, TOPXTalkChargeShareSetterModule, SecMapTrainerBaseModule, SegmentNetworkAnalyzerModule, TRGGDLUnpackerModule, TRGTOPDQMModule, AnalysisPhase1StudyModule, DosiStudyModule, He3tubeStudyModule, ECLCovarianceMatrixModule, ECLFinalizerModule, ECLSplitterN2Module, MCMatcherECLClustersModule, BKLMAnaModule, MVAExpertModule, MVAMultipleExpertsModule, KLMExpertModule, SVDHotStripFinderModule, TOPChannelT0MCModule, NoKickCutsEvalModule, TRGECLRawdataAnalysisModule, TRGTOPUnpackerModule, TPCStudyModule, ECLShowerCalibratorModule, ECLTrackClusterMatchingModule, PhokharaInputModule, CDCDedxSkimCDSTModule, SVDPackerModule, CurlingTrackCandSplitterModule, SpacePointCreatorTestModule, MLSegmentNetworkProducerModule, BgoDigitizerModule, CsiDigitizer_v2Module, DosiDigitizerModule, PinDigitizerModule, HLTDs2ZMQModule, TeeggInputModule, KlongValidationModule, SVDPerformanceModule, MCMatcherTRGECLModule, ParticleStatsModule, BeamabortStudyModule, ClawStudyModule, ClawsStudyModule, PindiodeStudyModule, QcsmonitorStudyModule, DQMHistAnalysisInputPVSrvModule, ECLHitDebugModule, AsyncWrapper, HepMCOutputModule, KKGenInputModule, CombinedPIDPerformanceModule, SVDOccupancyAnalysisModule, SVDSpacePointCreatorModule, TrackingPerformanceEvaluationModule, CurlTaggerModule, ECLUnpackerModule, BHWideInputModule, PXDSpacePointCreatorModule, CDCDedxSkimModule, EffPlotsModule, CDCTriggerTSFFirmwareModule, ParticleMCDecayStringModule, VariablesToNtupleModule, BeamDigitizerModule, He3DigitizerModule, CDCCrossTalkAdderModule, BBBremInputModule, GeneratedVertexDisplacerModule, KoralWInputModule, DataWriterModule, FullSimTimingModule, SVDCrossTalkFinderModule, SVDClusterFilterModule, SVDShaperDigitsFromTracksModule, SVD3SamplesEmulatorModule, RT2SPTCConverterModule, FastBDTClassifierTrainingModule, TRGGDLModule, EventKinematicsModule, CDCInitialT0DeterminationModule, DisplayModule, SVDChannelMappingModule, SVDClusterQualityEstimatorCalibrationModule, SVDSpacePointQICalibrationModule, ROIReadTestModule, TRGCDCT3DConverterModule, TRGECLModule, CosmicsAlignmentValidationModule, ClawDigitizerModule, ClawsDigitizerModule, FANGSStudyModule, ECLPackerModule, ECLTRGInformationModule, SVDB4CommissioningPlotsModule, SVDClusterEvaluationModule, V0findingPerformanceEvaluationModule, RemoveParticlesNotInListsModule, QcsmonitorDigitizerModule, DQMHistSnapshotsModule, ECLFillCellIdMappingModule, HepMCInputModule, HepevtOutputModule, RemoveMCParticlesModule, SVDChargeSharingAnalysisModule, VXDQETrainingDataCollectorModule, CsiModule, AafhInputModule, BeamSpotMonitorModule, TrackQETrainingDataCollectorModule, TRGGRLModule, VariablesToHistogramModule, ECLTrackClusterMatchingParametrizationExpertModule, RandomBarrierModule, CRYInputModule, MasterClassModule, GenfitVisModule, SPTCRefereeModule, FillTrackFitNtupleModule, TRGGRLProjectsModule, DQMHistDeltaHistoModule, GeneratorPreselectionModule, TCConvertersTestModule, TRGCDCModule, TRGECLFAMModule, VariablesToEventBasedTreeModule, B2BIIMdstInputModule, SubEventModule, TrepsInputModule, CDCDedxScanModule, CDCTriggerNeuroDQMModule, DQMHistAnalysisSVDOnMiraBelleModule, DQMHistAnalysisTOPModule, ECLCompressBGOverlayModule, ECLMatchingPerformanceExpertModule, TRGCDCTSStreamModule, ParticleMassUpdaterModule, SkimFilterModule, SVDClusterQualityEstimatorModule, MCV0MatcherModule, ECLDigiStudyModule, TrackFilterModule, EclCovMatrixNtupleModule, Convert2RawDetModule, TOPRingPlotterModule, PhaseSpaceAnalysisModule, TRGGDLDQMModule, TreeFitterModule, TRGECLQAMModule, TRGECLTimingCalModule, DQMHistAnalysisOutputMonObjModule, SoftwareTriggerResultPrinterModule, SVDMaxStripTTreeModule, FastBDTClassifierAnalyzerModule, VXDMisalignmentModule, StandardTrackingPerformanceModule, cdcDQM7Module, DQMHistAnalysisInputModule, SwitchDataStoreModule, DQMHistAnalysisEventT0Module, ECLTrackClusterMatchingPerformanceModule, HistoModule, ZMQRxOutputModule, ZMQTxInputModule, SPTC2GFTCConverterModule, TRGGRLDQMModule, PhysicsObjectsMiraBelleModule, ZMQRxWorkerModule, SPTC2RTConverterModule, KLMTriggerModule, DQMHistAnalysisInputSrvModule, ProgressBarModule, SeqRootOutputModule, GeometryModule, CDCTriggerTSFModule, DQMHistAnalysisSVDGeneralModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, TxModule, SVDPerformanceTTreeModule, CDCTriggerNeuroTrainerModule, B2BIIMCParticlesMonitorModule, ZMQTxWorkerModule, Root2BinaryModule, ScanCDCGeoModule, DQMHistAnalysisOutputNSMModule, DQMHistAnalysisPlotOnlyModule, DQMHistAnalysisSVDEfficiencyModule, RxModule, svdDumpModule, TRGECLDQMModule, GRLNeuroTrainerModule, DQMHistAnalysisExampleModule, DQMHistAnalysisOutputRelayMsgModule, CheckErrorEventModule, DQMHistAnalysisOutputFileModule, TRGCDCT2DDQMModule, StudyMaterialEffectsModule, TRGCDCT3DDQMModule, TRGGDLSummaryModule, DQMHistAnalysisOutputModule, HistoManagerModule, SeqRootInputModule, TRGCDCTSFDQMModule, TRGGDLDSTModule, PhysicsObjectsDQMModule, CollectorTestModule, CalibrationCollectorModule, ARICHBackgroundModule, EvReductionModule, Raw2DsModule, BeamabortModule, BgoModule, CaveModule, ClawModule, CLAWSModule, DosiModule, FANGSModule, He3tubeModule, MicrotpcModule, Ph1bpipeModule, Ph1sustrModule, PindiodeModule, PlumeModule, QcsmonitorModule, SrsensorModule, RawInputModule, StorageDeserializerModule, TRGECLUnpackerModule, SerializerModule, FastRbuf2DsModule, Ds2SampleModule, DeSerializerPXDModule, GenRawSendModule, DeSerializerModule, Rbuf2RbufModule, Rbuf2DsModule, TxSocketModule, DqmHistoManagerModule, Ds2RawModule, Ds2RawFileModule, Ds2RbufModule, Root2RawModule, StorageSerializerModule, GetEventFromSocketModule, ReceiveEventModule, ElapsedTimeModule, MonitorDataCOPPERModule, RxSocketModule, CertifyParallelModule, SeqRootMergerModule, DAQPerfModule, MonitorDataModule, TrackAnaModule, and PartialSeqRootReaderModule.

Definition at line 178 of file Module.h.

Member Data Documentation

◆ m_xOfCounter

double m_xOfCounter
private

x-pos.

of counter (cm)

Definition at line 59 of file CDCCosmicSelectorModule.h.

◆ m_yOfCounter

double m_yOfCounter
private

y-pos.

of counter (cm)

Definition at line 60 of file CDCCosmicSelectorModule.h.

◆ m_zOfCounter

double m_zOfCounter
private

z-pos.

of counter (cm)

Definition at line 61 of file CDCCosmicSelectorModule.h.


The documentation for this class was generated from the following files:
Belle2::CDCCosmicSelectorModule::m_xOfCounter
double m_xOfCounter
x-pos.
Definition: CDCCosmicSelectorModule.h:59
Belle2::CDCCosmicSelectorModule::m_phiOfCounter
double m_phiOfCounter
phi-angle of counter (deg)
Definition: CDCCosmicSelectorModule.h:62
Belle2::CDCCosmicSelectorModule::m_propSpeed
double m_propSpeed
Light speed in counter (cm/ns)
Definition: CDCCosmicSelectorModule.h:65
Belle2::MCParticle::isPrimaryParticle
bool isPrimaryParticle() const
Check if particle is a primary particle which was created by the generator (and not,...
Definition: MCParticle.h:588
Belle2::CDCCosmicSelectorModule::m_lOfCounter
double m_lOfCounter
full-length of counter (cm)
Definition: CDCCosmicSelectorModule.h:64
Belle2::CDCCosmicSelectorModule::m_yOfCounter
double m_yOfCounter
y-pos.
Definition: CDCCosmicSelectorModule.h:60
Belle2::MCParticle::setProductionTime
void setProductionTime(float time)
Set production time.
Definition: MCParticle.h:392
Belle2::CDCCosmicSelectorModule::m_zOfCounter
double m_zOfCounter
z-pos.
Definition: CDCCosmicSelectorModule.h:61
Belle2::MCParticle::getProductionVertex
TVector3 getProductionVertex() const
Return production vertex position.
Definition: MCParticle.h:200
Belle2::MCParticle::getPDG
int getPDG() const
Return PDG code of particle.
Definition: MCParticle.h:123
Belle2::Module::setReturnValue
void setReturnValue(int value)
Sets the return value for this module as integer.
Definition: Module.cc:222
Belle2::CDCCosmicSelectorModule::m_wOfCounter
double m_wOfCounter
full-width of counter (cm)
Definition: CDCCosmicSelectorModule.h:63
Belle2::CDCCosmicSelectorModule::m_top
bool m_top
top option
Definition: CDCCosmicSelectorModule.h:68
Belle2::CDCCosmicSelectorModule::m_tof
int m_tof
tof option
Definition: CDCCosmicSelectorModule.h:66
Belle2::MCParticle::getMomentum
TVector3 getMomentum() const
Return momentum.
Definition: MCParticle.h:209
Belle2::CDCCosmicSelectorModule::m_cryGenerator
bool m_cryGenerator
cry or cosmics generator
Definition: CDCCosmicSelectorModule.h:67
Belle2::MCParticle
A Class to store the Monte Carlo particle information.
Definition: MCParticle.h:43
Belle2::CDCCosmicSelectorModule::m_mcParticles
StoreArray< MCParticle > m_mcParticles
array of MCParticle
Definition: CDCCosmicSelectorModule.h:58
Belle2::StoreArray::getEntries
int getEntries() const
Get the number of objects in the array.
Definition: StoreArray.h:226
Belle2::MCParticle::getProductionTime
float getProductionTime() const
Return production time in ns.
Definition: MCParticle.h:170