QwBPMCavity Class Reference

Cavity-style BPM using VQWK channels. More...

#include <QwBPMCavity.h>

Inheritance diagram for QwBPMCavity:

Collaboration diagram for QwBPMCavity:

Public Types
enum	ECavElements { kXElem =0 , kYElem , kQElem , kNumElements }
Public Types inherited from VQwBPM
enum	EBeamPositionMonitorAxis { kXAxis =0 , kYAxis , kNumAxes }
Public Types inherited from VQwDataElement
enum	EDataToSave { kRaw = 0 , kDerived , kMoments }

Public Member Functions
	QwBPMCavity ()
	QwBPMCavity (TString name)
	QwBPMCavity (TString subsystemname, TString name)
	QwBPMCavity (const QwBPMCavity &source)
	~QwBPMCavity () override
void	InitializeChannel (TString name)
void	InitializeChannel (TString subsystem, TString name)
void	ClearEventData () override
void	LoadChannelParameters (QwParameterFile &paramfile) override
Int_t	ProcessEvBuffer (UInt_t *buffer, UInt_t word_position_in_buffer, UInt_t indexnumber) override
void	ProcessEvent () override
void	PrintValue () const override
void	PrintInfo () const override
const VQwHardwareChannel *	GetPosition (EBeamPositionMonitorAxis axis) const override
const VQwHardwareChannel *	GetEffectiveCharge () const override
TString	GetSubElementName (Int_t subindex) override
void	GetAbsolutePosition () override
Bool_t	ApplyHWChecks ()
Bool_t	ApplySingleEventCuts () override
void	SetSingleEventCuts (TString ch_name, UInt_t errorflag, Double_t minX, Double_t maxX, 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) override
void	IncrementErrorCounters () override
void	PrintErrorCounters () const override
UInt_t	GetEventcutErrorFlag () override
UInt_t	UpdateErrorFlag () override
void	UpdateErrorFlag (const VQwBPM *ev_error) override
Bool_t	CheckForBurpFail (const VQwDataElement *ev_error) override
void	SetDefaultSampleSize (Int_t sample_size) override
void	SetRandomEventParameters (Double_t meanX, Double_t sigmaX, Double_t meanY, Double_t sigmaY) override
void	RandomizeEventData (int helicity=0, double time=0.0) override
void	SetEventData (Double_t *block, UInt_t sequencenumber)
void	EncodeEventData (std::vector< UInt_t > &buffer) override
void	SetSubElementPedestal (Int_t j, Double_t value) override
void	SetSubElementCalibrationFactor (Int_t j, Double_t value) override
void	Ratio (QwBPMCavity &numer, QwBPMCavity &denom)
void	Scale (Double_t factor) override
VQwBPM &	operator= (const VQwBPM &value) override
VQwBPM &	operator+= (const VQwBPM &value) override
VQwBPM &	operator-= (const VQwBPM &value) override
virtual QwBPMCavity &	operator= (const QwBPMCavity &value)
virtual QwBPMCavity &	operator+= (const QwBPMCavity &value)
virtual QwBPMCavity &	operator-= (const QwBPMCavity &value)
void	AccumulateRunningSum (const VQwBPM &value, Int_t count=0, Int_t ErrorMask=0xFFFFFFF) override
void	AccumulateRunningSum (const QwBPMCavity &value, Int_t count=0, Int_t ErrorMask=0xFFFFFFF)
void	DeaccumulateRunningSum (VQwBPM &value, Int_t ErrorMask=0xFFFFFFF) override
void	DeaccumulateRunningSum (QwBPMCavity &value, Int_t ErrorMask=0xFFFFFFF)
void	CalculateRunningAverage () override
void	ConstructHistograms (TDirectory *folder, TString &prefix) override
void	FillHistograms () override
void	ConstructBranchAndVector (TTree *tree, TString &prefix, QwRootTreeBranchVector &values) override
void	FillTreeVector (QwRootTreeBranchVector &values) const override
void	ConstructBranch (TTree *tree, TString &prefix) override
void	ConstructBranch (TTree *tree, TString &prefix, QwParameterFile &modulelist) override
std::vector< QwDBInterface >	GetDBEntry ()
std::vector< QwErrDBInterface >	GetErrDBEntry ()
Public Member Functions inherited from VQwBPM
	VQwBPM ()
	VQwBPM (TString &)
	VQwBPM (const VQwBPM &source)
	~VQwBPM () override
void	InitializeChannel (TString name)
	Initialize common BPM state and set the element name.
virtual void	GetProjectedPosition (VQwBPM *)
virtual size_t	GetNumberOfElements ()
virtual void	FillRawEventData ()
void	GetSurveyOffsets (Double_t Xoffset, Double_t Yoffset, Double_t Zoffset)
	Store geometry/survey offsets for absolute position calibration.
void	GetElectronicFactors (Double_t BSENfactor, Double_t AlphaX, Double_t AlphaY)
	Apply per-detector electronic calibration and relative gains.
void	SetRotation (Double_t)
	Set detector rotation angle and update cached trigonometric values.
void	SetRotationOff ()
void	SetSingleEventCuts (TString, Double_t, Double_t)
void	SetSingleEventCuts (TString, UInt_t, Double_t, Double_t, Double_t, Double_t)
void	SetGains (TString pos, Double_t value)
void	SetRootSaveStatus (TString &prefix)
Double_t	GetPositionInZ () const
virtual void	Ratio (VQwBPM &, VQwBPM &)
void	PrintErrorCounters () const override
	report number of events failed due to HW and event cut failure
virtual const VQwHardwareChannel *	GetAngleX () const
virtual const VQwHardwareChannel *	GetAngleY () const
virtual void	SetBPMForCombo (const VQwBPM *, Double_t, Double_t, Double_t, Double_t)
virtual void	SetResolution (Double_t resolutionX, Double_t resolutionY)
virtual void	SetRandomEventParameters (Double_t, Double_t, Double_t, Double_t, Double_t, Double_t, Double_t, Double_t)
virtual void	SetRandomEventAsymmetry (Double_t)
virtual void	ApplyResolutionSmearing ()
virtual void	ApplyResolutionSmearing (EBeamPositionMonitorAxis)
void	PrintInfo () const override
	Print multiple lines of information about this data element.
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.
virtual void	LoadMockDataParameters (QwParameterFile &)
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.

Static Public Member Functions
static UInt_t	GetSubElementIndex (TString subname)
static Bool_t	ParseChannelName (const TString &channel, TString &detname, TString &subname, UInt_t &localindex)
Static Public Member Functions inherited from VQwBPM
static VQwBPM *	CreateStripline (TString subsystemname, TString type, TString name)
	A fast way of creating a BPM stripline of specified type.
static VQwBPM *	CreateStripline (const VQwBPM &source)
static VQwBPM *	CreateCombo (TString subsystemname, TString type, TString name)
	A fast way of creating a BPM stripline of specified type.
static VQwBPM *	CreateCombo (const VQwBPM &source)

Protected Member Functions
VQwHardwareChannel *	GetSubelementByName (TString ch_name) override
Protected Member Functions inherited from VQwBPM
virtual VQwHardwareChannel *	GetPosition (EBeamPositionMonitorAxis axis)
VQwHardwareChannel *	GetSubelementByIndex (size_t index)
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
std::array< QwVQWK_Channel, kNumElements >	fElement
std::array< QwVQWK_Channel, kNumAxes >	fRelPos
std::array< QwVQWK_Channel, kNumAxes >	fAbsPos
Protected Attributes inherited from VQwBPM
std::vector< TString >	fSubelementNames
Double_t	fPositionCenter [3]
Double_t	fQwStriplineCalibration
Double_t	fQwStriplineCorrection
Double_t	fRelativeGains [2]
Double_t	fGains [2]
Bool_t	bRotated
Double_t	fRotationAngle
Double_t	fCosRotation
Double_t	fSinRotation
Double_t	fResolution [2]
Bool_t	fGoodEvent
Bool_t	bFullSave
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 Member Functions
void	MakeBPMCavityList ()

Private Attributes
std::vector< QwVQWK_Channel >	fBPMElementList

Static Private Attributes
static const Double_t	kQwCavityCalibration = 1.0
static const TString	subelement [kNumElements] ={"XI","YI","Q"}

Friends
template<typename TT>
class	QwCombinedBPM
class	QwEnergyCalculator

Additional Inherited Members
Static Protected Attributes inherited from VQwBPM
static const TString	kAxisLabel [2] ={"X","Y"}
static const TString	axis [3]
static const Bool_t	bDEBUG =kFALSE

Detailed Description

Cavity-style BPM using VQWK channels.

Provides X/Y position and effective charge from cavity readouts, with utilities for cuts, histograms, and tree/NTuple output.

Definition at line 38 of file QwBPMCavity.h.

Member Enumeration Documentation

ECavElements

enum QwBPMCavity::ECavElements

Enumerator
kXElem
kYElem
kQElem
kNumElements

Definition at line 43 of file QwBPMCavity.h.

{kXElem=0, kYElem, kQElem, kNumElements};

Constructor & Destructor Documentation

QwBPMCavity() [1/4]

QwBPMCavity::QwBPMCavity ( )

inline

Definition at line 48 of file QwBPMCavity.h.

{ };

Referenced by AccumulateRunningSum(), AccumulateRunningSum(), CheckForBurpFail(), DeaccumulateRunningSum(), DeaccumulateRunningSum(), operator+=(), operator+=(), operator-=(), operator-=(), operator=(), operator=(), QwBPMCavity(), Ratio(), and UpdateErrorFlag().

Here is the caller graph for this function:

QwBPMCavity() [2/4]

QwBPMCavity::QwBPMCavity ( TString name )

inline

Definition at line 49 of file QwBPMCavity.h.

                           :VQwBPM(name){
    InitializeChannel(name);
  };

References InitializeChannel(), and VQwBPM::VQwBPM().

Here is the call graph for this function:

QwBPMCavity() [3/4]

QwBPMCavity::QwBPMCavity ( TString subsystemname, TString name )

inline

Definition at line 52 of file QwBPMCavity.h.

  : VQwBPM(name) {
      SetSubsystemName(subsystemname);
      InitializeChannel(subsystemname, name);
  };

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

Here is the call graph for this function:

QwBPMCavity() [4/4]

QwBPMCavity::QwBPMCavity ( const QwBPMCavity & source )

inline

Definition at line 57 of file QwBPMCavity.h.

  : VQwBPM(source)
  {
    QwCopyArray(source.fElement, fElement);
    QwCopyArray(source.fRelPos, fRelPos);
    QwCopyArray(source.fAbsPos, fAbsPos);
  }

References fAbsPos, fElement, fRelPos, QwBPMCavity(), QwCopyArray(), and VQwBPM::VQwBPM().

Here is the call graph for this function:

~QwBPMCavity()

QwBPMCavity::~QwBPMCavity ( )

inlineoverride

Definition at line 64 of file QwBPMCavity.h.

{ };

Member Function Documentation

AccumulateRunningSum() [1/2]

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

Accumulate running sums for raw and derived channels.

Definition at line 717 of file QwBPMCavity.cc.

{
 
  size_t i = 0;
  for(i=0;i<kNumElements;i++)
    fElement[i].AccumulateRunningSum(value.fElement[i], count, ErrorMask);
  for (i = 0; i < 2; i++){
    fRelPos[i].AccumulateRunningSum(value.fRelPos[i], count, ErrorMask);
    fAbsPos[i].AccumulateRunningSum(value.fAbsPos[i], count, ErrorMask);
  }
  return;
}

References AccumulateRunningSum(), fAbsPos, fElement, fRelPos, kNumElements, and QwBPMCavity().

Here is the call graph for this function:

AccumulateRunningSum() [2/2]

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

overridevirtual

Type-erased running-sum accumulate; forwards to concrete overload.

Reimplemented from VQwBPM.

Definition at line 712 of file QwBPMCavity.cc.

                                                                                       {
  AccumulateRunningSum(*dynamic_cast<const QwBPMCavity* >(&value), count, ErrorMask);
};

References AccumulateRunningSum(), QwBPMCavity(), and VQwBPM::VQwBPM().

Referenced by AccumulateRunningSum(), and AccumulateRunningSum().

Here is the call graph for this function:

Here is the caller graph for this function:

ApplyHWChecks()

Bool_t QwBPMCavity::ApplyHWChecks

(

)

Apply hardware-level checks to each subelement and aggregate status.

Returns

true if no hardware errors are detected across all subelements.

Definition at line 158 of file QwBPMCavity.cc.

{
  Bool_t eventokay=kTRUE;
 
  UInt_t deviceerror=0;
  for(size_t i=0;i<kNumElements;i++)
    {
      deviceerror|= fElement[i].ApplyHWChecks();  //OR the error code from each wire
      eventokay &= (deviceerror & 0x0);//AND with 0 since zero means HW is good.
 
      if (bDEBUG) std::cout<<" Inconsistent within BPM terminals wire[ "<<i<<" ] "<<std::endl;
      if (bDEBUG) std::cout<<" wire[ "<<i<<" ] sequence num "<<fElement[i].GetSequenceNumber()<<" sample size "<<fElement[i].GetNumberOfSamples()<<std::endl;
    }
  return eventokay;
}

References VQwBPM::bDEBUG, fElement, and kNumElements.

Referenced by ProcessEvent().

Here is the caller graph for this function:

ApplySingleEventCuts()

Bool_t QwBPMCavity::ApplySingleEventCuts ( )

overridevirtual

Apply analysis-level single-event cuts to raw and derived quantities.

Returns

true if all configured channels pass their single-event cuts.

Implements VQwBPM.

Definition at line 246 of file QwBPMCavity.cc.

{
  Bool_t status=kTRUE;
  Int_t i=0;
  UInt_t error_code = 0;
  //Event cuts for elements
  for(i=0;i<kNumElements;i++){
    if (fElement[i].ApplySingleEventCuts()){
      status&=kTRUE;
    }
    else{
      status&=kFALSE;
      if (bDEBUG) std::cout<<" Element "<< fElement[i].GetElementName()
               << " event cut failed ";
    }
    error_code |= fElement[i].GetErrorCode();
  }
  for(i=kXAxis;i<kNumAxes;i++){
    fRelPos[i].UpdateErrorFlag(error_code);
    if (fRelPos[i].ApplySingleEventCuts()){ //for RelX
      status&=kTRUE;
    }
    else{
      status&=kFALSE;
      if (bDEBUG) std::cout<<" Rel X event cut failed ";
    }
  }
 
  for(i=kXAxis;i<kNumAxes;i++){
    fAbsPos[i].UpdateErrorFlag(error_code);
    if (fAbsPos[i].ApplySingleEventCuts()){ //for RelX
      status&=kTRUE;
    }
    else{
      status&=kFALSE;
      if (bDEBUG) std::cout<<" Abs X event cut failed ";
    }
  }
  return status;
}

References ApplySingleEventCuts(), VQwBPM::bDEBUG, fAbsPos, fElement, fRelPos, VQwBPM::kNumAxes, kNumElements, and VQwBPM::kXAxis.

Referenced by ApplySingleEventCuts().

Here is the call graph for this function:

Here is the caller graph for this function:

CalculateRunningAverage()

void QwBPMCavity::CalculateRunningAverage ( )

overridevirtual

Update per-channel running averages based on accumulated sums.

Implements VQwBPM.

Definition at line 699 of file QwBPMCavity.cc.

{
  size_t i = 0;
  for(i=0;i<kNumElements;i++)
    fElement[i].CalculateRunningAverage();
  for (i = 0; i < kNumAxes; i++){
    fRelPos[i].CalculateRunningAverage();
    fAbsPos[i].CalculateRunningAverage();
  }
  return;
}

References CalculateRunningAverage(), fAbsPos, fElement, fRelPos, VQwBPM::kNumAxes, and kNumElements.

Referenced by CalculateRunningAverage().

Here is the call graph for this function:

Here is the caller graph for this function:

CheckForBurpFail()

Bool_t QwBPMCavity::CheckForBurpFail ( const VQwDataElement * ev_error )

overridevirtual

Polymorphic burp/burst failure check against a reference element of the same concrete type. For each subelement and derived channel, delegate to its CheckForBurpFail implementation.

Parameters

ev_error

Reference data element to compare against.

Returns

true if any sub-channel reports a burp/burst failure.

Exceptions

std::invalid_argument

if ev_error is not a QwBPMCavity.

Reimplemented from VQwBPM.

Definition at line 399 of file QwBPMCavity.cc.

                                                                  {
  Short_t i=0;
  Bool_t burpstatus = kFALSE;
  try {
    if(typeid(*ev_error)==typeid(*this)) {
      //std::cout<<" Here in QwBPMCavity::CheckForBurpFail \n";
      if (this->GetElementName()!="") {
        const QwBPMCavity* value_bpm = dynamic_cast<const QwBPMCavity* >(ev_error);
        for(i=0;i<2;i++){
          burpstatus |= fElement[i].CheckForBurpFail(&(value_bpm->fElement[i]));
          burpstatus |= fRelPos[i].CheckForBurpFail(&(value_bpm->fRelPos[i]));
          burpstatus |= fAbsPos[i].CheckForBurpFail(&(value_bpm->fAbsPos[i]));
        }
        burpstatus |= fElement[kQElem].CheckForBurpFail(&(value_bpm->fElement[kQElem]));
      }
    } else {
      TString loc="Standard exception from QwBPMCavity::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 fAbsPos, fElement, fRelPos, VQwDataElement::GetElementName(), kQElem, QwBPMCavity(), and VQwDataElement::VQwDataElement().

Here is the call graph for this function:

ClearEventData()

void QwBPMCavity::ClearEventData ( )

overridevirtual

Clear all owned subelement and derived channel state for the current event.

Reimplemented from VQwDataElement.

Definition at line 139 of file QwBPMCavity.cc.

{
  size_t i=0;
 
  for(i=0;i<kNumElements;i++){
    fElement[i].ClearEventData();
  }
  for(i=0;i<kNumAxes;i++){
    fAbsPos[i].ClearEventData();
    fRelPos[i].ClearEventData();
  }
}

References fAbsPos, fElement, fRelPos, VQwBPM::kNumAxes, and kNumElements.

ConstructBranch() [1/2]

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

overridevirtual

Define TTree branches for output variables using the provided prefix. The prefix "asym_" is converted to "diff_" for positions.

Implements VQwBPM.

Definition at line 827 of file QwBPMCavity.cc.

 {
   if (GetElementName()==""){
     //  This channel is not used, so skip constructing trees.
   }
   else {
     TString thisprefix=prefix;
     if(prefix.Contains("asym_"))
       thisprefix.ReplaceAll("asym_","diff_");
     SetRootSaveStatus(prefix);
 
     fElement[kQElem].ConstructBranch(tree,prefix);
     size_t i = 0;
     for(i=kXAxis;i<kNumAxes;i++) {
       if (bFullSave) fElement[i].ConstructBranch(tree,thisprefix);
       //       fRelPos[i].ConstructBranch(tree,thisprefix);
       fAbsPos[i].ConstructBranch(tree,thisprefix);
     }
 
   }
   return;
 }

References VQwBPM::bFullSave, fAbsPos, fElement, VQwDataElement::GetElementName(), VQwBPM::kNumAxes, kQElem, VQwBPM::kXAxis, and VQwBPM::SetRootSaveStatus().

Here is the call graph for this function:

ConstructBranch() [2/2]

void QwBPMCavity::ConstructBranch ( TTree * tree, TString & prefix, QwParameterFile & modulelist )

overridevirtual

Conditionally define TTree branches based on a module list filter. Only branches present in the module list are created.

Implements VQwBPM.

Definition at line 854 of file QwBPMCavity.cc.

 {
   TString devicename;
   /*
   QwMessage <<" QwBCM::ConstructBranch "<<QwLog::endl;
   modulelist.RewindToFileStart();
   while (modulelist.ReadNextLine()){
       modulelist.TrimComment('!');   // Remove everything after a '!' character.
       modulelist.TrimWhitespace();   // Get rid of leading and trailing spaces
       QwMessage <<" "<<modulelist.GetLine()<<" ";
   }
   QwMessage <<QwLog::endl;
   */
   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(prefix);
 
       fElement[kQElem].ConstructBranch(tree,prefix);
       size_t i = 0;
       for(i=kXAxis;i<kNumAxes;i++) {
     if (bFullSave) fElement[i].ConstructBranch(tree,thisprefix);
     //  fRelPos[i].ConstructBranch(tree,thisprefix);
         fAbsPos[i].ConstructBranch(tree,thisprefix);
       }
 
       QwMessage <<" Tree leaves added to "<<devicename<<" Corresponding channels"<<QwLog::endl;
       }
       // this functions doesn't do anything yet
     }
 
 
 
 
 
   return;
 }

References VQwBPM::bFullSave, QwLog::endl(), fAbsPos, fElement, VQwDataElement::GetElementName(), QwParameterFile::HasValue(), VQwBPM::kNumAxes, kQElem, VQwBPM::kXAxis, QwMessage, and VQwBPM::SetRootSaveStatus().

Here is the call graph for this function:

ConstructBranchAndVector()

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

overridevirtual

Define TTree branches and attach backing vectors for output variables. The prefix "asym_" is converted to "diff_" for positions.

Implements VQwBPM.

Definition at line 800 of file QwBPMCavity.cc.

{
  if (GetElementName()==""){
    //  This channel is not used, so skip constructing trees.
  }
  else {
    TString thisprefix=prefix;
    if(prefix.Contains("asym_"))
      thisprefix.ReplaceAll("asym_","diff_");
    SetRootSaveStatus(prefix);
 
    fElement[kQElem].ConstructBranchAndVector(tree,prefix,values);
    size_t i = 0;
    for(i=kXAxis;i<kNumAxes;i++) {
      if (bFullSave) fElement[i].ConstructBranchAndVector(tree,thisprefix,values);
      //      fRelPos[i].ConstructBranchAndVector(tree,thisprefix,values);
      fAbsPos[i].ConstructBranchAndVector(tree,thisprefix,values);
    }
 
  }
  return;
}

References VQwBPM::bFullSave, fAbsPos, fElement, VQwDataElement::GetElementName(), VQwBPM::kNumAxes, kQElem, VQwBPM::kXAxis, and VQwBPM::SetRootSaveStatus().

Here is the call graph for this function:

ConstructHistograms()

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

overridevirtual

Define ROOT histograms for subelements and derived absolute positions. The prefix "asym_" is converted to "diff_" for positions.

Implements VQwBPM.

Definition at line 755 of file QwBPMCavity.cc.

{
 
  if (GetElementName()=="") {
    //  This channel is not used, so skip filling the histograms.
  }  else {
    fElement[kQElem].ConstructHistograms(folder, prefix);
    TString thisprefix=prefix;
 
    if(prefix.Contains("asym_"))
      thisprefix.ReplaceAll("asym_","diff_");
    SetRootSaveStatus(prefix);
    size_t i = 0;
    for(i=kXAxis;i<kNumAxes;i++) {
      if(bFullSave) fElement[i].ConstructHistograms(folder, thisprefix);
      // fRelPos[i].ConstructHistograms(folder, thisprefix);
      fAbsPos[i].ConstructHistograms(folder, thisprefix);
    }
  }
  return;
}

References VQwBPM::bFullSave, fAbsPos, fElement, VQwDataElement::GetElementName(), VQwBPM::kNumAxes, kQElem, VQwBPM::kXAxis, and VQwBPM::SetRootSaveStatus().

Here is the call graph for this function:

DeaccumulateRunningSum() [1/2]

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

Deaccumulate running sums for raw and derived channels.

Definition at line 736 of file QwBPMCavity.cc.

{
  size_t i = 0;
  for(i=0;i<kNumElements;i++)
    fElement[i].DeaccumulateRunningSum(value.fElement[i], ErrorMask);
  for (i = 0; i < kNumAxes; i++){
    fRelPos[i].DeaccumulateRunningSum(value.fRelPos[i], ErrorMask);
    fAbsPos[i].DeaccumulateRunningSum(value.fAbsPos[i], ErrorMask);
  }
  return;
}

References DeaccumulateRunningSum(), fAbsPos, fElement, fRelPos, VQwBPM::kNumAxes, kNumElements, and QwBPMCavity().

Here is the call graph for this function:

DeaccumulateRunningSum() [2/2]

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

overridevirtual

Type-erased running-sum deaccumulate; forwards to concrete overload.

Implements VQwBPM.

Definition at line 731 of file QwBPMCavity.cc.

                                                                      {
  DeaccumulateRunningSum(*dynamic_cast<QwBPMCavity* >(&value), ErrorMask);
};

References DeaccumulateRunningSum(), QwBPMCavity(), and VQwBPM::VQwBPM().

Referenced by DeaccumulateRunningSum(), and DeaccumulateRunningSum().

Here is the call graph for this function:

Here is the caller graph for this function:

EncodeEventData()

void QwBPMCavity::EncodeEventData ( std::vector< UInt_t > & buffer )

overridevirtual

Serialize raw element data into a CODA-like output buffer.

Reimplemented from VQwBPM.

Definition at line 1084 of file QwBPMCavity.cc.

{
  for (size_t i=0; i<kNumElements; i++)
    fElement[i].EncodeEventData(buffer);
}

References EncodeEventData(), fElement, and kNumElements.

Referenced by EncodeEventData().

Here is the call graph for this function:

Here is the caller graph for this function:

FillHistograms()

void QwBPMCavity::FillHistograms ( )

overridevirtual

Fill previously constructed ROOT histograms for this detector.

Implements VQwBPM.

Definition at line 778 of file QwBPMCavity.cc.

{
  if (GetElementName()=="") {
    //  This channel is not used, so skip filling the histograms.
  }
  else {
    fElement[kQElem].FillHistograms();
    size_t i = 0;
    for(i=kXAxis;i<kNumAxes;i++){
      if (bFullSave) fElement[i].FillHistograms();
      //      fRelPos[i].FillHistograms();
      fAbsPos[i].FillHistograms();
    }
    //No data for z position
  }
  return;
}

References VQwBPM::bFullSave, fAbsPos, fElement, VQwDataElement::GetElementName(), VQwBPM::kNumAxes, kQElem, and VQwBPM::kXAxis.

Here is the call graph for this function:

FillTreeVector()

void QwBPMCavity::FillTreeVector ( QwRootTreeBranchVector & values ) const

overridevirtual

Append this detector's values to the provided output vector.

Implements VQwBPM.

Definition at line 901 of file QwBPMCavity.cc.

{
  if (GetElementName()=="") {
    //  This channel is not used, so skip filling the tree.
  }
  else {
    fElement[kQElem].FillTreeVector(values);
    size_t i = 0;
    for(i=kXAxis;i<kNumAxes;i++){
      if (bFullSave) fElement[i].FillTreeVector(values);
      //      fRelPos[i].FillTreeVector(values);
      fAbsPos[i].FillTreeVector(values);
    }
  }
  return;
}

References VQwBPM::bFullSave, fAbsPos, fElement, VQwDataElement::GetElementName(), VQwBPM::kNumAxes, kQElem, and VQwBPM::kXAxis.

Here is the call graph for this function:

GetAbsolutePosition()

void QwBPMCavity::GetAbsolutePosition ( )

overridevirtual

Recompute absolute positions from raw elements and stored offsets. Intended for use after externally setting raw subelements.

Reimplemented from VQwBPM.

Definition at line 573 of file QwBPMCavity.cc.

{
  for(size_t i=0;i<kNumAxes;i++){
    fRelPos[i].Ratio(fElement[i],fElement[kQElem]);
    fAbsPos[i]= fRelPos[i];
    fAbsPos[i].AddChannelOffset(fPositionCenter[i]);
  }
  // For Z, the absolute position will be the offset we are reading from the
  // geometry map file. Since we are not putting that to the tree it is not
  // treated as a vqwk channel.
}

References fAbsPos, fElement, VQwBPM::fPositionCenter, fRelPos, VQwBPM::kNumAxes, and kQElem.

GetDBEntry()

std::vector< QwDBInterface > QwBPMCavity::GetDBEntry

(

)

GetEffectiveCharge()

const VQwHardwareChannel * QwBPMCavity::GetEffectiveCharge ( ) const

inlineoverridevirtual

Implements VQwBPM.

Definition at line 90 of file QwBPMCavity.h.

{return &fElement[kQElem];}

References fElement, and kQElem.

GetErrDBEntry()

std::vector< QwErrDBInterface > QwBPMCavity::GetErrDBEntry

(

)

GetEventcutErrorFlag()

UInt_t QwBPMCavity::GetEventcutErrorFlag ( )

overridevirtual

Return the OR of per-channel event-cut error flags for this detector. This includes raw elements, relative and absolute positions.

Reimplemented from VQwDataElement.

Definition at line 205 of file QwBPMCavity.cc.

{
  size_t i=0;
  UInt_t error=0;
  for(i=0;i<kNumElements;i++) {
    error|=fElement[i].GetEventcutErrorFlag();
  }
  for(i=0;i<kNumAxes;i++){
    error|=fRelPos[i].GetEventcutErrorFlag();
    error|=fAbsPos[i].GetEventcutErrorFlag();
  }
  return error;
}

References fAbsPos, fElement, fRelPos, VQwBPM::kNumAxes, and kNumElements.

GetPosition()

const VQwHardwareChannel * QwBPMCavity::GetPosition ( EBeamPositionMonitorAxis axis ) const

inlineoverridevirtual

Reimplemented from VQwBPM.

Definition at line 82 of file QwBPMCavity.h.

                                                                                      {
    if (axis<0 || axis>2){
      TString loc="QwBPMCavity::GetPosition for "
        +this->GetElementName()+" failed for axis value "+Form("%d",axis);
      throw std::out_of_range(loc.Data());
    }
    return &fAbsPos[axis];
  }

References VQwBPM::axis, fAbsPos, and VQwDataElement::GetElementName().

Here is the call graph for this function:

GetSubelementByName()

VQwHardwareChannel * QwBPMCavity::GetSubelementByName ( TString ch_name )

overrideprotectedvirtual

Map a human-readable subelement name to the corresponding channel. Valid names include: relx, rely, absx/x, absy/y, effectivecharge/charge/q, as well as xi/yi to access raw elements.

Exceptions

std::invalid_argument

on an unrecognized subelement request.

Implements VQwBPM.

Definition at line 294 of file QwBPMCavity.cc.

{
  VQwHardwareChannel* tmpptr = NULL;
  ch_name.ToLower();
  if (ch_name=="relx"){
    tmpptr = &fRelPos[0];
  }else if (ch_name=="rely"){
    tmpptr = &fRelPos[1];
  }else if (ch_name=="absx" || ch_name=="x" ){
    tmpptr = &fAbsPos[0];
  }else if (ch_name=="absy" || ch_name=="y"){
    tmpptr = &fAbsPos[1];
  }else if (ch_name=="effectivecharge" || ch_name=="charge" || ch_name=="q"){
    tmpptr = &fElement[kQElem];
  } else {
    TString loc="QwLinearDiodeArray::GetSubelementByName for"
      + this->GetElementName() + " was passed "
      + ch_name + ", which is an unrecognized subelement name.";
    throw std::invalid_argument(loc.Data());
  }
  return tmpptr;
}

References fAbsPos, fElement, fRelPos, VQwDataElement::GetElementName(), and kQElem.

Here is the call graph for this function:

GetSubElementIndex()

UInt_t QwBPMCavity::GetSubElementIndex ( TString subname )

static

Convert a subelement tag (XI, YI, Q) into an enum index.

Definition at line 555 of file QwBPMCavity.cc.

{
  subname.ToUpper();
  UInt_t localindex=kInvalidSubelementIndex;
  for(size_t i=0;i<kNumElements;i++)
    if(subname==subelement[i])localindex=i;
 
  if(localindex==kInvalidSubelementIndex)
    std::cerr << "QwBPMCavity::GetSubElementIndex is unable to associate the string -"
          <<subname<<"- to any index"<<std::endl;
 
  return localindex;
}

References kInvalidSubelementIndex, kNumElements, and subelement.

GetSubElementName()

TString QwBPMCavity::GetSubElementName ( Int_t subindex )

overridevirtual

Return the element name for a given raw subelement index.

Parameters

subindex

Index into the raw elements array.

Returns

Element name; logs an error and returns empty on invalid index.

Reimplemented from VQwBPM.

Definition at line 543 of file QwBPMCavity.cc.

{
  TString thisname;
  if(subindex<kNumElements&&subindex>-1)
    thisname=fElement[subindex].GetElementName();
  else
    std::cerr<<"QwBPMCavity::GetSubElementName for "<<
      GetElementName()<<" this subindex doesn't exists \n";
  return thisname;
}

References fElement, and VQwDataElement::GetElementName().

Here is the call graph for this function:

IncrementErrorCounters()

void QwBPMCavity::IncrementErrorCounters ( )

overridevirtual

Increment persistent error counters across subelements and derived channels.

Implements VQwBPM.

Definition at line 175 of file QwBPMCavity.cc.

{
  size_t i=0;
 
  for(i=0;i<kNumElements;i++){
    fElement[i].IncrementErrorCounters();
  }
  for(i=0;i<kNumAxes;i++){
    fRelPos[i].IncrementErrorCounters();
    fAbsPos[i].IncrementErrorCounters();
  }
}

References fAbsPos, fElement, fRelPos, VQwBPM::kNumAxes, and kNumElements.

InitializeChannel() [1/2]

void QwBPMCavity::InitializeChannel

(

TString

name

)

Initialize channels and derived quantities using a simple name. Creates three raw hardware channels (XI, YI, Q) and two derived channels for relative and absolute positions along each transverse axis.

Parameters

name	Detector base name.

Definition at line 84 of file QwBPMCavity.cc.

{
  size_t i=0;
  Bool_t localdebug = kFALSE;
 
  VQwBPM::InitializeChannel(name);
 
  for(i=0;i<kNumElements;i++) {
    fElement[i].InitializeChannel(name+subelement[i],"raw");
    if(localdebug)
      std::cout<<" Wire ["<<i<<"]="<<fElement[i].GetElementName()<<"\n";
  }
 
  for(i=kXAxis;i<kNumAxes;i++){
    fRelPos[i].InitializeChannel(name+"Rel"+subelement[i],"derived");
    fAbsPos[i].InitializeChannel(name+kAxisLabel[i],"derived");
  }
 
  bFullSave=kTRUE;
 
  return;
}

References VQwBPM::bFullSave, fAbsPos, fElement, fRelPos, VQwBPM::InitializeChannel(), VQwBPM::kAxisLabel, VQwBPM::kNumAxes, kNumElements, VQwBPM::kXAxis, and subelement.

Referenced by QwBPMCavity(), and QwBPMCavity().

Here is the call graph for this function:

Here is the caller graph for this function:

InitializeChannel() [2/2]

void QwBPMCavity::InitializeChannel	(	TString	subsystem,
		TString	name )

Initialize channels with explicit subsystem and detector name. This variant forwards subsystem information down to subelements so that output branches and histograms carry proper scoping.

Parameters

subsystem	Subsystem name.
name	Detector base name.

Definition at line 115 of file QwBPMCavity.cc.

{
  size_t i=0;
  Bool_t localdebug = kFALSE;
  
  VQwBPM::InitializeChannel(name);
  
  for(i=0;i<kNumElements;i++) {
    fElement[i].InitializeChannel(subsystem, "QwBPMCavity", name+subelement[i],"raw");
    if(localdebug)
      std::cout<<" Wire ["<<i<<"]="<<fElement[i].GetElementName()<<"\n";
  }
  
  for(i=kXAxis;i<kNumAxes;i++){
    fRelPos[i].InitializeChannel(subsystem, "QwBPMCavity", name+"Rel"+subelement[i],"derived");
    fAbsPos[i].InitializeChannel(subsystem, "QwBPMCavity", name+kAxisLabel[i],"derived");
  }
  
  bFullSave=kTRUE;
  
  return;
}

References VQwBPM::bFullSave, fAbsPos, fElement, fRelPos, VQwBPM::InitializeChannel(), VQwBPM::kAxisLabel, VQwBPM::kNumAxes, kNumElements, VQwBPM::kXAxis, and subelement.

Here is the call graph for this function:

LoadChannelParameters()

void QwBPMCavity::LoadChannelParameters ( QwParameterFile & paramfile )

inlineoverridevirtual

Implements VQwBPM.

Definition at line 71 of file QwBPMCavity.h.

                                                                 {
    for(Short_t i=0;i<kNumElements;i++)
      fElement[i].LoadChannelParameters(paramfile);
  }

References fElement, kNumElements, and LoadChannelParameters().

Referenced by LoadChannelParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

MakeBPMCavityList()

void QwBPMCavity::MakeBPMCavityList ( )

private

Build a flat list of representative channels for legacy consumers.

Definition at line 981 of file QwBPMCavity.cc.

{
  for (size_t i = kXAxis; i < kNumAxes; i++) {
    QwVQWK_Channel relpos(fRelPos[i]);
    relpos = fRelPos[i];
    fBPMElementList.push_back(relpos);
  }
  QwVQWK_Channel effectivecharge(fElement[kQElem]);
  effectivecharge = fElement[kQElem];
  fBPMElementList.push_back(effectivecharge);
}

References fBPMElementList, fElement, fRelPos, VQwBPM::kNumAxes, kQElem, and VQwBPM::kXAxis.

operator+=() [1/2]

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

virtual

Element-wise addition of raw and derived channels.

Definition at line 614 of file QwBPMCavity.cc.

{
 
  if (GetElementName()!=""){
    size_t i = 0;
    for(i=0;i<kNumElements;i++) {
      this->fElement[i]+=value.fElement[i];
    }
    for(i=0;i<kNumAxes;i++){
      this->fRelPos[i]+=value.fRelPos[i];
      this->fAbsPos[i]+=value.fAbsPos[i];
    }
  }
  return *this;
}

References fAbsPos, fElement, fRelPos, VQwDataElement::GetElementName(), VQwBPM::kNumAxes, kNumElements, and QwBPMCavity().

Here is the call graph for this function:

operator+=() [2/2]

VQwBPM & QwBPMCavity::operator+= ( const VQwBPM & value )

overridevirtual

Type-erased addition; forwards to the concrete operator+=.

Implements VQwBPM.

Definition at line 631 of file QwBPMCavity.cc.

{
  *(dynamic_cast<QwBPMCavity*>(this)) +=
      *(dynamic_cast<const QwBPMCavity*>(&value));
  return *this;
}

References QwBPMCavity(), and VQwBPM::VQwBPM().

Here is the call graph for this function:

operator-=() [1/2]

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

virtual

Element-wise subtraction of raw and derived channels.

Definition at line 641 of file QwBPMCavity.cc.

{
 
  if (GetElementName()!=""){
    size_t i = 0;
    for(i=0;i<kNumElements;i++) {
      this->fElement[i]-=value.fElement[i];
    }
    for(i=0;i<kNumAxes;i++){
      this->fRelPos[i]-=value.fRelPos[i];
      this->fAbsPos[i]-=value.fAbsPos[i];
    }
  }
  return *this;
}

References fAbsPos, fElement, fRelPos, VQwDataElement::GetElementName(), VQwBPM::kNumAxes, kNumElements, and QwBPMCavity().

Here is the call graph for this function:

operator-=() [2/2]

VQwBPM & QwBPMCavity::operator-= ( const VQwBPM & value )

overridevirtual

Type-erased subtraction; forwards to the concrete operator-=.

Implements VQwBPM.

Definition at line 658 of file QwBPMCavity.cc.

{
  *(dynamic_cast<QwBPMCavity*>(this)) -=
      *(dynamic_cast<const QwBPMCavity*>(&value));
  return *this;
}

References QwBPMCavity(), and VQwBPM::VQwBPM().

Here is the call graph for this function:

operator=() [1/2]

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

virtual

Concrete assignment; copies raw elements and derived channels.

Definition at line 595 of file QwBPMCavity.cc.

{
  VQwBPM::operator= (value);
 
  if (GetElementName()!=""){
    size_t i = 0;
    for(i=0;i<kNumElements;i++) {
      this->fElement[i]=value.fElement[i];
    }
    for(i=0;i<kNumAxes;i++){
      this->fRelPos[i]=value.fRelPos[i];
      this->fAbsPos[i]=value.fAbsPos[i];
    }
  }
  return *this;
}

References fAbsPos, fElement, fRelPos, VQwDataElement::GetElementName(), VQwBPM::kNumAxes, kNumElements, VQwBPM::operator=(), and QwBPMCavity().

Here is the call graph for this function:

operator=() [2/2]

VQwBPM & QwBPMCavity::operator= ( const VQwBPM & value )

overridevirtual

Type-erased assignment; forwards to the concrete operator=.

Implements VQwBPM.

Definition at line 587 of file QwBPMCavity.cc.

{
  *(dynamic_cast<QwBPMCavity*>(this)) =
      *(dynamic_cast<const QwBPMCavity*>(&value));
  return *this;
}

References QwBPMCavity(), and VQwBPM::VQwBPM().

Here is the call graph for this function:

ParseChannelName()

Bool_t QwBPMCavity::ParseChannelName ( const TString & channel, TString & detname, TString & subname, UInt_t & localindex )

static

Decode a fully qualified channel name into detector and subelement parts.

Parameters

channel	Full channel name (e.g. "bpm3iXI").
detname	Out-parameter set to the detector base name.
subname	Out-parameter set to the recognized subelement tag.
localindex	Out-parameter set to the subelement enum index or kInvalidSubelementIndex on failure.

Returns

true if a valid subelement suffix is recognized; false otherwise.

Definition at line 47 of file QwBPMCavity.cc.

{
  localindex=kInvalidSubelementIndex;
  //QwMessage << "Channel Name: " << channel << QwLog::endl;
  for(size_t i=0;i<kNumElements;i++){
    if(channel.EndsWith(subelement[i],TString::kIgnoreCase)){
      localindex=i;
      subname = subelement[i];
      size_t detnamesize = channel.Sizeof() - subname.Sizeof();
      detname = channel(0,detnamesize);
      break;
    }
  }
 
  //QwMessage << "Detector Name: " << detname << QwLog::endl;
  //QwMessage << "Sub Name: " << subname << QwLog::endl;
 
  if(localindex==kInvalidSubelementIndex){
    detname = "";
    subname = "";
    QwWarning << "QwBPMCavity::GetSubElementIndex is unable to associate the string -"
          <<subname<<"- to any index" << QwLog::endl;
  }
  return (localindex!=kInvalidSubelementIndex);
}

References QwLog::endl(), kInvalidSubelementIndex, kNumElements, QwWarning, and subelement.

Referenced by QwBeamDetectorID::QwBeamDetectorID().

Here is the call graph for this function:

Here is the caller graph for this function:

PrintErrorCounters()

void QwBPMCavity::PrintErrorCounters ( ) const

overridevirtual

Print persistent error counter summaries for diagnostics.

Reimplemented from VQwDataElement.

Definition at line 189 of file QwBPMCavity.cc.

{
  size_t i=0;
  for(i=0;i<kNumElements;i++) {
    fElement[i].PrintErrorCounters();
  }
  for(i=0;i<kNumAxes;i++){
    //    fRelPos[i].PrintErrorCounters();
    fAbsPos[i].PrintErrorCounters();
  }
}

References fAbsPos, fElement, VQwBPM::kNumAxes, and kNumElements.

PrintInfo()

void QwBPMCavity::PrintInfo ( ) const

overridevirtual

Print a description of the raw and absolute position channels.

Reimplemented from VQwDataElement.

Definition at line 524 of file QwBPMCavity.cc.

{
  size_t i = 0;
  for (i = 0; i < kNumElements; i++) {
    fElement[i].PrintInfo();
  }
  for(i=0;i<kNumAxes;i++){
    //    fRelPos[i].PrintInfo();
    fAbsPos[i].PrintInfo();
  }
}

References fAbsPos, fElement, VQwBPM::kNumAxes, and kNumElements.

PrintValue()

void QwBPMCavity::PrintValue ( ) const

overridevirtual

Print the current values of raw and absolute position channels.

Reimplemented from VQwDataElement.

Definition at line 512 of file QwBPMCavity.cc.

{
  for (size_t i = 0; i < kNumElements; i++) {
    fElement[i].PrintValue();
  }
  for (size_t i=0;i<kNumAxes;i++){
    //    fRelPos[i].PrintValue();
    fAbsPos[i].PrintValue();
  }
}

References fAbsPos, fElement, VQwBPM::kNumAxes, and kNumElements.

ProcessEvBuffer()

Int_t QwBPMCavity::ProcessEvBuffer ( UInt_t * buffer, UInt_t word_position_in_buffer, UInt_t index )

overridevirtual

Decode and route a raw data buffer into the requested subelement.

Parameters

buffer	CODA/raw buffer pointer.
word_position_in_buffer	Starting word index to parse.
index	Target subelement index (0..kNumElements-1).

Returns

The original word_position_in_buffer (legacy behavior).

Implements VQwDataElement.

Definition at line 497 of file QwBPMCavity.cc.

{
  if(index<kNumElements) {
    fElement[index].ProcessEvBuffer(buffer,word_position_in_buffer);
  }
  else {
    std::cerr <<
      "QwBPMCavity::ProcessEvBuffer(): attempt to fill in raw date for a wire that doesn't exist \n";
  }
  return word_position_in_buffer;
}

References fElement, and kNumElements.

ProcessEvent()

void QwBPMCavity::ProcessEvent ( )

overridevirtual

Process the current event by first applying hardware checks and then computing relative and absolute positions from raw subelements.

First apply HW checks and update HW error flags. Calling this routine here and not in ApplySingleEventCuts
makes a difference for a BPMs because they have derived devices.

Implements VQwBPM.

Definition at line 465 of file QwBPMCavity.cc.

{
  size_t i = 0;
 
  ApplyHWChecks();
  /**First apply HW checks and update HW  error flags. 
     Calling this routine here and not in ApplySingleEventCuts  
     makes a difference for a BPMs because they have derived devices.
  */
  for(i=0;i<kNumElements;i++) {
    fElement[i].ProcessEvent();
  }
 
  for(i=kXAxis;i<kNumAxes;i++){
    fRelPos[i].Ratio(fElement[i],fElement[kQElem]);
    fRelPos[i].Scale(kQwCavityCalibration);
    fAbsPos[i]= fRelPos[i];
    fAbsPos[i].AddChannelOffset(fPositionCenter[i]);
  }
 
  return;
}

References ApplyHWChecks(), fAbsPos, fElement, VQwBPM::fPositionCenter, fRelPos, VQwBPM::kNumAxes, kNumElements, kQElem, kQwCavityCalibration, and VQwBPM::kXAxis.

Here is the call graph for this function:

RandomizeEventData()

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

overridevirtual

Generate random event data in owned raw elements for mock runs.

Reimplemented from VQwBPM.

Definition at line 1063 of file QwBPMCavity.cc.

{
  for (size_t i=0; i<kNumElements; i++) fElement[i].RandomizeEventData(helicity, time);
 
  return;
}

References fElement, kNumElements, and RandomizeEventData().

Referenced by RandomizeEventData().

Here is the call graph for this function:

Here is the caller graph for this function:

Ratio()

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

Special ratio behavior for cavity BPMs when forming asymmetries. Only the effective charge channel participates; transverse positions are kept as differences (consistent with stripline BPM behavior).

Definition at line 672 of file QwBPMCavity.cc.

{
  // this function is called when forming asymmetries. In this case what we actually want for the
  // stripline is the difference only not the asymmetries
 
  *this=numer;
  this->fElement[kQElem].Ratio(numer.fElement[kQElem],denom.fElement[kQElem]);
  return;
}

References fElement, kQElem, and QwBPMCavity().

Here is the call graph for this function:

Scale()

void QwBPMCavity::Scale ( Double_t factor )

overridevirtual

Scale all raw and derived channels by a common factor.

Reimplemented from VQwBPM.

Definition at line 685 of file QwBPMCavity.cc.

{
  for(size_t i=0;i<kNumElements;i++){
    fElement[i].Scale(factor);
  }
  for(size_t i=0;i<kNumAxes;i++){
    fRelPos[i].Scale(factor);
    fAbsPos[i].Scale(factor);
  }
  return;
}

References fAbsPos, fElement, fRelPos, VQwBPM::kNumAxes, and kNumElements.

SetDefaultSampleSize()

void QwBPMCavity::SetDefaultSampleSize ( Int_t sample_size )

overridevirtual

Set the default sample size for all raw subelements.

Reimplemented from VQwBPM.

Definition at line 1092 of file QwBPMCavity.cc.

{
  for(size_t i=0;i<kNumElements;i++)
    fElement[i].SetDefaultSampleSize((size_t)sample_size);
}

References fElement, kNumElements, and SetDefaultSampleSize().

Referenced by SetDefaultSampleSize().

Here is the call graph for this function:

Here is the caller graph for this function:

SetEventCutMode()

void QwBPMCavity::SetEventCutMode ( Int_t bcuts )

overridevirtual

Propagate event-cut mode bitmask to all owned subchannels.

Implements VQwBPM.

Definition at line 966 of file QwBPMCavity.cc.

{
  size_t i = 0;
  //  bEVENTCUTMODE=bcuts;
  for (i=0;i<kNumElements;i++) {
    fElement[i].SetEventCutMode(bcuts);
  }
  for(i=0;i<kNumAxes;i++){
    fRelPos[i].SetEventCutMode(bcuts);
    fAbsPos[i].SetEventCutMode(bcuts);
  }
}

References fAbsPos, fElement, fRelPos, VQwBPM::kNumAxes, and kNumElements.

SetEventData()

void QwBPMCavity::SetEventData	(	Double_t *	relpos,
		UInt_t	sequencenumber )

Set relative position hardware sums and sequence numbers directly.

Definition at line 1072 of file QwBPMCavity.cc.

{
  for (size_t i=0; i<kNumElements; i++)
    {
      fRelPos[i].SetHardwareSum(relpos[i], sequencenumber);
    }
 
  return;
}

References fRelPos, and kNumElements.

SetRandomEventParameters()

void QwBPMCavity::SetRandomEventParameters ( Double_t meanX, Double_t sigmaX, Double_t meanY, Double_t sigmaY )

overridevirtual

Configure mock-data generation parameters for testing. Currently a placeholder for cavity-specific randomization strategies.

Reimplemented from VQwBPM.

Definition at line 1028 of file QwBPMCavity.cc.

{
  // Average values of the signals in the stripline ADCs
  //Double_t sumX = 1.1e8; // These are just guesses, but I made X and Y different
  //Double_t sumY = 0.9e8; // to make it more interesting for the analyzer...
 
  // Rotate the requested position if necessary (this is not tested yet)
  /* if (bRotated) {
    Double_t rotated_meanX = (meanX + meanY) / kRotationCorrection;
    Double_t rotated_meanY = (meanX - meanY) / kRotationCorrection;
    meanX = rotated_meanX;
    meanY = rotated_meanY;
    }*/
 
  // Determine the asymmetry from the position
  //Double_t meanXP = (1.0 + meanX / kQwCavityCalibration) * sumX / 2.0;
  //Double_t meanXM = (1.0 - meanX / kQwCavityCalibration) * sumX / 2.0; // = sumX - meanXP;
  //Double_t meanYP = (1.0 + meanY / kQwCavityCalibration) * sumY / 2.0;
  //Double_t meanYM = (1.0 - meanY / kQwCavityCalibration) * sumY / 2.0; // = sumY - meanYP;
 
  // Determine the spread of the asymmetry (this is not tested yet)
  // (negative sigma should work in the QwVQWK_Channel, but still using fabs)
  //Double_t sigmaXP = fabs(sumX * sigmaX / meanX);
  //Double_t sigmaXM = sigmaXP;
  //Double_t sigmaYP = fabs(sumY * sigmaY / meanY);
  //Double_t sigmaYM = sigmaYP;
 
  // Propagate these parameters to the ADCs
  //fElement[0].SetRandomEventParameters(meanXP, sigmaXM);
  //fElement[1].SetRandomEventParameters(meanXM, sigmaYM);
  //fElement[2].SetRandomEventParameters(meanYP, sigmaYP);
}

SetSingleEventCuts()

void QwBPMCavity::SetSingleEventCuts	(	TString	ch_name,
		UInt_t	errorflag,
		Double_t	minX,
		Double_t	maxX,
		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.

Configure single-event cuts for one subelement by name.

Parameters

ch_name	Subchannel selector (e.g. relx, rely, absx, absy, effectivecharge, xi, yi).
errorflag	Error mask bit(s) to associate with failures.
minX	Lower limit for the channel value.
maxX	Upper limit for the channel value.
stability	Allowed fractional stability (implementation-specific).
burplevel	Threshold for burp/burst detection (implementation-specific).

Definition at line 356 of file QwBPMCavity.cc.

                                                                                                                                          {
  errorflag|=kBPMErrorFlag;//update the device flag
  if (ch_name=="relx"){
    QwMessage<<"RelX LL " <<  minX <<" UL " << maxX <<QwLog::endl;
     fRelPos[0].SetSingleEventCuts(errorflag,minX,maxX,stability,burplevel); 
 
  }else if (ch_name=="rely"){
    QwMessage<<"RelY LL " <<  minX <<" UL " << maxX <<QwLog::endl;
    fRelPos[1].SetSingleEventCuts(errorflag,minX,maxX,stability,burplevel); 
 
  } else  if (ch_name=="absx"){
    QwMessage<<"AbsX LL " <<  minX <<" UL " << maxX <<QwLog::endl;
    fAbsPos[0].SetSingleEventCuts(errorflag,minX,maxX,stability,burplevel); 
 
  }else if (ch_name=="absy"){
    QwMessage<<"AbsY LL " <<  minX <<" UL " << maxX <<QwLog::endl;
    fAbsPos[1].SetSingleEventCuts(errorflag,minX,maxX,stability,burplevel);
 
  }else if (ch_name=="effectivecharge"){
    QwMessage<<"EffectveQ LL " <<  minX <<" UL " << maxX <<QwLog::endl;
    fElement[kQElem].SetSingleEventCuts(errorflag,minX,maxX,stability,burplevel);
 
  }else if (ch_name=="xi"){
    QwMessage<<"XI " <<  minX <<" UL " << maxX <<QwLog::endl;
    fElement[0].SetSingleEventCuts(errorflag,minX,maxX,stability,burplevel);
 
  }else if (ch_name=="yi"){
    QwMessage<<"YI " <<  minX <<" UL " << maxX <<QwLog::endl;
    fElement[1].SetSingleEventCuts(errorflag,minX,maxX,stability,burplevel);
 
  }
 
}

References QwLog::endl(), fAbsPos, fElement, fRelPos, kBPMErrorFlag, kQElem, and QwMessage.

Here is the call graph for this function:

SetSubElementCalibrationFactor()

void QwBPMCavity::SetSubElementCalibrationFactor ( Int_t j, Double_t value )

overridevirtual

Set the calibration factor for a specific raw subelement.

Reimplemented from VQwBPM.

Definition at line 1106 of file QwBPMCavity.cc.

{
  fElement[j].SetCalibrationFactor(value);
}

References fElement.

SetSubElementPedestal()

void QwBPMCavity::SetSubElementPedestal ( Int_t j, Double_t value )

overridevirtual

Set the pedestal for a specific raw subelement.

Reimplemented from VQwBPM.

Definition at line 1100 of file QwBPMCavity.cc.

{
  fElement[j].SetPedestal(value);
}

References fElement.

UpdateErrorFlag() [1/2]

UInt_t QwBPMCavity::UpdateErrorFlag ( )

overridevirtual

Update derived channel error flags based on raw element error codes and return the aggregated event-cut error mask.

Implements VQwBPM.

Definition at line 223 of file QwBPMCavity.cc.

{
  size_t i=0;
  UInt_t error1=0;
  UInt_t error2=0;  
  for(i=0;i<kNumElements;i++) {
    error1|=fElement[i].GetErrorCode();
    error2|=fElement[i].GetEventcutErrorFlag();
  }
  for(i=kXAxis;i<kNumAxes;i++) {
    fRelPos[i].UpdateErrorFlag(error1);
    fAbsPos[i].UpdateErrorFlag(error1);
    error2|=fRelPos[i].GetEventcutErrorFlag();
    error2|=fAbsPos[i].GetEventcutErrorFlag();
  }
  return error2;
}

References fAbsPos, fElement, fRelPos, VQwBPM::kNumAxes, kNumElements, and VQwBPM::kXAxis.

UpdateErrorFlag() [2/2]

void QwBPMCavity::UpdateErrorFlag ( const VQwBPM * ev_error )

overridevirtual

Update error flags by copying flags from a reference BPM of the same concrete type. This is used to propagate error state across containers.

Parameters

ev_error

Reference BPM (must be QwBPMCavity).

Exceptions

std::invalid_argument

if ev_error is not a QwBPMCavity.

Implements VQwBPM.

Definition at line 433 of file QwBPMCavity.cc.

                                                       {
  size_t i=0;
  try {
    if(typeid(*ev_error)==typeid(*this)) {
      // std::cout<<" Here in QwBPMStripline::UpdateErrorFlag \n";
      if (this->GetElementName()!="") {
        const QwBPMCavity* value_bpm = dynamic_cast<const QwBPMCavity* >(ev_error);
    for(i=0;i<kNumElements;i++){
      fElement[i].UpdateErrorFlag(value_bpm->fElement[i]);
    }
    for(i=kXAxis;i<kNumAxes;i++) {
      fRelPos[i].UpdateErrorFlag(value_bpm->fRelPos[i]);
      fAbsPos[i].UpdateErrorFlag(value_bpm->fAbsPos[i]);
    }
      }
    } else {
      TString loc="Standard exception from QwBPMCavity::UpdateErrorFlag :"+
        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;
  }   
};

References fAbsPos, fElement, fRelPos, VQwDataElement::GetElementName(), VQwBPM::kNumAxes, kNumElements, VQwBPM::kXAxis, QwBPMCavity(), and VQwBPM::VQwBPM().

Here is the call graph for this function:

Friends And Related Symbol Documentation

QwCombinedBPM

template<typename TT>

friend class QwCombinedBPM

friend

Definition at line 39 of file QwBPMCavity.h.

References QwCombinedBPM.

Referenced by QwCombinedBPM.

QwEnergyCalculator

friend class QwEnergyCalculator

friend

Definition at line 40 of file QwBPMCavity.h.

References QwEnergyCalculator.

Referenced by QwEnergyCalculator.

Field Documentation

fAbsPos

std::array<QwVQWK_Channel,kNumAxes> QwBPMCavity::fAbsPos

protected

Definition at line 167 of file QwBPMCavity.h.

Referenced by AccumulateRunningSum(), ApplySingleEventCuts(), CalculateRunningAverage(), CheckForBurpFail(), ClearEventData(), ConstructBranch(), ConstructBranch(), ConstructBranchAndVector(), ConstructHistograms(), DeaccumulateRunningSum(), FillHistograms(), FillTreeVector(), GetAbsolutePosition(), GetEventcutErrorFlag(), GetPosition(), GetSubelementByName(), IncrementErrorCounters(), InitializeChannel(), InitializeChannel(), operator+=(), operator-=(), operator=(), PrintErrorCounters(), PrintInfo(), PrintValue(), ProcessEvent(), QwBPMCavity(), Scale(), SetEventCutMode(), SetSingleEventCuts(), UpdateErrorFlag(), and UpdateErrorFlag().

fBPMElementList

std::vector<QwVQWK_Channel> QwBPMCavity::fBPMElementList

private

Definition at line 173 of file QwBPMCavity.h.

Referenced by MakeBPMCavityList().

fElement

std::array<QwVQWK_Channel,kNumElements> QwBPMCavity::fElement

protected

Definition at line 162 of file QwBPMCavity.h.

Referenced by AccumulateRunningSum(), ApplyHWChecks(), ApplySingleEventCuts(), CalculateRunningAverage(), CheckForBurpFail(), ClearEventData(), ConstructBranch(), ConstructBranch(), ConstructBranchAndVector(), ConstructHistograms(), DeaccumulateRunningSum(), EncodeEventData(), FillHistograms(), FillTreeVector(), GetAbsolutePosition(), GetEffectiveCharge(), GetEventcutErrorFlag(), GetSubelementByName(), GetSubElementName(), IncrementErrorCounters(), InitializeChannel(), InitializeChannel(), LoadChannelParameters(), MakeBPMCavityList(), operator+=(), operator-=(), operator=(), PrintErrorCounters(), PrintInfo(), PrintValue(), ProcessEvBuffer(), ProcessEvent(), QwBPMCavity(), RandomizeEventData(), Ratio(), Scale(), SetDefaultSampleSize(), SetEventCutMode(), SetSingleEventCuts(), SetSubElementCalibrationFactor(), SetSubElementPedestal(), UpdateErrorFlag(), and UpdateErrorFlag().

fRelPos

std::array<QwVQWK_Channel,kNumAxes> QwBPMCavity::fRelPos

protected

Definition at line 163 of file QwBPMCavity.h.

Referenced by AccumulateRunningSum(), ApplySingleEventCuts(), CalculateRunningAverage(), CheckForBurpFail(), ClearEventData(), DeaccumulateRunningSum(), GetAbsolutePosition(), GetEventcutErrorFlag(), GetSubelementByName(), IncrementErrorCounters(), InitializeChannel(), InitializeChannel(), MakeBPMCavityList(), operator+=(), operator-=(), operator=(), ProcessEvent(), QwBPMCavity(), Scale(), SetEventCutMode(), SetEventData(), SetSingleEventCuts(), UpdateErrorFlag(), and UpdateErrorFlag().

kQwCavityCalibration

const Double_t QwBPMCavity::kQwCavityCalibration = 1.0

staticprivate

Definition at line 156 of file QwBPMCavity.h.

Referenced by ProcessEvent().

subelement

const TString QwBPMCavity::subelement ={"XI","YI","Q"}

staticprivate

Definition at line 34 of file QwBPMCavity.h.

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

---

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

• QwBPMCavity.h
• QwBPMCavity.cc