Template for a combined beam current monitor using weighted inputs. More...

#include <QwCombinedBCM.h>

Inheritance diagram for QwCombinedBCM< T >:

Collaboration diagram for QwCombinedBCM< T >:

Public Member Functions
	QwCombinedBCM ()

	QwCombinedBCM (TString name)

	QwCombinedBCM (TString subsystem, TString name)

	QwCombinedBCM (TString subsystemname, TString name, TString type)

	QwCombinedBCM (const QwCombinedBCM &source)

	~QwCombinedBCM () override

void	SetBCMForCombo (VQwBCM *bcm, Double_t weight, Double_t sumqw) override

Int_t	ProcessEvBuffer (UInt_t *buffer, UInt_t word_position_in_buffer, UInt_t subelement=0) override
	Process the raw event buffer and decode into the channel.

void	InitializeChannel (TString name, TString datatosave) override

void	InitializeChannel (TString subsystem, TString name, TString datatosave) override

void	InitializeChannel (TString subsystem, TString name, TString type, TString datatosave)

void	ProcessEvent () override

void	GetProjectedCharge (VQwBCM *device) override

void	RandomizeEventData (int helicity=0, double time=0.0) override

size_t	GetNumberOfElements () override

TString	GetSubElementName (Int_t index) override

void	LoadMockDataParameters (QwParameterFile &paramfile) override

Bool_t	ApplyHWChecks ()

Bool_t	ApplySingleEventCuts () override

UInt_t	UpdateErrorFlag () override

VQwBCM &	operator= (const VQwBCM &value) override

QwCombinedBCM &	operator= (const QwCombinedBCM &value)

void	SetPedestal (Double_t ped) override
	Set the pedestal value for the beam current monitor.

void	SetCalibrationFactor (Double_t calib) override
	Set the calibration factor for the beam current monitor.

VQwHardwareChannel *	GetCharge () override

const VQwHardwareChannel *	GetCharge () const override

Public Member Functions inherited from QwBCM< T >
	QwBCM ()

	QwBCM (TString name)

	QwBCM (TString subsystemname, TString name)

	QwBCM (TString subsystemname, TString name, TString type, TString clock="")

	QwBCM (const QwBCM &source)

	~QwBCM () override

void	InitializeChannel (TString subsystem, TString name, TString type, TString datatosave)
	Initialize the BCM with subsystem, module type, and name.

void	ClearEventData () override
	Clear event-scoped data in the underlying channel.

void	LoadChannelParameters (QwParameterFile &paramfile) override

void	SetRandomEventDriftParameters (Double_t amplitude, Double_t phase, Double_t frequency)
	Configure deterministic drift parameters applied per event.

void	AddRandomEventDriftParameters (Double_t amplitude, Double_t phase, Double_t frequency) override
	Add additional drift parameters to the drift model.

void	SetRandomEventParameters (Double_t mean, Double_t sigma) override
	Configure Gaussian mock data parameters.

void	SetRandomEventAsymmetry (Double_t asymmetry) override
	Set an asymmetry parameter applied to helicity states.

void	SetResolution (Double_t resolution)

void	ApplyResolutionSmearing () override
	Smear the channel by the configured resolution.

void	FillRawEventData () override
	Materialize the current event state as raw event data.

void	EncodeEventData (std::vector< UInt_t > &buffer) override
	Encode current event data into an output buffer.

void	UseExternalRandomVariable ()
	Use an external random variable source for mock data.

void	SetExternalRandomVariable (Double_t random_variable)
	Set the external random variable to drive mock data.

Bool_t	ApplyHWChecks ()
	Apply hardware checks and return whether the event is valid.

void	IncrementErrorCounters () override
	Increment error counters (number of failed events).

void	PrintErrorCounters () const override
	Print error counters (const overload).

UInt_t	GetEventcutErrorFlag () override
	return the error flag on this channel/device

void	UpdateErrorFlag (const VQwBCM *ev_error) override
	Merge error flags from a reference BCM into this instance.

UInt_t	GetErrorCode () const

Int_t	SetSingleEventCuts (Double_t mean=0, Double_t sigma=0)
	Set basic single-event cut limits.

void	SetSingleEventCuts (UInt_t errorflag, Double_t min=0, Double_t max=0, Double_t stability=0, Double_t burplevel=0) override
	Inherited from VQwDataElement to set the upper and lower limits (fULimit and fLLimit), stability % and the error flag on this channel.

void	SetDefaultSampleSize (Int_t sample_size) override
	Set the default sample size used by the channel.

void	SetEventCutMode (Int_t bcuts) override

void	PrintValue () const override
	Print a compact value summary for this BCM.

void	PrintInfo () const override
	Print detailed information for this BCM.

std::string	GetExternalClockName () override

Bool_t	NeedsExternalClock () override

void	SetExternalClockPtr (const VQwHardwareChannel *clock) override

void	SetExternalClockName (const std::string name) override

Double_t	GetNormClockValue () override

VQwBCM &	operator+= (const VQwBCM &value) override
	Polymorphic add-assign from VQwBCM if types match.

VQwBCM &	operator-= (const VQwBCM &value) override
	Polymorphic subtract-assign from VQwBCM.

QwBCM &	operator= (const QwBCM &value)
	Copy-assign from another BCM (event-scoped data).

QwBCM &	operator+= (const QwBCM &value)
	Add-assign from another BCM (sum raw channels).

QwBCM &	operator-= (const QwBCM &value)
	Subtract-assign from another BCM (difference raw channels).

void	Ratio (const VQwBCM &numer, const VQwBCM &denom) override
	Polymorphic ratio formation for BCM.

void	Ratio (const QwBCM &numer, const QwBCM &denom)
	Type-specific ratio formation for BCM.

void	Scale (Double_t factor) override
	Scale the underlying channel by a constant factor.

void	AccumulateRunningSum (const VQwBCM &, Int_t count=0, Int_t ErrorMask=0xFFFFFFF) override
	Accumulate running sums from another BCM into this one.

void	DeaccumulateRunningSum (VQwBCM &value, Int_t ErrorMask=0xFFFFFFF) override
	Remove a single entry from the running sums using a source value.

void	CalculateRunningAverage () override
	Update running averages for the underlying channel.

Bool_t	CheckForBurpFail (const VQwDataElement *ev_error) override
	Check for burp failures by delegating to the underlying channel.

void	ConstructHistograms (TDirectory *folder, TString &prefix) override
	Define histograms for this BCM (delegated to underlying channel).

void	FillHistograms () override
	Fill histograms for this BCM if enabled.

void	ConstructBranchAndVector (TTree *tree, TString &prefix, QwRootTreeBranchVector &values) override
	Construct ROOT branches and value vector entries.

void	ConstructBranch (TTree *tree, TString &prefix) override
	Construct ROOT branches for this BCM (if enabled).

void	ConstructBranch (TTree *tree, TString &prefix, QwParameterFile &modulelist) override
	Construct ROOT branches for this BCM using a trim file filter.

void	FillTreeVector (QwRootTreeBranchVector &values) const override
	Fill tree vector entries for this BCM.

Double_t	GetValue () override
	Get the current value of the beam current.

Double_t	GetValueError () override
	Get the statistical error on the beam current.

Double_t	GetValueWidth () override
	Get the width of the beam current distribution.

Public Member Functions inherited from VQwBCM
	~VQwBCM () override

UInt_t	UpdateErrorFlag () override
	Update the error flag based on the error flags of internally contained objects Return parameter is the "Eventcut Error Flag".

Public Member Functions inherited from VQwDataElement
	VQwDataElement ()
	Default constructor.

	VQwDataElement (const VQwDataElement &value)
	Copy constructor.

	~VQwDataElement () override
	Virtual destructor.

void	CopyFrom (const VQwDataElement &value)

Bool_t	IsNameEmpty () const
	Is the name of this element empty?

void	SetElementName (const TString &name)
	Set the name of this element.

virtual const TString &	GetElementName () const
	Get the name of this element.

size_t	GetNumberOfDataWords ()
	Get the number of data words in this data element.

UInt_t	GetGoodEventCount () const

virtual void	AssignValueFrom (const VQwDataElement *)

VQwDataElement &	operator+= (const VQwDataElement &)
	Addition-assignment operator.

VQwDataElement &	operator-= (const VQwDataElement &)
	Subtraction-assignment operator.

void	Sum (const VQwDataElement &, const VQwDataElement &)
	Sum operator (base class fallback throws runtime error)

void	Difference (const VQwDataElement &, const VQwDataElement &)
	Difference operator (base class fallback throws runtime error)

void	Ratio (const VQwDataElement &, const VQwDataElement &)
	Ratio operator (base class fallback throws runtime error)

void	SetSingleEventCuts (UInt_t, Double_t, Double_t, Double_t)
	set the upper and lower limits (fULimit and fLLimit), stability % and the error flag on this channel

Bool_t	CheckForBurpFail (const VQwDataElement *)

virtual void	SetNeedsExternalClock (Bool_t)

TString	GetSubsystemName () const
	Return the name of the inheriting subsystem name.

void	SetSubsystemName (TString sysname)
	Set the name of the inheriting subsystem name.

TString	GetModuleType () const
	Return the type of the beam instrument.

void	SetModuleType (TString ModuleType)
	set the type of the beam instrument

Public Member Functions inherited from MQwHistograms
void	ShareHistograms (const MQwHistograms *source)
	Share histogram pointers between objects.

Private Attributes
std::vector< QwBCM< T > * >	fElement

std::vector< Double_t >	fWeights

Double_t	fSumQweights

Double_t	fLastTripTime

Double_t	fTripPeriod

Double_t	fTripLength

Double_t	fTripRamp

Double_t	fProbabilityOfTrip

Parity mock data generation
static std::mt19937	fRandomnessGenerator
	Internal randomness generator.

static std::uniform_real_distribution< double >	fDistribution
	Internal uniform probability distribution.

static std::function< double()>	fRandomVariable
	Internal normal random variable.

static void	SetTripSeed (uint seedval)

Additional Inherited Members
Public Types inherited from VQwDataElement
enum	EDataToSave { kRaw = 0 , kDerived , kMoments }

Static Public Member Functions inherited from VQwBCM
static VQwBCM *	Create (TString subsystemname, TString type, TString name, TString clock="")
	Factory method to create a concrete BCM instance for the requested module type.

static VQwBCM *	Create (const VQwBCM &source)
	Copy constructor factory method to clone a BCM from an existing instance.

static VQwBCM *	CreateCombo (TString subsystemname, TString type, TString name)
	Factory method to create a concrete Combined BCM for the requested module type.

static VQwBCM *	CreateCombo (const VQwBCM &source)

Protected Member Functions inherited from VQwBCM
	VQwBCM (VQwDataElement &beamcurrent)

	VQwBCM (VQwDataElement &beamcurrent, TString)

Protected Member Functions inherited from VQwDataElement
void	SetNumberOfDataWords (const UInt_t &numwords)
	Set the number of data words in this data element.

VQwDataElement &	operator= (const VQwDataElement &value)
	Arithmetic assignment operator: Should only copy event-based data.

void	UpdateErrorFlag (const UInt_t &error)

Protected Member Functions inherited from MQwHistograms
	MQwHistograms ()
	Default constructor.

	MQwHistograms (const MQwHistograms &source)
	Copy constructor.

virtual	~MQwHistograms ()
	Virtual destructor.

MQwHistograms &	operator= (const MQwHistograms &value)

void	Fill_Pointer (TH1_ptr hist_ptr, Double_t value)

void	AddHistogram (TH1 *h)
	Register a histogram.

Protected Attributes inherited from QwBCM< T >
T	fBeamCurrent

Protected Attributes inherited from VQwBCM
VQwDataElement &	fBeamCurrent_ref

Protected Attributes inherited from VQwDataElement
TString	fElementName
	Name of this data element.

UInt_t	fNumberOfDataWords
	Number of raw data words in this data element.

UInt_t	fGoodEventCount
	Number of good events accumulated in this element.

TString	fSubsystemName

TString	fModuleType

UInt_t	fErrorFlag
	This the standard error code generated for the channel that contains the global/local/stability flags and the Device error code (Unique error code for HW failures)

UInt_t	fErrorConfigFlag
	contains the global/local/stability flags

Protected Attributes inherited from MQwHistograms
std::vector< TH1_ptr >	fHistograms
	Histograms associated with this data element.

Detailed Description

template<typename T>
class QwCombinedBCM< T >

Template for a combined beam current monitor using weighted inputs.

Aggregates multiple BCMs into a single effective current channel by applying user-provided weights. Provides event processing hooks and error propagation consistent with VQwBCM.

Definition at line 37 of file QwCombinedBCM.h.

Constructor & Destructor Documentation

◆ QwCombinedBCM() [1/5]

template<typename T>

QwCombinedBCM< T >::QwCombinedBCM ( )

inline

Definition at line 40 of file QwCombinedBCM.h.

40{ };

Referenced by GetCharge(), operator=(), operator=(), and QwCombinedBCM().

Here is the caller graph for this function:

◆ QwCombinedBCM() [2/5]

template<typename T>

QwCombinedBCM< T >::QwCombinedBCM ( TString name )

inline

Definition at line 41 of file QwCombinedBCM.h.

                             {
    InitializeChannel(name, "derived");
  };

References InitializeChannel().

Here is the call graph for this function:

◆ QwCombinedBCM() [3/5]

template<typename T>

QwCombinedBCM< T >::QwCombinedBCM	(	TString	subsystem,
		TString	name )

inline

Definition at line 44 of file QwCombinedBCM.h.

                                                {
    InitializeChannel(subsystem, name, "derived");
  };

References InitializeChannel().

Here is the call graph for this function:

◆ QwCombinedBCM() [4/5]

template<typename T>

QwCombinedBCM< T >::QwCombinedBCM	(	TString	subsystemname,
		TString	name,
		TString	type )

inline

Definition at line 47 of file QwCombinedBCM.h.

                                                                  {
    this->SetSubsystemName(subsystemname);
    InitializeChannel(subsystemname, name,type,"raw");
  };

References InitializeChannel(), and VQwDataElement::SetSubsystemName().

Here is the call graph for this function:

◆ QwCombinedBCM() [5/5]

template<typename T>

QwCombinedBCM< T >::QwCombinedBCM ( const QwCombinedBCM< T > & source )

inline

Definition at line 51 of file QwCombinedBCM.h.

52 : QwBCM<T>(source)

53 { }

VQwBCM::QwBCM

friend class QwBCM

Definition VQwBCM.h:60

References QwBCM< T >::QwBCM(), and QwCombinedBCM().

Here is the call graph for this function:

◆ ~QwCombinedBCM()

template<typename T>

QwCombinedBCM< T >::~QwCombinedBCM ( )

inlineoverride

Definition at line 54 of file QwCombinedBCM.h.

54{ };

Member Function Documentation

◆ ApplyHWChecks()

template<typename T>

Bool_t QwCombinedBCM< T >::ApplyHWChecks ( )

inline

Definition at line 78 of file QwCombinedBCM.h.

                        {
    return kTRUE;
  };

◆ ApplySingleEventCuts()

template<typename T>

Bool_t QwCombinedBCM< T >::ApplySingleEventCuts ( )

overridevirtual

Apply single-event cuts: first propagate error codes from constituent BCMs, then apply cuts using the inherited BCM logic.

Reimplemented from QwBCM< T >.

Definition at line 236 of file QwCombinedBCM.cc.

{
 
  //This is required to update single event cut failures in individual channels
  //  First update the error code based on the codes
  //  of the elements.  This requires that the BCMs
  //  have had ApplySingleEventCuts run on them already.
 
  for (size_t i=0;i<fElement.size();i++){
    this->fBeamCurrent.UpdateErrorFlag(fElement.at(i)->fBeamCurrent.GetErrorCode());
  }
 
 
  //  Everything is identical as for a regular BCM
  return QwBCM<T>::ApplySingleEventCuts();
}

References QwBCM< T >::ApplySingleEventCuts(), QwBCM< T >::fBeamCurrent, and fElement.

Here is the call graph for this function:

◆ GetCharge() [1/2]

template<typename T>

const VQwHardwareChannel * QwCombinedBCM< T >::GetCharge ( ) const

inlineoverridevirtual

Reimplemented from VQwBCM.

Definition at line 110 of file QwCombinedBCM.h.

                                                       {
    return const_cast<QwCombinedBCM*>(this)->GetCharge();
  };

References GetCharge(), and QwCombinedBCM().

Here is the call graph for this function:

◆ GetCharge() [2/2]

template<typename T>

VQwHardwareChannel * QwCombinedBCM< T >::GetCharge ( )

inlineoverridevirtual

Reimplemented from QwBCM< T >.

Definition at line 106 of file QwCombinedBCM.h.

                                          {
    return &(this->fBeamCurrent);
  };

References QwBCM< T >::fBeamCurrent.

Referenced by GetCharge().

Here is the caller graph for this function:

◆ GetNumberOfElements()

template<typename T>

size_t QwCombinedBCM< T >::GetNumberOfElements ( )

inlineoverridevirtual

Reimplemented from VQwBCM.

Definition at line 73 of file QwCombinedBCM.h.

73{return fElement.size();};

References fElement.

◆ GetProjectedCharge()

template<typename T>

void QwCombinedBCM< T >::GetProjectedCharge ( VQwBCM * device )

overridevirtual

Project the combined current to a device channel, applying resolution smearing and filling raw event data.

Reimplemented from VQwBCM.

Definition at line 145 of file QwCombinedBCM.cc.

{
  (device->GetCharge())->AssignScaledValue(this->fBeamCurrent,1.0);
  //device->PrintInfo();
  device->ApplyResolutionSmearing();
  //device->PrintInfo();
  device->FillRawEventData();
}

References VQwBCM::ApplyResolutionSmearing(), QwBCM< T >::fBeamCurrent, VQwBCM::FillRawEventData(), VQwBCM::GetCharge(), and VQwBCM::VQwBCM().

Here is the call graph for this function:

◆ GetSubElementName()

template<typename T>

TString QwCombinedBCM< T >::GetSubElementName ( Int_t index )

inlineoverridevirtual

Reimplemented from VQwBCM.

Definition at line 74 of file QwCombinedBCM.h.

74{return fElement.at(index)->GetElementName();};

References fElement.

◆ InitializeChannel() [1/3]

template<typename T>

void QwCombinedBCM< T >::InitializeChannel	(	TString	name,
		TString	datatosave )

overridevirtual

Initialize combined BCM with simple name and default settings.

Reimplemented from QwBCM< T >.

Definition at line 70 of file QwCombinedBCM.cc.

{
  SetPedestal(0.);
  SetCalibrationFactor(1.);
  fLastTripTime = -99999.9;
  this->SetElementName(name);
  this->fBeamCurrent.InitializeChannel(name,"derived");
}

References QwBCM< T >::fBeamCurrent, fLastTripTime, SetCalibrationFactor(), VQwDataElement::SetElementName(), and SetPedestal().

Referenced by QwCombinedBCM(), QwCombinedBCM(), and QwCombinedBCM().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InitializeChannel() [2/3]

template<typename T>

void QwCombinedBCM< T >::InitializeChannel	(	TString	subsystem,
		TString	name,
		TString	datatosave )

overridevirtual

Initialize combined BCM with subsystem scoping.

Reimplemented from QwBCM< T >.

Definition at line 81 of file QwCombinedBCM.cc.

{
  SetPedestal(0.);
  SetCalibrationFactor(1.);
  fLastTripTime = -99999.9;
  this->SetElementName(name);
  this->fBeamCurrent.InitializeChannel(subsystem, "QwCombinedBCM", name,"derived");
}

References QwBCM< T >::fBeamCurrent, fLastTripTime, SetCalibrationFactor(), VQwDataElement::SetElementName(), and SetPedestal().

Here is the call graph for this function:

◆ InitializeChannel() [3/3]

template<typename T>

void QwCombinedBCM< T >::InitializeChannel	(	TString	subsystem,
		TString	name,
		TString	type,
		TString	datatosave )

Definition at line 91 of file QwCombinedBCM.cc.

{
  SetPedestal(0.);
  SetCalibrationFactor(1.);
  fLastTripTime = -99999.9;
  this->SetElementName(name);
  this->SetModuleType(type);
  this->fBeamCurrent.InitializeChannel(subsystem, "QwCombinedBCM", name,"derived");
}

References QwBCM< T >::fBeamCurrent, fLastTripTime, SetCalibrationFactor(), VQwDataElement::SetElementName(), VQwDataElement::SetModuleType(), and SetPedestal().

Here is the call graph for this function:

◆ LoadMockDataParameters()

template<typename T>

void QwCombinedBCM< T >::LoadMockDataParameters ( QwParameterFile & paramfile )

overridevirtual

Load mock data parameters including beam trip settings and resolution. Recognizes 'beamtrip' and 'resolution' keywords.

Reimplemented from QwBCM< T >.

Definition at line 202 of file QwCombinedBCM.cc.

                                                                        {
 
  Double_t res=0.0;
 
  //  Test for the word "beamtrip", and get the tripperiod and tripduration if it is found, otherwise, just pass
  //  the line to the fBeamCurrent object.
  if (paramfile.GetLine().find("beamtrip")!=std::string::npos){
    //  "beamtrip" appears somewhere in the line.  Assume it is the next token and move on...
    paramfile.GetNextToken();  //Throw away this token.  Now the next three should be the beamtrip parameters.
 
    fTripPeriod = paramfile.GetTypedNextToken<Double_t>() * Qw::sec;
    fTripLength = paramfile.GetTypedNextToken<Double_t>() * Qw::sec;
    fTripRamp   = paramfile.GetTypedNextToken<Double_t>() * Qw::sec;
 
    fProbabilityOfTrip = 1.0/fTripPeriod;
  } else if (paramfile.GetLine().find("resolution")!=std::string::npos){
    paramfile.GetNextToken();
    res = paramfile.GetTypedNextToken<Double_t>();
    this->SetResolution(res);
  } else {
    //std::cout << "In QwCombinedBCM: ChannelName = " << this->GetElementName() << std::endl;
    this->fBeamCurrent.LoadMockDataParameters(paramfile);
  }
}

References QwBCM< T >::fBeamCurrent, fProbabilityOfTrip, fTripLength, fTripPeriod, fTripRamp, QwParameterFile::GetLine(), QwParameterFile::GetNextToken(), QwParameterFile::GetTypedNextToken(), Qw::sec, and QwBCM< T >::SetResolution().

Here is the call graph for this function:

◆ operator=() [1/2]

template<typename T>

QwCombinedBCM< T > & QwCombinedBCM< T >::operator= ( const QwCombinedBCM< T > & value )

Assignment operator: copy the beam current value.

Definition at line 322 of file QwCombinedBCM.cc.

{
  if (this->GetElementName()!="")
    this->fBeamCurrent=value.fBeamCurrent;
 
  return *this;
}

References QwBCM< T >::fBeamCurrent, VQwDataElement::GetElementName(), and QwCombinedBCM().

Here is the call graph for this function:

◆ operator=() [2/2]

template<typename T>

VQwBCM & QwCombinedBCM< T >::operator= ( const VQwBCM & value )

overridevirtual

Polymorphic assignment operator.

Reimplemented from QwBCM< T >.

Definition at line 332 of file QwCombinedBCM.cc.

{
  if (this->GetElementName()!="")
    dynamic_cast<QwCombinedBCM<T>* >(this)->fBeamCurrent=
      dynamic_cast<const QwCombinedBCM<T>* >(&value)->fBeamCurrent;
 
  return *this;
}

References QwBCM< T >::fBeamCurrent, VQwDataElement::GetElementName(), QwCombinedBCM(), and VQwBCM::VQwBCM().

Here is the call graph for this function:

◆ ProcessEvBuffer()

template<typename T>

Int_t QwCombinedBCM< T >::ProcessEvBuffer	(	UInt_t *	buffer,
		UInt_t	word_position_in_buffer,
		UInt_t	subelement = 0 )

inlineoverridevirtual

Process the raw event buffer and decode into the channel.

Returns: The updated buffer word position.

Reimplemented from QwBCM< T >.

Definition at line 60 of file QwCombinedBCM.h.

60{ return 0; };

References QwBPMStripline< T >::subelement.

◆ ProcessEvent()

template<typename T>

void QwCombinedBCM< T >::ProcessEvent ( )

overridevirtual

Compute weighted average of constituent BCM currents and normalize by total weight sum.

Reimplemented from QwBCM< T >.

Definition at line 109 of file QwCombinedBCM.cc.

{
  static T tmpADC;
  tmpADC.InitializeChannel("tmp","derived");
 
  this->ClearEventData();
 
  for (size_t i = 0; i < fElement.size(); i++) {
    tmpADC = fElement[i]->fBeamCurrent;
    tmpADC.Scale(fWeights[i]);
    this->fBeamCurrent += tmpADC;
  }
  this->fBeamCurrent.Scale(1.0/fSumQweights);
 
  Bool_t ldebug = kFALSE;
  if (ldebug) {
    QwMessage << "*****************" << QwLog::endl;
    QwMessage << "QwCombinedBCM: " << this->GetElementName() << QwLog::endl
                << "weighted average of hardware sums = " << this->fBeamCurrent.GetValue() << QwLog::endl;
    if (this->fBeamCurrent.GetNumberOfSubelements() > 1) {
      for (size_t i = 0; i < 4; i++) {
        QwMessage << "weighted average of block[" << i << "] = " << this->fBeamCurrent.GetValue(i) << QwLog::endl;
      }
    }
    QwMessage << "*****************" << QwLog::endl;
  }
}

References QwBCM< T >::ClearEventData(), QwLog::endl(), QwBCM< T >::fBeamCurrent, fElement, fSumQweights, fWeights, VQwDataElement::GetElementName(), and QwMessage.

Here is the call graph for this function:

◆ RandomizeEventData()

template<typename T>

void QwCombinedBCM< T >::RandomizeEventData	(	int	helicity = 0,
		double	time = 0.0 )

overridevirtual

Generate random event data and optionally simulate beam trips with configurable trip period, length, and ramp duration.

Reimplemented from QwBCM< T >.

Definition at line 160 of file QwCombinedBCM.cc.

{
  this->fBeamCurrent.RandomizeEventData(helicity, time);
  // do the beam cut routine from MockDataGenerator, but just scale fBeamCurrent instead of re-randomizing
  //  Three time intervals:  fmod(time,period) > (period-tripramp):  Do the ramp scaling
  //                         (period-tripramp) > fmod(time,period) > (period-triplength- tripramp): scale by 0.0
  //                         (period-triplength- tripramp) > fmod(time,period) : leave the variable alone
 
 
  //  Determine the probability of having a beam trip
  if (fLastTripTime<=-99999.9) {
     fLastTripTime = time - fTripLength - fTripRamp;
  }
//  if ( ((time-fLastTripTime) > (fTripPeriod)) ){ //  Make some comparison to a probablilty instead of the time
//  Probability of a trip happening in one event:  # of trips per hour/3600 * eventtime_in_seconds (which is 0.001s)
  Double_t tmp = fRandomVariable();
//  std::cout << "random value=="<<tmp << "; fProbabilityOfTrip=="<<fProbabilityOfTrip<<std::endl;
  if (tmp < fProbabilityOfTrip) {
     fLastTripTime = time;
     std::cout << "random value=="<<tmp << "; fProbabilityOfTrip=="<<fProbabilityOfTrip<<"; time=="<<time<<std::endl;
  }
 
  Double_t time_since_trip = time - fLastTripTime;
  if (time_since_trip <= fTripLength) {
    this->fBeamCurrent.Scale(0.0);
    //std::cout << "fBeamCurrent.Scale(0.0)" << std::endl;
  } else if (time_since_trip < (fTripLength + fTripRamp)) {
    Double_t factor = (time_since_trip-fTripLength)/fTripRamp;
    //std::cout << "(fTripPeriod - fmod(time, fTripPeriod))=="<<(fTripPeriod - fmod(time, fTripPeriod))<<"; fTripLength=="<<fTripLength
    //          << "; ((fTripPeriod - fmod(time, fTripPeriod)) / fTripLength)=="<<((fTripPeriod - fmod(time, fTripPeriod)) / fTripLength)
    //          << std::endl;
    this->fBeamCurrent.Scale(factor);
    //std::cout << "fBeamCurrent.Scale(factor) = " << factor << std::endl;
  }
}

References QwBCM< T >::fBeamCurrent, fLastTripTime, fProbabilityOfTrip, fTripLength, fTripRamp, and QwCombinedBCM< T >::fRandomVariable.

◆ SetBCMForCombo()

template<typename T>

void QwCombinedBCM< T >::SetBCMForCombo	(	VQwBCM *	bcm,
		Double_t	weight,
		Double_t	sumqw )

overridevirtual

Add a constituent BCM to the combination with specified weight.

Parameters

bcm	Pointer to the BCM to include.
weight	Charge weight for this BCM.
sumqw	Total sum of absolute weights.

Reimplemented from QwBCM< T >.

Definition at line 58 of file QwCombinedBCM.cc.

{
  // Convert back to QWBCM<T>* from generic VQwBCM*
  fElement.push_back(dynamic_cast<QwBCM<T>* >(bcm));
  fWeights.push_back(weight);
  fSumQweights = sumqw;
}

References fElement, fSumQweights, fWeights, QwBCM< T >::QwBCM(), and VQwBCM::VQwBCM().

Here is the call graph for this function:

◆ SetCalibrationFactor()

template<typename T>

void QwCombinedBCM< T >::SetCalibrationFactor ( Double_t calibration )

inlineoverridevirtual

Set the calibration factor for the beam current monitor.

Parameters

calibration Multiplicative calibration factor.

Reimplemented from QwBCM< T >.

Definition at line 102 of file QwCombinedBCM.h.

                                                     {
    QwBCM<T>::SetCalibrationFactor(1.0);
  }

References QwBCM< T >::SetCalibrationFactor().

Referenced by InitializeChannel(), InitializeChannel(), and InitializeChannel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetPedestal()

template<typename T>

void QwCombinedBCM< T >::SetPedestal ( Double_t pedestal )

inlineoverridevirtual

Set the pedestal value for the beam current monitor.

Parameters

pedestal Pedestal offset to apply to the raw signal.

Reimplemented from QwBCM< T >.

Definition at line 99 of file QwCombinedBCM.h.

                                          {
    QwBCM<T>::SetPedestal(0.0);
  }

References QwBCM< T >::SetPedestal().

Referenced by InitializeChannel(), InitializeChannel(), and InitializeChannel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetTripSeed()

template<typename T>

void QwCombinedBCM< T >::SetTripSeed ( uint seedval )

static

Set random number generator seed for beam trip simulation.

Definition at line 40 of file QwCombinedBCM.cc.

{
  fRandomnessGenerator.seed(seedval);
}

References fRandomnessGenerator.

Referenced by main().

Here is the caller graph for this function:

◆ UpdateErrorFlag()

template<typename T>

UInt_t QwCombinedBCM< T >::UpdateErrorFlag ( )

overridevirtual

Update error flags by propagating error codes from constituent BCMs.

Reimplemented from VQwDataElement.

Definition at line 257 of file QwCombinedBCM.cc.

                                        {
  for (size_t i=0;i<fElement.size();i++){
    this->fBeamCurrent.UpdateErrorFlag(fElement.at(i)->fBeamCurrent.GetErrorCode());
  }
  return this->fBeamCurrent.GetEventcutErrorFlag();
}

References QwBCM< T >::fBeamCurrent, and fElement.

Field Documentation

◆ fDistribution

template<typename T>

std::uniform_real_distribution<double> QwCombinedBCM< T >::fDistribution

staticprotected

Internal uniform probability distribution.

Definition at line 133 of file QwCombinedBCM.h.

◆ fElement

template<typename T>

std::vector<QwBCM<T>*> QwCombinedBCM< T >::fElement

private

Definition at line 117 of file QwCombinedBCM.h.

Referenced by ApplySingleEventCuts(), GetNumberOfElements(), GetSubElementName(), ProcessEvent(), SetBCMForCombo(), and UpdateErrorFlag().

◆ fLastTripTime

template<typename T>

Double_t QwCombinedBCM< T >::fLastTripTime

private

Definition at line 121 of file QwCombinedBCM.h.

Referenced by InitializeChannel(), InitializeChannel(), InitializeChannel(), and RandomizeEventData().

◆ fProbabilityOfTrip

template<typename T>

Double_t QwCombinedBCM< T >::fProbabilityOfTrip

private

Definition at line 125 of file QwCombinedBCM.h.

Referenced by LoadMockDataParameters(), and RandomizeEventData().

◆ fRandomnessGenerator

template<typename T>

std::mt19937 QwCombinedBCM< T >::fRandomnessGenerator

staticprotected

Internal randomness generator.

Definition at line 131 of file QwCombinedBCM.h.

Referenced by SetTripSeed().

◆ fRandomVariable

template<typename T>

std::function<double()> QwCombinedBCM< T >::fRandomVariable

staticprotected

Internal normal random variable.

Definition at line 135 of file QwCombinedBCM.h.

◆ fSumQweights

template<typename T>

Double_t QwCombinedBCM< T >::fSumQweights

private

Definition at line 119 of file QwCombinedBCM.h.

Referenced by ProcessEvent(), and SetBCMForCombo().

◆ fTripLength

template<typename T>

Double_t QwCombinedBCM< T >::fTripLength

private

Definition at line 123 of file QwCombinedBCM.h.

Referenced by LoadMockDataParameters(), and RandomizeEventData().

◆ fTripPeriod

template<typename T>

Double_t QwCombinedBCM< T >::fTripPeriod

private

Definition at line 122 of file QwCombinedBCM.h.

Referenced by LoadMockDataParameters().

◆ fTripRamp

template<typename T>

Double_t QwCombinedBCM< T >::fTripRamp

private

Definition at line 124 of file QwCombinedBCM.h.

Referenced by LoadMockDataParameters(), and RandomizeEventData().

◆ fWeights

template<typename T>

std::vector<Double_t> QwCombinedBCM< T >::fWeights

private

Definition at line 118 of file QwCombinedBCM.h.

Referenced by ProcessEvent(), and SetBCMForCombo().

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

Public Member Functions

Private Attributes

Parity mock data generation

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QwCombinedBCM() [1/5]

◆ QwCombinedBCM() [2/5]

◆ QwCombinedBCM() [3/5]

◆ QwCombinedBCM() [4/5]

◆ QwCombinedBCM() [5/5]

◆ ~QwCombinedBCM()

Member Function Documentation

◆ ApplyHWChecks()

◆ ApplySingleEventCuts()

◆ GetCharge() [1/2]

◆ GetCharge() [2/2]

◆ GetNumberOfElements()

◆ GetProjectedCharge()

◆ GetSubElementName()

◆ InitializeChannel() [1/3]

◆ InitializeChannel() [2/3]

◆ InitializeChannel() [3/3]

◆ LoadMockDataParameters()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ProcessEvBuffer()

◆ ProcessEvent()

◆ RandomizeEventData()

◆ SetBCMForCombo()

◆ SetCalibrationFactor()

◆ SetPedestal()

◆ SetTripSeed()

◆ UpdateErrorFlag()

Field Documentation

◆ fDistribution

◆ fElement

◆ fLastTripTime

◆ fProbabilityOfTrip

◆ fRandomnessGenerator

◆ fRandomVariable

◆ fSumQweights

◆ fTripLength

◆ fTripPeriod

◆ fTripRamp

◆ fWeights