Ring buffer of subsystem snapshots for burp/stability handling. More...

#include <QwEventRing.h>

Collaboration diagram for QwEventRing:

Public Member Functions
	QwEventRing (QwOptions &options, QwSubsystemArrayParity &event)

virtual	~QwEventRing ()

void	ProcessOptions (QwOptions &options)
	Process options.

void	push (QwSubsystemArrayParity &event)
	Add the subsystem to the ring.

QwSubsystemArrayParity &	pop ()
	Return the last subsystem in the ring.

void	PrintRollingAverage ()
	Print value of rolling average.

Bool_t	IsReady ()
	Return the read status of the ring.

void	CheckBurpCut (Int_t thisevent)

Int_t	GetNumberOfEvents () const
	Return the number of events in the ring.

void	Unwind ()
	Unwind the ring until empty.

Static Public Member Functions
static void	DefineOptions (QwOptions &options)
	Define options.

Private Member Functions
	QwEventRing ()

Private Attributes
Int_t	fRING_SIZE

Int_t	fNumberOfEvents

Int_t	fNextToBeFilled

Int_t	fNextToBeRead

Bool_t	fPrintAfterUnwind

Bool_t	bEVENT_READY

Bool_t	bRING_READY

std::vector< QwSubsystemArrayParity >	fEvent_Ring

QwSubsystemArrayParity	fRollingAvg

FILE *	out_file

Bool_t	bStability

int	holdoff

int	countdown

Int_t	fBurpExtent

Int_t	fBurpPrecut

QwSubsystemArrayParity	fBurpAvg

Static Private Attributes
static const Bool_t	bDEBUG =kFALSE

static const Bool_t	bDEBUG_Write =kFALSE

Detailed Description

Ring buffer of subsystem snapshots for burp/stability handling.

Maintains a sliding window of events to compute running averages, handle beam trips with holdoff, and apply burp cuts over extents.

Definition at line 28 of file QwEventRing.h.

Constructor & Destructor Documentation

◆ QwEventRing() [1/2]

QwEventRing::QwEventRing ( )

private

◆ QwEventRing() [2/2]

QwEventRing::QwEventRing	(	QwOptions &	options,
		QwSubsystemArrayParity &	event )

QwEventRing.cc

Event ring buffer for burp detection and stability monitoring. Maintains a circular buffer of recent events, applies rolling averages for stability cuts, and implements burp detection with configurable extent and precut parameters. Documentation-only edits; runtime behavior unchanged. Constructor: initialize ring buffer with specified size and options.

Definition at line 14 of file QwEventRing.cc.

  : fRollingAvg(event), fBurpAvg(event)
{
  ProcessOptions(options);
 
  fEvent_Ring.resize(fRING_SIZE,event);
 
  bRING_READY = kFALSE;
  bEVENT_READY = kTRUE;
 
  fNumberOfEvents = 0;
  fNextToBeFilled = 0;
  fNextToBeRead = 0;
  countdown = 0;
 
  //open the log file
  if (bDEBUG_Write)
    out_file = fopen("Ring_log.txt", "wt");
}

References bDEBUG_Write, bEVENT_READY, bRING_READY, countdown, fBurpAvg, fEvent_Ring, fNextToBeFilled, fNextToBeRead, fNumberOfEvents, fRING_SIZE, fRollingAvg, out_file, and ProcessOptions().

Here is the call graph for this function:

◆ ~QwEventRing()

virtual QwEventRing::~QwEventRing ( )

inlinevirtual

Definition at line 41 of file QwEventRing.h.

41{ };

Member Function Documentation

◆ CheckBurpCut()

void QwEventRing::CheckBurpCut ( Int_t thisevent )

Perform burp detection for the specified event, marking preceding events if a burp is detected and maintaining the burp average window.

Definition at line 224 of file QwEventRing.cc.

{
  if (bRING_READY || thisevent>fBurpExtent){
    if (fBurpAvg.CheckForBurpFail(fEvent_Ring[thisevent])){
      Int_t precut_start = (thisevent+fRING_SIZE-fBurpPrecut)%fRING_SIZE;
      for(Int_t i=precut_start;i!=(thisevent+1)%fRING_SIZE;i=(i+1)%fRING_SIZE){
          fEvent_Ring[i].UpdateErrorFlag(fBurpAvg);
          fEvent_Ring[i].UpdateErrorFlag();
      }
    }
    Int_t beforeburp = (thisevent+fRING_SIZE-fBurpExtent-1)%fRING_SIZE;
    fBurpAvg.DeaccumulateRunningSum(fEvent_Ring[beforeburp], kPreserveError);
  }
  fBurpAvg.AccumulateAllRunningSum(fEvent_Ring[thisevent], 0, kPreserveError);
 
}

References bRING_READY, fBurpAvg, fBurpExtent, fBurpPrecut, fEvent_Ring, fRING_SIZE, and kPreserveError.

Referenced by push().

Here is the caller graph for this function:

◆ DefineOptions()

void QwEventRing::DefineOptions ( QwOptions & options )

static

Define options.

Define command-line options for ring buffer and burp detection parameters.

Definition at line 36 of file QwEventRing.cc.

{
  // Define the execution options
  options.AddOptions()("ring.size",
      po::value<int>()->default_value(4800),
      "QwEventRing: ring/buffer size");
 
  options.AddOptions()("burp.extent",
      po::value<int>()->default_value(10),
      "QwEventRing: burp extent");
 
  options.AddOptions()("burp.precut",
      po::value<int>()->default_value(5),
      "QwEventRing: burp precut");
 
  options.AddOptions()("burp.holdoff",
      po::value<int>()->default_value(10),
      "QwEventRing: burp holdoff");
 
  options.AddOptions()("ring.stability_cut",
      po::value<double>()->default_value(1),
      "QwEventRing: Stability ON/OFF");
  options.AddOptions()("ring.print-after-unwind",
      po::value<bool>()->default_bool_value(false),
      "QwEventRing: print rolling avg after unwind");
  options.AddOptions()("ring.holdoff",
      po::value<int>()->default_value(200),
      "QwEventRing: number of events ignored after the beam trips");
}

References QwOptions::AddOptions().

Referenced by DefineOptionsParity().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNumberOfEvents()

Int_t QwEventRing::GetNumberOfEvents ( ) const

inline

Return the number of events in the ring.

Definition at line 65 of file QwEventRing.h.

65{ return fNumberOfEvents; }

References fNumberOfEvents.

Referenced by Unwind().

Here is the caller graph for this function:

◆ IsReady()

Bool_t QwEventRing::IsReady ( )

Return the read status of the ring.

Check if the ring buffer has events ready for retrieval.

Definition at line 216 of file QwEventRing.cc.

                           { //Check for readiness to read data from the ring using the pop() routine   
  return bRING_READY;
}

References bRING_READY.

Referenced by main().

Here is the caller graph for this function:

◆ pop()

QwSubsystemArrayParity & QwEventRing::pop ( )

Return the last subsystem in the ring.

Retrieve the next event from the ring buffer and deaccumulate from rolling average if stability monitoring is enabled.

Returns: Reference to the retrieved event.

Definition at line 193 of file QwEventRing.cc.

                                        {
  Int_t tempIndex;
  tempIndex=fNextToBeRead;  
  if (bDEBUG) QwMessage<<" Read at "<<fNextToBeRead<<QwLog::endl; 
  if (bDEBUG_Write) fprintf(out_file," Read at %d \n",fNextToBeRead);
  
  if (fNextToBeRead==(fRING_SIZE-1)){
    bRING_READY=kFALSE;//setting to false is an extra measure of security to prevent reading a NULL value. 
  }
  if (bStability){
     fRollingAvg.DeaccumulateRunningSum(fEvent_Ring[tempIndex]);
  }
 
  // Increment read index
  fNumberOfEvents --;
  fNextToBeRead = (fNextToBeRead + 1) % fRING_SIZE;
 
  // Return the event
  return fEvent_Ring[tempIndex];  
}

References bDEBUG, bDEBUG_Write, bRING_READY, bStability, QwLog::endl(), fEvent_Ring, fNextToBeRead, fNumberOfEvents, fRING_SIZE, fRollingAvg, out_file, and QwMessage.

Referenced by main(), and Unwind().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PrintRollingAverage()

void QwEventRing::PrintRollingAverage ( )

inline

Print value of rolling average.

Definition at line 54 of file QwEventRing.h.

                             {
    fRollingAvg.CalculateRunningAverage();
    fRollingAvg.PrintValue();
  }

References fRollingAvg.

Referenced by Unwind().

Here is the caller graph for this function:

◆ ProcessOptions()

void QwEventRing::ProcessOptions ( QwOptions & options )

Process options.

Process options and validate ring/burp parameter consistency.

Definition at line 67 of file QwEventRing.cc.

{
  // Reads Event Ring parameters from cmd
  Double_t stability = 0.0;
  if (gQwOptions.HasValue("ring.size"))
    fRING_SIZE=gQwOptions.GetValue<int>("ring.size");
 
  if (gQwOptions.HasValue("burp.extent"))
    fBurpExtent=gQwOptions.GetValue<int>("burp.extent");
 
  if (gQwOptions.HasValue("burp.precut"))
    fBurpPrecut=gQwOptions.GetValue<int>("burp.precut");
 
  int tmpval = fBurpExtent;
  if (fBurpPrecut>fBurpExtent){
    QwWarning << "The burp precut ("<<fBurpPrecut
          << ") is larger than the burp extent (" 
          << fBurpExtent
          << "; this may not be what you meant to do."
          << QwLog::endl;
    tmpval =  fBurpPrecut;
  }
  tmpval += 2;
  if (fRING_SIZE<tmpval){
    QwWarning << "Forcing ring size to be " << tmpval
         << " to accommodate a burp extent of " << fBurpExtent
          << " and a burp precut of " << fBurpPrecut
          << "; it had been " << fRING_SIZE << "." << QwLog::endl;
    fRING_SIZE = tmpval;
  }
 
  if (gQwOptions.HasValue("burp.holdoff"))
    VQwHardwareChannel::SetBurpHoldoff(gQwOptions.GetValue<int>("burp.holdoff"));
 
  if (gQwOptions.HasValue("ring.stability_cut"))
    stability=gQwOptions.GetValue<double>("ring.stability_cut");
 
  if(gQwOptions.HasValue("ring.holdoff"))
    holdoff=gQwOptions.GetValue<int>("ring.holdoff");
 
  if (stability>0.0)
    bStability=kTRUE;
  else
    bStability=kFALSE;
 
  fPrintAfterUnwind = gQwOptions.GetValue<bool>("ring.print-after-unwind");
}

References bStability, QwLog::endl(), fBurpExtent, fBurpPrecut, fPrintAfterUnwind, fRING_SIZE, gQwOptions, holdoff, QwWarning, and VQwHardwareChannel::SetBurpHoldoff().

Referenced by QwEventRing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ push()

void QwEventRing::push ( QwSubsystemArrayParity & event )

Add the subsystem to the ring.

Add an event to the ring buffer, applying stability cuts and burp detection. Updates rolling averages and marks events with beam trip or stability errors.

Definition at line 118 of file QwEventRing.cc.

{
  if (bDEBUG) QwMessage << "QwEventRing::push:  BEGIN" <<QwLog::endl;
 
  
 
  if (bEVENT_READY){
    Int_t thisevent = fNextToBeFilled;
    Int_t prevevent = (thisevent+fRING_SIZE-1)%fRING_SIZE;
    fEvent_Ring[thisevent]=event;//copy the current good event to the ring 
    if (bStability){
      fRollingAvg.AccumulateAllRunningSum(event);
    }
 
 
    if (bDEBUG) QwMessage<<" Filled at "<<thisevent;//<<"Ring count "<<fRing_Count<<QwLog::endl; 
    if (bDEBUG_Write) fprintf(out_file," Filled at %d ",thisevent);
 
    // Increment fill index
    fNumberOfEvents ++;
    fNextToBeFilled = (thisevent + 1) % fRING_SIZE;
    
    if(fNextToBeFilled == 0){
      //then we have RING_SIZE events to process
      if (bDEBUG) QwMessage<<" RING FILLED "<<thisevent; //<<QwLog::endl; 
      if (bDEBUG_Write) fprintf(out_file," RING FILLED ");
      bRING_READY=kTRUE;//ring is filled with good multiplets
      fNextToBeFilled=0;//next event to be filled is the first element  
    }
 
 
      //check for current ramps
    if (bRING_READY && bStability){
        fRollingAvg.CalculateRunningAverage();
        /*
        //The fRollingAvg dose not contain any regular errorcodes since it only accumulate rolling sum for errorflag==0 event.
        //The only errorflag it generates is the stability cut failure error when the rolling avg is computed. 
        //Therefore when fRollingAvg.GetEventcutErrorFlag() is called it will return non-zero error code only if a global stability cut has failed
        //When fRollingAvg.GetEventcutErrorFlag() is called the fErrorFlag of the subsystemarrayparity object will be updated with any global
        //stability cut failures
        */
        fRollingAvg.UpdateErrorFlag(); //to update the global error code in the fRollingAvg
        if ( fRollingAvg.GetEventcutErrorFlag() != 0 ) {
          //  This test really needs to determine in any of the subelements
          //  might have a local stability cut failure, instead of just this
          //  global stability cut failure.
          for(Int_t i=0;i<fRING_SIZE;i++){
            fEvent_Ring[i].UpdateErrorFlag(fRollingAvg);
            fEvent_Ring[i].UpdateErrorFlag();
          }
        }
        if ((fEvent_Ring[thisevent].GetEventcutErrorFlag() & kBCMErrorFlag)!=0 &&
            (fEvent_Ring[prevevent].GetEventcutErrorFlag() & kBCMErrorFlag)!=0){
        countdown = holdoff;
      }
      if (countdown > 0) {
        --countdown;
        for(Int_t i=0;i<fRING_SIZE;i++){
            fEvent_Ring[i].UpdateErrorFlag(kBeamTripError);
          }
        }
    }
    //ring processing is done at a separate location
 
    this->CheckBurpCut(thisevent);
  }
}

References bDEBUG, bDEBUG_Write, bEVENT_READY, bRING_READY, bStability, CheckBurpCut(), countdown, QwLog::endl(), fEvent_Ring, fNextToBeFilled, fNumberOfEvents, fRING_SIZE, fRollingAvg, holdoff, kBCMErrorFlag, kBeamTripError, out_file, and QwMessage.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Unwind()

void QwEventRing::Unwind ( )

inline

Unwind the ring until empty.

Definition at line 68 of file QwEventRing.h.

                {
    while (GetNumberOfEvents() > 0) pop();
    if (fPrintAfterUnwind) {
      QwMessage << "Residual rolling average (should be zero)" << QwLog::endl;
      PrintRollingAverage();
    }
  }

References QwLog::endl(), fPrintAfterUnwind, GetNumberOfEvents(), pop(), PrintRollingAverage(), and QwMessage.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ bDEBUG

const Bool_t QwEventRing::bDEBUG =kFALSE

staticprivate

Definition at line 97 of file QwEventRing.h.

Referenced by pop(), and push().

◆ bDEBUG_Write

const Bool_t QwEventRing::bDEBUG_Write =kFALSE

staticprivate

Definition at line 98 of file QwEventRing.h.

Referenced by pop(), push(), and QwEventRing().

◆ bEVENT_READY

Bool_t QwEventRing::bEVENT_READY

private

Definition at line 86 of file QwEventRing.h.

Referenced by push(), and QwEventRing().

◆ bRING_READY

Bool_t QwEventRing::bRING_READY

private

Definition at line 89 of file QwEventRing.h.

Referenced by CheckBurpCut(), IsReady(), pop(), push(), and QwEventRing().

◆ bStability

Bool_t QwEventRing::bStability

private

Definition at line 101 of file QwEventRing.h.

Referenced by pop(), ProcessOptions(), and push().

◆ countdown

int QwEventRing::countdown

private

Definition at line 105 of file QwEventRing.h.

Referenced by push(), and QwEventRing().

◆ fBurpAvg

QwSubsystemArrayParity QwEventRing::fBurpAvg

private

Definition at line 110 of file QwEventRing.h.

Referenced by CheckBurpCut(), and QwEventRing().

◆ fBurpExtent

Int_t QwEventRing::fBurpExtent

private

Definition at line 108 of file QwEventRing.h.

Referenced by CheckBurpCut(), and ProcessOptions().

◆ fBurpPrecut

Int_t QwEventRing::fBurpPrecut

private

Definition at line 109 of file QwEventRing.h.

Referenced by CheckBurpCut(), and ProcessOptions().

◆ fEvent_Ring

std::vector<QwSubsystemArrayParity> QwEventRing::fEvent_Ring

private

Definition at line 91 of file QwEventRing.h.

Referenced by CheckBurpCut(), pop(), push(), and QwEventRing().

◆ fNextToBeFilled

Int_t QwEventRing::fNextToBeFilled

private

Definition at line 81 of file QwEventRing.h.

Referenced by push(), and QwEventRing().

◆ fNextToBeRead

Int_t QwEventRing::fNextToBeRead

private

Definition at line 82 of file QwEventRing.h.

Referenced by pop(), and QwEventRing().

◆ fNumberOfEvents

Int_t QwEventRing::fNumberOfEvents

private

Definition at line 79 of file QwEventRing.h.

Referenced by GetNumberOfEvents(), pop(), push(), and QwEventRing().

◆ fPrintAfterUnwind

Bool_t QwEventRing::fPrintAfterUnwind

private

Definition at line 84 of file QwEventRing.h.

Referenced by ProcessOptions(), and Unwind().

◆ fRING_SIZE

Int_t QwEventRing::fRING_SIZE

private

Definition at line 77 of file QwEventRing.h.

Referenced by CheckBurpCut(), pop(), ProcessOptions(), push(), and QwEventRing().

◆ fRollingAvg

QwSubsystemArrayParity QwEventRing::fRollingAvg

private

Definition at line 93 of file QwEventRing.h.

Referenced by pop(), PrintRollingAverage(), push(), and QwEventRing().

◆ holdoff

int QwEventRing::holdoff

private

Definition at line 104 of file QwEventRing.h.

Referenced by ProcessOptions(), and push().

◆ out_file

FILE* QwEventRing::out_file

private

Definition at line 96 of file QwEventRing.h.

Referenced by pop(), push(), and QwEventRing().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ QwEventRing() [1/2]

◆ QwEventRing() [2/2]

◆ ~QwEventRing()

Member Function Documentation

◆ CheckBurpCut()

◆ DefineOptions()

◆ GetNumberOfEvents()

◆ IsReady()

◆ pop()

◆ PrintRollingAverage()

◆ ProcessOptions()

◆ push()

◆ Unwind()

Field Documentation

◆ bDEBUG

◆ bDEBUG_Write

◆ bEVENT_READY

◆ bRING_READY

◆ bStability

◆ countdown

◆ fBurpAvg

◆ fBurpExtent

◆ fBurpPrecut

◆ fEvent_Ring

◆ fNextToBeFilled

◆ fNextToBeRead

◆ fNumberOfEvents

◆ fPrintAfterUnwind

◆ fRING_SIZE

◆ fRollingAvg

◆ holdoff

◆ out_file