Computes beam energy change from BPM information. More...

#include <QwEnergyCalculator.h>

Inheritance diagram for QwEnergyCalculator:

Collaboration diagram for QwEnergyCalculator:

Public Member Functions
	QwEnergyCalculator ()

	QwEnergyCalculator (TString name)

	QwEnergyCalculator (TString subsystem, TString name)

	QwEnergyCalculator (const QwEnergyCalculator &source)

	~QwEnergyCalculator () override

void	InitializeChannel (TString name, TString datatosave)
	Initialize this energy calculator with a name and data-saving mode.

void	InitializeChannel (TString subsystem, TString name, TString datatosave)
	Initialize this energy calculator with subsystem and name.

void	LoadChannelParameters (QwParameterFile &paramfile) override

void	SetRandomEventParameters (Double_t mean, Double_t sigma)
	Configure Gaussian mock data parameters for the underlying channel.

void	RandomizeEventData (int helicity=0, double time=0.0)
	Generate mock event data for testing.

void	GetProjectedPosition (VQwBPM *device)
	Back-project a BPM position from the current dp/p estimate.

size_t	GetNumberOfElements ()

TString	GetSubElementName (Int_t index)

void	LoadMockDataParameters (QwParameterFile &paramfile) override
	Load mock-data configuration for the underlying channel from a file.

void	ClearEventData () override
	Clear event-scoped data of this calculator and underlying channel.

Int_t	ProcessEvBuffer (UInt_t *buffer, UInt_t word_position_in_buffer, UInt_t indexnumber) override
	Process a configuration/event buffer (no-op for this calculator).

void	ProcessEvent ()
	Compute per-event energy change by summing configured device terms.

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

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

void	SetRootSaveStatus (TString &prefix)
	Determine whether to save full ROOT output based on the prefix.

Bool_t	ApplyHWChecks ()
	Apply hardware checks (delegated to contributing channels if any).

Bool_t	ApplySingleEventCuts ()
	Apply single-event cuts to the energy channel and contributing devices.

Int_t	SetSingleEventCuts (Double_t mean, Double_t sigma)
	Set single-event cut limits on the underlying energy channel.

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

void	SetEventCutMode (Int_t bcuts)

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

void	IncrementErrorCounters ()
	Increment error counters in the underlying energy channel.

void	PrintErrorCounters () const override
	Print accumulated error counters for diagnostic purposes.

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

UInt_t	UpdateErrorFlag () override
	Update and return the composite event-cut error flag.

void	UpdateErrorFlag (const QwEnergyCalculator *ev_error)
	Propagate error flags from a reference calculator into this one.

void	Set (const VQwBPM *device, TString type, TString property, Double_t tmatrix_ratio)
	Register a BPM-based device contributing to the energy calculation.

void	Ratio (QwEnergyCalculator &numer, QwEnergyCalculator &denom)
	Define the ratio for asymmetry formation (here acts as pass-through).

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

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

QwEnergyCalculator &	operator+= (const QwEnergyCalculator &value)
	Add-assign from another calculator (sum energy change).

QwEnergyCalculator &	operator-= (const QwEnergyCalculator &value)
	Subtract-assign from another calculator (difference energy change).

void	Sum (const QwEnergyCalculator &value1, const QwEnergyCalculator &value2)

void	Difference (const QwEnergyCalculator &value1, const QwEnergyCalculator &value2)

void	AccumulateRunningSum (const QwEnergyCalculator &value, Int_t count=0, Int_t ErrorMask=0xFFFFFFF)
	Accumulate running sums from another calculator into this one.

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

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

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

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

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

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

void	ConstructBranch (TTree *tree, TString &prefix, QwParameterFile &trim_file)

void	FillTreeVector (QwRootTreeBranchVector &values) const

VQwHardwareChannel *	GetEnergy ()

const VQwHardwareChannel *	GetEnergy () const

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)

virtual Bool_t	NeedsExternalClock ()

virtual std::string	GetExternalClockName ()

virtual void	SetExternalClockPtr (const VQwHardwareChannel *)

virtual void	SetExternalClockName (const std::string)

virtual Double_t	GetNormClockValue ()

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.

Protected Attributes
QwMollerADC_Channel	fEnergyChange

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.

Private Attributes
std::vector< const VQwBPM * >	fDevice

std::vector< Double_t >	fTMatrixRatio

std::vector< TString >	fProperty

std::vector< TString >	fType

Bool_t	bEVENTCUTMODE

Bool_t	bFullSave

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

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.

Detailed Description

Computes beam energy change from BPM information.

Uses measured angles and dispersive positions to estimate relative beam energy variations; exposes a single hardware-like channel.

Definition at line 43 of file QwEnergyCalculator.h.

Constructor & Destructor Documentation

◆ QwEnergyCalculator() [1/4]

QwEnergyCalculator::QwEnergyCalculator ( )

inline

Definition at line 55 of file QwEnergyCalculator.h.

55{ };

Referenced by AccumulateRunningSum(), CheckForBurpFail(), DeaccumulateRunningSum(), Difference(), GetEnergy(), operator+=(), operator-=(), operator=(), QwEnergyCalculator(), Ratio(), Sum(), and UpdateErrorFlag().

Here is the caller graph for this function:

◆ QwEnergyCalculator() [2/4]

QwEnergyCalculator::QwEnergyCalculator ( TString name )

inline

Definition at line 56 of file QwEnergyCalculator.h.

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

References InitializeChannel().

Here is the call graph for this function:

◆ QwEnergyCalculator() [3/4]

QwEnergyCalculator::QwEnergyCalculator	(	TString	subsystem,
		TString	name )

inline

Definition at line 59 of file QwEnergyCalculator.h.

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

References InitializeChannel().

Here is the call graph for this function:

◆ QwEnergyCalculator() [4/4]

QwEnergyCalculator::QwEnergyCalculator ( const QwEnergyCalculator & source )

inline

Definition at line 62 of file QwEnergyCalculator.h.

63 : VQwDataElement(source),fEnergyChange(source.fEnergyChange)

64 { }

VQwDataElement::VQwDataElement

VQwDataElement()

Default constructor.

Definition VQwDataElement.h:89

QwEnergyCalculator::fEnergyChange

QwMollerADC_Channel fEnergyChange

Definition QwEnergyCalculator.h:152

References fEnergyChange, QwEnergyCalculator(), and VQwDataElement::VQwDataElement().

Here is the call graph for this function:

◆ ~QwEnergyCalculator()

QwEnergyCalculator::~QwEnergyCalculator ( )

inlineoverride

Definition at line 65 of file QwEnergyCalculator.h.

65{ };

Member Function Documentation

◆ AccumulateRunningSum()

void QwEnergyCalculator::AccumulateRunningSum	(	const QwEnergyCalculator &	value,
		Int_t	count = 0,
		Int_t	ErrorMask = 0xFFFFFFF )

Accumulate running sums from another calculator into this one.

Parameters

value	Source calculator to accumulate from.
count	Weight/count for accumulation; 0 implies use source count.
ErrorMask	Mask to control error propagation behavior.

Definition at line 359 of file QwEnergyCalculator.cc.

                                                                                                          {
  fEnergyChange.AccumulateRunningSum(value.fEnergyChange, count, ErrorMask);
}

References fEnergyChange, and QwEnergyCalculator().

Here is the call graph for this function:

◆ ApplyHWChecks()

Bool_t QwEnergyCalculator::ApplyHWChecks ( )

Apply hardware checks (delegated to contributing channels if any).

Returns: Always kTRUE; no direct hardware channels in this calculator.

Definition at line 461 of file QwEnergyCalculator.cc.

                                        {
  // For the energy calculator there are no physical channels that we can relate to because it is being
  // derived from combinations of physical channels. Therefore, this is not exactly a "HW Check"
  // but just a check of the HW checks of the used channels.
 
  Bool_t eventokay=kTRUE;
  return eventokay;
}

◆ ApplySingleEventCuts()

Bool_t QwEnergyCalculator::ApplySingleEventCuts ( )

Apply single-event cuts to the energy channel and contributing devices.

Returns: kTRUE if the event passes cuts; otherwise kFALSE.

Definition at line 273 of file QwEnergyCalculator.cc.

                                               {
  Bool_t status=kTRUE;
 
  UInt_t error_code = 0;
  for(UInt_t i = 0; i<fProperty.size(); i++){
    if(fProperty[i].Contains("targetbeamangle")){
      error_code |= ((QwCombinedBPM<QwMollerADC_Channel>*)fDevice[i])->fSlope[0].GetErrorCode();
    } else {
      error_code |= fDevice[i]->GetPosition(VQwBPM::kXAxis)->GetErrorCode();
    }
  }
  //fEnergyChange.UpdateErrorFlag(error_code);//No need to do this. error codes are ORed when energy is calculated
 
  if (fEnergyChange.ApplySingleEventCuts()){
    status=kTRUE;
  }
  else{
    status&=kFALSE;
  }
  return status;
}

References fDevice, fEnergyChange, fProperty, and VQwBPM::kXAxis.

◆ CalculateRunningAverage()

void QwEnergyCalculator::CalculateRunningAverage ( )

Update running averages for the underlying energy channel.

Definition at line 347 of file QwEnergyCalculator.cc.

                                                {
  fEnergyChange.CalculateRunningAverage();
}

References fEnergyChange.

◆ CheckForBurpFail()

Bool_t QwEnergyCalculator::CheckForBurpFail ( const VQwDataElement * ev_error )

Check for burp failures by delegating to the energy channel.

Parameters

ev_error Reference energy calculator to compare against.

Returns: kTRUE if a burp failure was detected; otherwise kFALSE.

Definition at line 502 of file QwEnergyCalculator.cc.

                                                                         {
  Bool_t burpstatus = kFALSE;
  try {
    if(typeid(*ev_error)==typeid(*this)) {
      //std::cout<<" Here in QwEnergyCalculator::CheckForBurpFail \n";
      if (this->GetElementName()!="") {
        const QwEnergyCalculator* value_halo = dynamic_cast<const QwEnergyCalculator* >(ev_error);
        burpstatus |= fEnergyChange.CheckForBurpFail(&(value_halo->fEnergyChange));
      }
    } else {
      TString loc="Standard exception from QwEnergyCalculator::CheckForBurpFail :"+
        ev_error->GetElementName()+" "+this->GetElementName()+" are not of the "
        +"same type";
      throw std::invalid_argument(loc.Data());
    }
  } catch (std::exception& e) {
    std::cerr<< e.what()<<std::endl;
  }
  return burpstatus;
}

References fEnergyChange, VQwDataElement::GetElementName(), QwEnergyCalculator(), and VQwDataElement::VQwDataElement().

Here is the call graph for this function:

◆ ClearEventData()

void QwEnergyCalculator::ClearEventData ( )

overridevirtual

Clear event-scoped data of this calculator and underlying channel.

Reimplemented from VQwDataElement.

Definition at line 93 of file QwEnergyCalculator.cc.

                                       {
  fEnergyChange.ClearEventData();
  return;
}

References fEnergyChange.

Referenced by ProcessEvent().

Here is the caller graph for this function:

◆ ConstructBranch() [1/2]

void QwEnergyCalculator::ConstructBranch	(	TTree *	tree,
		TString &	prefix )

Construct ROOT branches for this calculator (if enabled).

Parameters

tree	Output tree.
prefix	Branch name prefix.

Definition at line 583 of file QwEnergyCalculator.cc.

                                                                     {
  if (GetElementName()==""){
    //  This channel is not used, so skip filling the histograms.
  }
  else{
    TString thisprefix=prefix;
    if(prefix.Contains("asym_"))
      thisprefix.ReplaceAll("asym_","diff_");
 
    SetRootSaveStatus(thisprefix);
    fEnergyChange.ConstructBranch(tree,thisprefix);
  }
  return;
}

References fEnergyChange, VQwDataElement::GetElementName(), and SetRootSaveStatus().

Here is the call graph for this function:

◆ ConstructBranch() [2/2]

void QwEnergyCalculator::ConstructBranch	(	TTree *	tree,
		TString &	prefix,
		QwParameterFile &	trim_file )

Definition at line 598 of file QwEnergyCalculator.cc.

                                                                                                  {
 
  TString devicename;
  devicename=GetElementName();
  devicename.ToLower();
  if (GetElementName()==""){
    //  This channel is not used, so skip filling the histograms.
  }
  else
    if (modulelist.HasValue(devicename)){
      TString thisprefix=prefix;
      if(prefix.Contains("asym_"))
    thisprefix.ReplaceAll("asym_","diff_");
      SetRootSaveStatus(thisprefix);
      fEnergyChange.ConstructBranch(tree,thisprefix);
      QwMessage <<" Tree leave added to "<<devicename<<QwLog::endl;
      }
  return;
}

References QwLog::endl(), fEnergyChange, VQwDataElement::GetElementName(), QwParameterFile::HasValue(), QwMessage, and SetRootSaveStatus().

Here is the call graph for this function:

◆ ConstructBranchAndVector()

void QwEnergyCalculator::ConstructBranchAndVector	(	TTree *	tree,
		TString &	prefix,
		QwRootTreeBranchVector &	values )

Construct ROOT branches and value vector entries.

Parameters

tree	Output tree.
prefix	Branch name prefix.
values	Output value vector to be appended.

Definition at line 559 of file QwEnergyCalculator.cc.

                                                          {
  if (GetElementName()==""){
    //  This channel is not used, so skip filling the histograms.
  }
  else{
    TString thisprefix=prefix;
    if(prefix.Contains("asym_"))
      thisprefix.ReplaceAll("asym_","diff_");
 
    SetRootSaveStatus(thisprefix);
 
    fEnergyChange.ConstructBranchAndVector(tree,thisprefix,values);
  }
    return;
}

References fEnergyChange, VQwDataElement::GetElementName(), and SetRootSaveStatus().

Here is the call graph for this function:

◆ ConstructHistograms()

void QwEnergyCalculator::ConstructHistograms	(	TDirectory *	folder,
		TString &	prefix )

overridevirtual

Define histograms for this calculator (delegated to energy channel).

Parameters

folder	ROOT folder to contain histograms.
prefix	Histogram name prefix.

Implements VQwDataElement.

Definition at line 528 of file QwEnergyCalculator.cc.

                                                                                {
  if (GetElementName()==""){
    //  This channel is not used, so skip filling the histograms.
  }
  else{
    TString thisprefix=prefix;
    if(prefix.Contains("asym_"))
      thisprefix.ReplaceAll("asym_","diff_");
    SetRootSaveStatus(thisprefix);
    fEnergyChange.ConstructHistograms(folder, thisprefix);
  }
  return;
}

References fEnergyChange, VQwDataElement::GetElementName(), and SetRootSaveStatus().

Here is the call graph for this function:

◆ DeaccumulateRunningSum()

void QwEnergyCalculator::DeaccumulateRunningSum	(	QwEnergyCalculator &	value,
		Int_t	ErrorMask = 0xFFFFFFF )

Remove a single entry from the running sums using a source value.

Parameters

value	Source calculator to subtract.
ErrorMask	Mask to control error propagation behavior.

Definition at line 368 of file QwEnergyCalculator.cc.

                                                                                         {
  fEnergyChange.DeaccumulateRunningSum(value.fEnergyChange, ErrorMask);
}

References fEnergyChange, and QwEnergyCalculator().

Here is the call graph for this function:

◆ Difference()

void QwEnergyCalculator::Difference	(	const QwEnergyCalculator &	value1,
		const QwEnergyCalculator &	value2 )

Definition at line 414 of file QwEnergyCalculator.cc.

                                                                                                      {
  *this = value1;
  *this -= value2;
}

References QwEnergyCalculator().

Here is the call graph for this function:

◆ FillHistograms()

void QwEnergyCalculator::FillHistograms ( )

overridevirtual

Fill histograms for this calculator if enabled.

Implements VQwDataElement.

Definition at line 543 of file QwEnergyCalculator.cc.

                                        {
  if (GetElementName()==""){
    //  This channel is not used, so skip filling the histograms.
  }
  else
    fEnergyChange.FillHistograms();
 
  return;
}

References fEnergyChange, and VQwDataElement::GetElementName().

Here is the call graph for this function:

◆ FillTreeVector()

void QwEnergyCalculator::FillTreeVector ( QwRootTreeBranchVector & values ) const

Definition at line 618 of file QwEnergyCalculator.cc.

{
  if (GetElementName()==""){
    //  This channel is not used, so skip filling the histograms.
  }
  else
    fEnergyChange.FillTreeVector(values);
  return;
}

References fEnergyChange, and VQwDataElement::GetElementName().

Here is the call graph for this function:

◆ GetEnergy() [1/2]

VQwHardwareChannel * QwEnergyCalculator::GetEnergy ( )

inline

Definition at line 138 of file QwEnergyCalculator.h.

                                   {
      return &fEnergyChange;
    };

References fEnergyChange.

Referenced by GetEnergy().

Here is the caller graph for this function:

◆ GetEnergy() [2/2]

const VQwHardwareChannel * QwEnergyCalculator::GetEnergy ( ) const

inline

Definition at line 142 of file QwEnergyCalculator.h.

                                               {
      return const_cast<QwEnergyCalculator*>(this)->GetEnergy();
    };

References GetEnergy(), and QwEnergyCalculator().

Here is the call graph for this function:

◆ GetEventcutErrorFlag()

UInt_t QwEnergyCalculator::GetEventcutErrorFlag ( )

inlineoverridevirtual

return the error flag on this channel/device

Reimplemented from VQwDataElement.

Definition at line 103 of file QwEnergyCalculator.h.

                                            {//return the error flag
      return fEnergyChange.GetEventcutErrorFlag();
    }

References fEnergyChange.

◆ GetNumberOfElements()

size_t QwEnergyCalculator::GetNumberOfElements ( )

inline

Definition at line 77 of file QwEnergyCalculator.h.

77{return fDevice.size();};

References fDevice.

◆ GetProjectedPosition()

void QwEnergyCalculator::GetProjectedPosition ( VQwBPM * device )

Back-project a BPM position from the current dp/p estimate.

Parameters

device BPM device whose X position is solved from energy and other terms.

fProperty.size()=3, idevice=4

fDevice[i] = qwk_1c12 = device

i=0=idevice

idevice=0, fProperty.size()=3

qwk_1c12X changes only

idevice=0

Definition at line 174 of file QwEnergyCalculator.cc.

{
  UInt_t idevice = fProperty.size()+1; /** fProperty.size()=3, idevice=4 **/
 
  for(UInt_t i=0; i<fProperty.size(); i++) {
   if (fDevice[i]->GetElementName()==device->GetElementName()) { /** fDevice[i] = qwk_1c12 = device **/
     idevice = i; /** i=0=idevice **/
     break;
    }
  } /** idevice=0, fProperty.size()=3 **/
 
  if (idevice>fProperty.size()) return;  // Return without trying to find a new position if "device" doesn't contribute to the energy calculator
 
  static QwMollerADC_Channel tmp;
  tmp.InitializeChannel("tmp","derived");
  tmp.ClearEventData();
  //  Set the device position value to be equal to the energy change
  (device->GetPosition(VQwBPM::kXAxis))->AssignValueFrom(&fEnergyChange);
  /** qwk_1c12X changes only **/
 
  /** idevice=0 **/
  for(UInt_t i = 0; i<fProperty.size(); i++) {
   if (i==idevice) {
     // Do nothing for this device!
     continue;
   } else {
      //  Calculate contribution to fEnergyChange from the other devices
      if(fProperty[i].Contains("targetbeamangle")) {
       tmp.ArcTan((((QwCombinedBPM<QwMollerADC_Channel>*)fDevice[i])->fSlope[VQwBPM::kXAxis]));
      } else {
       tmp.AssignValueFrom(fDevice[i]->GetPosition(VQwBPM::kXAxis));
      }
     tmp.Scale(fTMatrixRatio[i]);
     //  And subtract it from the device we are trying to get the position of.
     (device->GetPosition(VQwBPM::kXAxis))->operator-=(tmp);
   }
  } // end of for(UInt_t i = 0; i<fProperty.size(); i++)
 
  //  At this point, device position is (Energy - ( M_x*x + M_xp*arctan(xp) ) )
  //  Now divide by matrixratio for 1c12 to get: (Energy - ( M_x*x + M_xp*arctan(xp) ) )/M_1c12 === x_1c12
 
  (device->GetPosition(VQwBPM::kXAxis))->Scale(1.0/fTMatrixRatio[idevice]);
  device->ApplyResolutionSmearing(VQwBPM::kXAxis);
  device->FillRawEventData();
 
/*
///  Reclaculate energy and see what we get
  static QwVQWK_Channel tmp_e;
  tmp_e.InitializeChannel("tmp_e","derived");
  tmp_e.ClearEventData();
 
  for(UInt_t i = 0; i<fProperty.size(); i++){
    if(fProperty[i].Contains("targetbeamangle")){
      tmp.ArcTan((((QwCombinedBPM<QwVQWK_Channel>*)fDevice[i])->fSlope[VQwBPM::kXAxis]));
    } else {
      tmp.AssignValueFrom(fDevice[i]->GetPosition(VQwBPM::kXAxis));
    }
    tmp.Scale(fTMatrixRatio[i]);
    tmp_e += tmp;
   }
  //  std::cout << "GetProjectedPosition()::fEnergyChange = " << fEnergyChange.GetValue(0) << "\t ProcessEvent()::fEnergyChange = " << tmp_e.GetValue(0) << std::endl;
*/
 
  return;
}

References VQwBPM::ApplyResolutionSmearing(), QwMollerADC_Channel::ArcTan(), QwMollerADC_Channel::AssignValueFrom(), QwMollerADC_Channel::ClearEventData(), fDevice, fEnergyChange, VQwBPM::FillRawEventData(), fProperty, fTMatrixRatio, VQwDataElement::GetElementName(), VQwBPM::GetPosition(), QwMollerADC_Channel::InitializeChannel(), VQwBPM::kXAxis, and QwMollerADC_Channel::Scale().

Here is the call graph for this function:

◆ GetSubElementName()

TString QwEnergyCalculator::GetSubElementName ( Int_t index )

inline

Definition at line 78 of file QwEnergyCalculator.h.

78{return fDevice.at(index)->GetElementName();};

References fDevice.

◆ IncrementErrorCounters()

void QwEnergyCalculator::IncrementErrorCounters ( )

Increment error counters in the underlying energy channel.

Definition at line 298 of file QwEnergyCalculator.cc.

{
  fEnergyChange.IncrementErrorCounters();
}

References fEnergyChange.

◆ InitializeChannel() [1/2]

void QwEnergyCalculator::InitializeChannel	(	TString	name,
		TString	datatosave )

Initialize this energy calculator with a name and data-saving mode.

Parameters

name	Element name used for histogram and branch prefixes.
datatosave	Storage mode (e.g., "raw" or "derived").

Definition at line 34 of file QwEnergyCalculator.cc.

{
  SetElementName(name);
  fEnergyChange.InitializeChannel(name,datatosave);
  //  beamx.InitializeChannel("beamx","derived");
  return;
}

References fEnergyChange, and VQwDataElement::SetElementName().

Referenced by QwEnergyCalculator(), and QwEnergyCalculator().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InitializeChannel() [2/2]

void QwEnergyCalculator::InitializeChannel	(	TString	subsystem,
		TString	name,
		TString	datatosave )

Initialize this energy calculator with subsystem and name.

Parameters

subsystem	Subsystem identifier for tree/hist foldering.
name	Element name used for histogram and branch prefixes.
datatosave	Storage mode (e.g., "raw" or "derived").

Definition at line 48 of file QwEnergyCalculator.cc.

{
  SetElementName(name);
  fEnergyChange.InitializeChannel(subsystem, "QwEnergyCalculator", name,datatosave);
  //  beamx.InitializeChannel("beamx","derived");
  return;
}

References fEnergyChange, and VQwDataElement::SetElementName().

Here is the call graph for this function:

◆ LoadChannelParameters()

void QwEnergyCalculator::LoadChannelParameters ( QwParameterFile & paramfile )

inlineoverridevirtual

Reimplemented from VQwDataElement.

Definition at line 71 of file QwEnergyCalculator.h.

71{};

◆ LoadMockDataParameters()

void QwEnergyCalculator::LoadMockDataParameters ( QwParameterFile & paramfile )

overridevirtual

Load mock-data configuration for the underlying channel from a file.

Parameters

paramfile Parameter file reader positioned at channel section.

Reimplemented from VQwDataElement.

Definition at line 245 of file QwEnergyCalculator.cc.

                                                                         {
 
  //std::cout << "In QwEnergyCalculator: ChannelName = " << GetElementName() << std::endl;
  fEnergyChange.SetMockDataAsDiff();  // Sets this channel to use the difference mode in the RandomizeMockData
  fEnergyChange.LoadMockDataParameters(paramfile);
 
/*  Bool_t   ldebug=kFALSE;
  Double_t mean=0.0, sigma=0.0;
 
  mean  = paramfile.GetTypedNextToken<Double_t>();
  sigma = paramfile.GetTypedNextToken<Double_t>();
 
   if (ldebug==1) {
     std::cout << "#################### \n";
     std::cout << "! mean, sigma \n" << std::endl;
     std::cout << mean                             << " / "
           << sigma                            << " / "
           << std::endl;
   }
  this->SetRandomEventParameters(mean, sigma);
*/
}

References fEnergyChange.

◆ operator+=()

QwEnergyCalculator & QwEnergyCalculator::operator+= ( const QwEnergyCalculator & value )

Add-assign from another calculator (sum energy change).

Definition at line 393 of file QwEnergyCalculator.cc.

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

References fEnergyChange, VQwDataElement::GetElementName(), and QwEnergyCalculator().

Here is the call graph for this function:

◆ operator-=()

QwEnergyCalculator & QwEnergyCalculator::operator-= ( const QwEnergyCalculator & value )

Subtract-assign from another calculator (difference energy change).

Definition at line 402 of file QwEnergyCalculator.cc.

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

References fEnergyChange, VQwDataElement::GetElementName(), and QwEnergyCalculator().

Here is the call graph for this function:

◆ operator=()

QwEnergyCalculator & QwEnergyCalculator::operator= ( const QwEnergyCalculator & value )

Copy-assign from another calculator (event-scoped data).

Definition at line 384 of file QwEnergyCalculator.cc.

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

References fEnergyChange, VQwDataElement::GetElementName(), and QwEnergyCalculator().

Here is the call graph for this function:

◆ PrintErrorCounters()

void QwEnergyCalculator::PrintErrorCounters ( ) const

overridevirtual

Print accumulated error counters for diagnostic purposes.

Reimplemented from VQwDataElement.

Definition at line 307 of file QwEnergyCalculator.cc.

                                                 {
  // report number of events failed due to HW and event cut failure
  fEnergyChange.PrintErrorCounters();
}

References fEnergyChange.

◆ PrintInfo()

void QwEnergyCalculator::PrintInfo ( ) const

overridevirtual

Print detailed information for this calculator.

Reimplemented from VQwDataElement.

Definition at line 445 of file QwEnergyCalculator.cc.

                                        {
  fEnergyChange.PrintInfo();
  return;
}

References fEnergyChange.

◆ PrintValue()

void QwEnergyCalculator::PrintValue ( ) const

overridevirtual

Print a compact value summary for this calculator.

Reimplemented from VQwDataElement.

Definition at line 452 of file QwEnergyCalculator.cc.

                                         {
  fEnergyChange.PrintValue();
  return;
}

References fEnergyChange.

◆ ProcessEvBuffer()

Int_t QwEnergyCalculator::ProcessEvBuffer	(	UInt_t *	buffer,
		UInt_t	word_position_in_buffer,
		UInt_t	subelement )

overridevirtual

Process a configuration/event buffer (no-op for this calculator).

Returns: The updated buffer word position (unchanged here).

Implements VQwDataElement.

Definition at line 378 of file QwEnergyCalculator.cc.

                                                                                                         {
  return 0;
}

References QwBPMStripline< T >::subelement.

◆ ProcessEvent()

void QwEnergyCalculator::ProcessEvent ( )

Compute per-event energy change by summing configured device terms.

Definition at line 103 of file QwEnergyCalculator.cc.

{
  //Bool_t ldebug = kFALSE;
  //Double_t targetbeamangle = 0.0;
  static QwMollerADC_Channel tmp;
  tmp.InitializeChannel("tmp","derived");
  tmp.ClearEventData();
 
  this->ClearEventData();
 
  for(UInt_t i = 0; i<fProperty.size(); i++){
    if(fProperty[i].Contains("targetbeamangle")){
      tmp.ArcTan((((QwCombinedBPM<QwMollerADC_Channel>*)fDevice[i])->fSlope[VQwBPM::kXAxis]));
     } else {
      tmp.AssignValueFrom(fDevice[i]->GetPosition(VQwBPM::kXAxis));
     }
    tmp.Scale(fTMatrixRatio[i]);
    fEnergyChange += tmp;
   }
/*
    if(fProperty[i].Contains("targetbeamangle")){
      tmp.ArcTan((((QwCombinedBPM<QwVQWK_Channel>*)fDevice[i])->fSlope[VQwBPM::kXAxis]));
      tmp.Scale(fTMatrixRatio[i]);
     // targetbeamangle = atan((((QwCombinedBPM<QwVQWK_Channel>*)fDevice[i])->fSlope[VQwBPM::kXAxis]).GetValue());
     // targetbeamangle *= fTMatrixRatio[i];
      //if(ldebug) std::cout<<"QwEnegyCalculator::ProcessEvent() :: Beam angle in X at target = "<<targetbeamangle<<std::endl;
    //  fEnergyChange.AddChannelOffset(targetbeamangle);
      fEnergyChange += tmp;
      //if(ldebug) std::cout<<"QwEnegyCalculator::ProcessEvent() :: dp/p += (M12/M16)*X angle = "<<fEnergyChange.GetValue()<<std::endl;
    } else {
      tmp.AssignValueFrom(fDevice[i]->GetPosition(VQwBPM::kXAxis));
      if(ldebug) std::cout<<"QwEnegyCalculator::ProcessEvent() :: X position from "<<fDevice[i]->GetElementName()<<" = "<<tmp.GetValue()<<std::endl;
      tmp.Scale(fTMatrixRatio[i]);
      if(ldebug) std::cout<<"QwEnegyCalculator::ProcessEvent() :: (M11/M16)*X position = "<<tmp.GetValue()<<std::endl;
      fEnergyChange += tmp;
    }
*/
  //if(ldebug) std::cout<<"QwEnegyCalculator::ProcessEvent() :: dp/p = "<<fEnergyChange.GetValue()<<std::endl;
  return;
}

References QwMollerADC_Channel::ArcTan(), QwMollerADC_Channel::AssignValueFrom(), ClearEventData(), QwMollerADC_Channel::ClearEventData(), fDevice, fEnergyChange, fProperty, fTMatrixRatio, QwMollerADC_Channel::InitializeChannel(), VQwBPM::kXAxis, and QwMollerADC_Channel::Scale().

Here is the call graph for this function:

◆ RandomizeEventData()

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

Generate mock event data for testing.

Parameters

helicity	Helicity state indicator.
time	Event time or timestamp proxy.

Definition at line 151 of file QwEnergyCalculator.cc.

{
  fEnergyChange.RandomizeEventData(helicity, time);
  return;
}

References fEnergyChange.

◆ Ratio()

void QwEnergyCalculator::Ratio	(	QwEnergyCalculator &	numer,
		QwEnergyCalculator &	denom )

Define the ratio for asymmetry formation (here acts as pass-through).

Parameters

numer	Numerator calculator.
denom	Denominator calculator.

Definition at line 425 of file QwEnergyCalculator.cc.

                                                                                  {
  // this function is called when forming asymmetries. In this case what we actually want for the
  // qwk_energy/(dp/p) is the difference only not the asymmetries
 
  *this=numer;
  return;
}

References QwEnergyCalculator().

Here is the call graph for this function:

◆ Scale()

void QwEnergyCalculator::Scale ( Double_t factor )

Scale the underlying energy channel by a constant factor.

Parameters

factor Multiplicative scale factor.

Definition at line 438 of file QwEnergyCalculator.cc.

                                             {
  fEnergyChange.Scale(factor);
  return;
}

References fEnergyChange.

◆ Set()

void QwEnergyCalculator::Set	(	const VQwBPM *	device,
		TString	type,
		TString	property,
		Double_t	tmatrix_ratio )

Register a BPM-based device contributing to the energy calculation.

Parameters

device	Pointer to contributing BPM object.
type	Device type string (e.g., BPM, ComboBPM).
property	Property descriptor (e.g., targetbeamangle).
tmatrix_ratio	Transport matrix ratio coefficient for contribution.

Definition at line 63 of file QwEnergyCalculator.cc.

{
  Bool_t ldebug = kFALSE;
 
  fDevice.push_back(device);
  fProperty.push_back(property);
  fType.push_back(type);
  fTMatrixRatio.push_back(tmatrix_ratio);
 
  if(ldebug)
    std::cout<<"QwEnergyCalculator:: Using "<<device->GetElementName()<<" with ratio "<< tmatrix_ratio <<" for "<<property<<std::endl;
 
  return;
}

References fDevice, fProperty, fTMatrixRatio, fType, and VQwDataElement::GetElementName().

Here is the call graph for this function:

◆ SetEventCutMode()

void QwEnergyCalculator::SetEventCutMode ( Int_t bcuts )

inline

Definition at line 95 of file QwEnergyCalculator.h.

                                        {
      bEVENTCUTMODE=bcuts;
      fEnergyChange.SetEventCutMode(bcuts);
    }

References bEVENTCUTMODE, and fEnergyChange.

◆ SetRandomEventParameters()

void QwEnergyCalculator::SetRandomEventParameters	(	Double_t	mean,
		Double_t	sigma )

Configure Gaussian mock data parameters for the underlying channel.

Parameters

mean	Mean value for the distribution.
sigma	Standard deviation for the distribution.

Definition at line 163 of file QwEnergyCalculator.cc.

{
  fEnergyChange.SetRandomEventParameters(mean, sigma);
  return;
}

References fEnergyChange.

◆ SetRootSaveStatus()

void QwEnergyCalculator::SetRootSaveStatus ( TString & prefix )

Determine whether to save full ROOT output based on the prefix.

Parameters

prefix Branch/histogram prefix (may toggle full save for asym/diff).

Definition at line 82 of file QwEnergyCalculator.cc.

{
  if(prefix.Contains("diff_")||prefix.Contains("yield_")|| prefix.Contains("asym_"))
    bFullSave=kFALSE;
 
  return;
}

References bFullSave.

Referenced by ConstructBranch(), ConstructBranch(), ConstructBranchAndVector(), and ConstructHistograms().

Here is the caller graph for this function:

◆ SetSingleEventCuts() [1/2]

Int_t QwEnergyCalculator::SetSingleEventCuts	(	Double_t	minX,
		Double_t	maxX )

Set single-event cut limits on the underlying energy channel.

Parameters

minX	Lower limit.
maxX	Upper limit.

Returns: 1 on success.

Definition at line 477 of file QwEnergyCalculator.cc.

                                                                        {
  fEnergyChange.SetSingleEventCuts(minX,maxX);
  return 1;
}

References fEnergyChange.

◆ SetSingleEventCuts() [2/2]

void QwEnergyCalculator::SetSingleEventCuts	(	UInt_t	errorflag,
		Double_t	LL = 0,
		Double_t	UL = 0,
		Double_t	stability = 0,
		Double_t	burplevel = 0 )

Inherited from VQwDataElement to set the upper and lower limits (fULimit and fLLimit), stability % and the error flag on this channel.

Configure detailed single-event cuts for the underlying channel.

Parameters

errorflag	Device-specific error flag mask to set.
LL	Lower limit.
UL	Upper limit.
stability	Stability threshold.
burplevel	Burp detection threshold.

Definition at line 490 of file QwEnergyCalculator.cc.

                                                                                                                                     {
  //set the unique tag to identify device type (bcm,bpm & etc)
  errorflag|=kBCMErrorFlag;//currently I use the same flag for bcm
  QwMessage<<"QwEnergyCalculator Error Code passing to QwMollerADC_Ch "<<errorflag<<QwLog::endl;
  fEnergyChange.SetSingleEventCuts(errorflag,LL,UL,stability,burplevel);
}

References QwLog::endl(), fEnergyChange, kBCMErrorFlag, and QwMessage.

Here is the call graph for this function:

◆ Sum()

void QwEnergyCalculator::Sum	(	const QwEnergyCalculator &	value1,
		const QwEnergyCalculator &	value2 )

Definition at line 409 of file QwEnergyCalculator.cc.

                                                                                               {
  *this = value1;
  *this += value2;
}

References QwEnergyCalculator().

Here is the call graph for this function:

◆ UpdateErrorFlag() [1/2]

UInt_t QwEnergyCalculator::UpdateErrorFlag ( )

overridevirtual

Update and return the composite event-cut error flag.

Returns: The updated event-cut error flag for this calculator.

Reimplemented from VQwDataElement.

Definition at line 320 of file QwEnergyCalculator.cc.

{
  UInt_t error_code = 0;
  for(UInt_t i = 0; i<fProperty.size(); i++){
    if(fProperty[i].Contains("targetbeamangle")){
      error_code |= ((QwCombinedBPM<QwMollerADC_Channel>*)fDevice[i])->fSlope[0].GetErrorCode();
    } else {
      error_code |= fDevice[i]->GetPosition(VQwBPM::kXAxis)->GetErrorCode();
    }
  }
  fEnergyChange.UpdateErrorFlag(error_code);
  return fEnergyChange.GetEventcutErrorFlag();
}

References fDevice, fEnergyChange, fProperty, and VQwBPM::kXAxis.

◆ UpdateErrorFlag() [2/2]

void QwEnergyCalculator::UpdateErrorFlag ( const QwEnergyCalculator * ev_error )

Propagate error flags from a reference calculator into this one.

Parameters

ev_error Reference energy calculator containing error flags to merge.

Definition at line 339 of file QwEnergyCalculator.cc.

                                                                          {
  fEnergyChange.UpdateErrorFlag(ev_error->fEnergyChange);
};

References fEnergyChange, and QwEnergyCalculator().

Here is the call graph for this function:

Field Documentation

◆ bEVENTCUTMODE

Bool_t QwEnergyCalculator::bEVENTCUTMODE

private

Definition at line 160 of file QwEnergyCalculator.h.

Referenced by SetEventCutMode().

◆ bFullSave

Bool_t QwEnergyCalculator::bFullSave

private

Definition at line 161 of file QwEnergyCalculator.h.

Referenced by SetRootSaveStatus().

◆ fDevice

std::vector<const VQwBPM*> QwEnergyCalculator::fDevice

private

Definition at line 156 of file QwEnergyCalculator.h.

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

◆ fEnergyChange

QwMollerADC_Channel QwEnergyCalculator::fEnergyChange

protected

◆ fProperty

std::vector<TString> QwEnergyCalculator::fProperty

private

Definition at line 158 of file QwEnergyCalculator.h.

Referenced by ApplySingleEventCuts(), GetProjectedPosition(), ProcessEvent(), Set(), and UpdateErrorFlag().

◆ fTMatrixRatio

std::vector<Double_t> QwEnergyCalculator::fTMatrixRatio

private

Definition at line 157 of file QwEnergyCalculator.h.

Referenced by GetProjectedPosition(), ProcessEvent(), and Set().

◆ fType

std::vector<TString> QwEnergyCalculator::fType

private

Definition at line 159 of file QwEnergyCalculator.h.

Referenced by Set().

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

Public Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QwEnergyCalculator() [1/4]

◆ QwEnergyCalculator() [2/4]

◆ QwEnergyCalculator() [3/4]

◆ QwEnergyCalculator() [4/4]

◆ ~QwEnergyCalculator()

Member Function Documentation

◆ AccumulateRunningSum()

◆ ApplyHWChecks()

◆ ApplySingleEventCuts()

◆ CalculateRunningAverage()

◆ CheckForBurpFail()

◆ ClearEventData()

◆ ConstructBranch() [1/2]

◆ ConstructBranch() [2/2]

◆ ConstructBranchAndVector()

◆ ConstructHistograms()

◆ DeaccumulateRunningSum()

◆ Difference()

◆ FillHistograms()

◆ FillTreeVector()

◆ GetEnergy() [1/2]

◆ GetEnergy() [2/2]

◆ GetEventcutErrorFlag()

◆ GetNumberOfElements()

◆ GetProjectedPosition()

◆ GetSubElementName()

◆ IncrementErrorCounters()

◆ InitializeChannel() [1/2]

◆ InitializeChannel() [2/2]

◆ LoadChannelParameters()

◆ LoadMockDataParameters()

◆ operator+=()

◆ operator-=()

◆ operator=()

◆ PrintErrorCounters()

◆ PrintInfo()

◆ PrintValue()

◆ ProcessEvBuffer()

◆ ProcessEvent()

◆ RandomizeEventData()

◆ Ratio()

◆ Scale()

◆ Set()

◆ SetEventCutMode()

◆ SetRandomEventParameters()

◆ SetRootSaveStatus()

◆ SetSingleEventCuts() [1/2]

◆ SetSingleEventCuts() [2/2]

◆ Sum()

◆ UpdateErrorFlag() [1/2]

◆ UpdateErrorFlag() [2/2]

Field Documentation

◆ bEVENTCUTMODE

◆ bFullSave

◆ fDevice

◆ fEnergyChange

◆ fProperty

◆ fTMatrixRatio

◆ fType