Default CLB simulation. More...

#include <JCLBDefaultSimulatorInterface.hh>

Inheritance diagram for JDETECTOR::JCLBDefaultSimulatorInterface:

Classes
struct	compare
	Auxiliary data structure for sorting of hits. More...

class	JStateMachine
	Interface to mimic hit ordering effects due to state machine inside CLB. More...

class	JTDC
	Interface for TDC. More...

Public Types
typedef JDAQHit::JPMT_t	JPMT_t

typedef JDAQHit::JTDC_t	JTDC_t

typedef JDAQHit::JTOT_t	JTOT_t

Public Member Functions
	JCLBDefaultSimulatorInterface (JTDC TDC, JStateMachine state_machine)
	Constructor.

JDAQFrameStatus	getDAQFrameStatus (const JModuleIdentifier &id) const
	Get DAQ frame status of given module.

virtual void	processData (const JModuleIdentifier &id, const JCLBInput &input, JDAQSuperFrame &output) const override
	Process data.

virtual int	getUDPNumberOfReceivedPackets (const JModuleIdentifier &id) const
	Get number of received UDP packets.

virtual int	getUDPMaximalSequenceNumber (const JModuleIdentifier &id) const
	Get maximal sequence number of UDP packet.

virtual bool	hasUDPTrailer (const JModuleIdentifier &id) const
	Get UDP trailer status.

virtual bool	setHighRateVeto () const
	Set high-rate veto based on number of hits.

virtual bool	getHighRateVeto (const JPMTIdentifier &id) const
	Get high-rate veto of given PMT.

virtual bool	getFIFOStatus (const JPMTIdentifier &id) const
	Get FIFO (almost) full of given PMT.

virtual bool	hasCLB (const JModuleIdentifier &id) const
	Check if CLB exist.

Static Public Member Functions
static double	getMinimalToT ()
	Get minimal pulse length of time-over-threshold measurement.

Static Public Attributes
static const struct JDETECTOR::JCLBDefaultSimulatorInterface::compare	compare

Private Attributes
std::unique_ptr< JTDC >	TDC

std::unique_ptr< JStateMachine >	state_machine

Detailed Description

Default CLB simulation.

This class provides for a default implementation of the JCLBSimulator interface which is based on a simulation of the TDC and the state machine inside the CLB. The actual number of hits may change due to the high-rate veto and UDP packet loss (loss of hits) and the dynamic range of the time-over-threshold (gain of hits).

The nested class JStateMachine constitutes a user interface for the simulation of the state machine through method JStateMachine::maybeSwapped(). With the default implementation, the overall time ordering if hits is maintained. For a realistic simulation of the CLB, a pointer to a designated implementation of this interface should be provided.

The implementation of the virtual method JCLBDefaultSimulatorInterface::processData provides for the settings of the status of the data frame.
In this, the high-rate veto is set when:

virtual method JCLBDefaultSimulatorInterface::getHighRateVeto returns true for the given PMT; or
number of hits from the PMT exceeds KM3NETDAQ::getMaximalNumberOfHits.

Definition at line 57 of file JCLBDefaultSimulatorInterface.hh.

Member Typedef Documentation

◆ JPMT_t

typedef JDAQHit::JPMT_t JDETECTOR::JCLBDefaultSimulatorInterface::JPMT_t

Definition at line 62 of file JCLBDefaultSimulatorInterface.hh.

◆ JTDC_t

typedef JDAQHit::JTDC_t JDETECTOR::JCLBDefaultSimulatorInterface::JTDC_t

Definition at line 63 of file JCLBDefaultSimulatorInterface.hh.

◆ JTOT_t

typedef JDAQHit::JTOT_t JDETECTOR::JCLBDefaultSimulatorInterface::JTOT_t

Definition at line 64 of file JCLBDefaultSimulatorInterface.hh.

Constructor & Destructor Documentation

◆ JCLBDefaultSimulatorInterface()

JDETECTOR::JCLBDefaultSimulatorInterface::JCLBDefaultSimulatorInterface	(	JTDC *	TDC,
		JStateMachine *	state_machine )

inline

Constructor.

This class owns the objects pointed to.

Parameters

TDC	pointer to TDC simulator
state_machine	pointer to state machine

Definition at line 130 of file JCLBDefaultSimulatorInterface.hh.

                                                                           :
      JCLBSimulator(),
      TDC          (TDC),
      state_machine(state_machine)
    {}

Member Function Documentation

◆ getDAQFrameStatus()

JDAQFrameStatus JDETECTOR::JCLBDefaultSimulatorInterface::getDAQFrameStatus ( const JModuleIdentifier & id ) const

inline

Get DAQ frame status of given module.

Parameters

id	module identifier

Returns: DAQ frame status

Definition at line 144 of file JCLBDefaultSimulatorInterface.hh.

    {
      using namespace KM3NETDAQ;
 
      int  daq    = (DAQ_UDP_RECEIVED_PACKETS.write(getUDPNumberOfReceivedPackets(id)) |    //
                     DAQ_UDP_SEQUENCE_NUMBER .write(getUDPMaximalSequenceNumber  (id)));    // DAQ  status
      int  status =  DAQ_WHITE_RABBIT.write(1);                                             // TDC  status
      int  fifo   =  DAQ_UDP_TRAILER .write(hasUDPTrailer(id) ? 1 : 0);                     // FIFO status
 
      for (size_t pmt = 0; pmt != NUMBER_OF_PMTS; ++pmt) {
        JBit(pmt).set(status, getHighRateVeto(JPMTIdentifier(id,pmt)));                     // high-rate veto
        JBit(pmt).set(fifo,   getFIFOStatus  (JPMTIdentifier(id,pmt)));                     // FIFO (almost) full
      }
 
      return JDAQFrameStatus(daq, status, fifo);
    }

◆ processData()

virtual void JDETECTOR::JCLBDefaultSimulatorInterface::processData	(	const JModuleIdentifier &	id,
		const JCLBInput &	input,
		JDAQSuperFrame &	output ) const

inlineoverridevirtual

Process data.

Parameters

id	module identifier
input	PMT data
output	CLB data

Implements JDETECTOR::JCLBSimulator.

Definition at line 169 of file JCLBDefaultSimulatorInterface.hh.

    {      
      using namespace std;
      using namespace JPP;
      using namespace KM3NETDAQ;
 
 
      const double Tmin  =  0.0;                // Minimal TDC value [ns]
      const double Tmax  =  getFrameTime();     // Maximal TDC value [ns]
 
      output.setDAQFrameStatus(getDAQFrameStatus(id));
 
      vector<JDAQHit> buffer;
 
      size_t ns = 0;                            // current number of hits in data frame
 
      for (size_t pmt = 0; pmt != input.size(); ++pmt) {
 
        const JPMTData<JPMTPulse>& in = input[pmt];
 
        // TDC
 
        for (JPMTData<JPMTPulse>::const_iterator hit = in.begin(); hit != in.end(); ++hit) {
 
          if (hit->t_ns >= Tmin && hit->t_ns <= Tmax) {
 
            double t1  = hit->t_ns;
            double tot = hit->tot_ns;
 
            // generate multiple hits if time-over-threshold exceeds dynamic range
          
            while (tot > JDAQHit::getMaximalToT()) {
 
              buffer.push_back(TDC->makeHit((JPMT_t) pmt, t1, (JTOT_t) JDAQHit::getMaximalToT()));
 
              t1  += JDAQHit::getMaximalToT();
              tot -= JDAQHit::getMaximalToT();
            }
 
            if (tot > getMinimalToT()) {
              buffer.push_back(TDC->makeHit((JPMT_t) pmt, t1, (JTOT_t) (tot + 0.5)));
            }
          }
        }
 
        if (buffer.size() > ns + getMaximalNumberOfHits()) {
 
          if (setHighRateVeto()) {
            output.setHighRateVeto(pmt, true);
          }
 
          if (output.testHighRateVeto(pmt)) {
            buffer.resize(ns + getMaximalNumberOfHits());
          }
        }
 
        inplace_merge(buffer.begin(), buffer.begin() + ns, buffer.end());
 
        ns = buffer.size();
      }
 
 
      // simulate UDP packet loss
 
      const int n1  =  getUDPNumberOfReceivedPackets(id);
      const int n2  =  getUDPMaximalSequenceNumber  (id);
 
      if (n1 < n2 + 1) {
 
        const int ns = getBayesianMedian(n2, n1, 0);
 
        JTDC_t t0 = (JTDC_t)   Tmin;
        JTDC_t ts = (JTDC_t) ((Tmax - Tmin) / ns);
 
        for (int i = 0; i != ns; ++i, t0 += ts) {
 
          if (gRandom->Rndm() * ns >= (double) n1) {
 
            std::vector<JDAQHit>::iterator p = lower_bound(buffer.begin(), buffer.end(), t0,      compare);
            std::vector<JDAQHit>::iterator q = lower_bound(buffer.begin(), buffer.end(), t0 + ts, compare);
          
            buffer.erase(p,q);
          }
        }
      }
 
 
      // process data through state machine
 
      if (buffer.size() > 1) {
 
        for (std::vector<JDAQHit>::iterator q = buffer.begin(), p = q++; q != buffer.end(); ++p, ++q) {
 
          if (state_machine->maybeSwapped(*p,*q)) {
            iter_swap(p,q);
          }
        }
      }
 
 
      // store data
 
      output.add(buffer.size(), buffer.data());
    }

◆ getUDPNumberOfReceivedPackets()

virtual int JDETECTOR::JCLBDefaultSimulatorInterface::getUDPNumberOfReceivedPackets ( const JModuleIdentifier & id ) const

inlinevirtual

Get number of received UDP packets.

Parameters

id	module identifier

Returns: 2

Reimplemented in JTRIGGER::JCLBRunByRunSimulator.

Definition at line 281 of file JCLBDefaultSimulatorInterface.hh.

    {
      return 2;
    }

◆ getUDPMaximalSequenceNumber()

virtual int JDETECTOR::JCLBDefaultSimulatorInterface::getUDPMaximalSequenceNumber ( const JModuleIdentifier & id ) const

inlinevirtual

Get maximal sequence number of UDP packet.

Parameters

id	module identifier

Returns: 1

Reimplemented in JTRIGGER::JCLBRunByRunSimulator.

Definition at line 293 of file JCLBDefaultSimulatorInterface.hh.

    {
      return 1;
    }

◆ hasUDPTrailer()

virtual bool JDETECTOR::JCLBDefaultSimulatorInterface::hasUDPTrailer ( const JModuleIdentifier & id ) const

inlinevirtual

Get UDP trailer status.

Parameters

id	module identifier

Returns: true

Reimplemented in JTRIGGER::JCLBRunByRunSimulator.

Definition at line 305 of file JCLBDefaultSimulatorInterface.hh.

    {
      return true;
    }

◆ setHighRateVeto()

virtual bool JDETECTOR::JCLBDefaultSimulatorInterface::setHighRateVeto ( ) const

inlinevirtual

Set high-rate veto based on number of hits.

Returns: true

Reimplemented in JTRIGGER::JCLBRunByRunSimulator.

Definition at line 316 of file JCLBDefaultSimulatorInterface.hh.

    {
      return true;
    }

◆ getHighRateVeto()

virtual bool JDETECTOR::JCLBDefaultSimulatorInterface::getHighRateVeto ( const JPMTIdentifier & id ) const

inlinevirtual

Get high-rate veto of given PMT.

Parameters

id	PMT identifier

Returns: false

Reimplemented in JTRIGGER::JCLBRunByRunSimulator.

Definition at line 328 of file JCLBDefaultSimulatorInterface.hh.

    {
      return false;
    }

◆ getFIFOStatus()

virtual bool JDETECTOR::JCLBDefaultSimulatorInterface::getFIFOStatus ( const JPMTIdentifier & id ) const

inlinevirtual

Get FIFO (almost) full of given PMT.

Parameters

id	PMT identifier

Returns: false

Reimplemented in JTRIGGER::JCLBRunByRunSimulator.

Definition at line 340 of file JCLBDefaultSimulatorInterface.hh.

    {
      return false;
    }

◆ getMinimalToT()

static double JDETECTOR::JCLBDefaultSimulatorInterface::getMinimalToT ( )

inlinestatic

Get minimal pulse length of time-over-threshold measurement.

Returns: TDC value [ns]

Definition at line 351 of file JCLBDefaultSimulatorInterface.hh.

    {
      return 0.5;
    }

◆ hasCLB()

virtual bool JDETECTOR::JCLBSimulator::hasCLB ( const JModuleIdentifier & id ) const

inlinevirtualinherited

Check if CLB exist.

Parameters

id	module identifier

Returns: true

Reimplemented in JTRIGGER::JCLBRunByRunSimulator.

Definition at line 67 of file JCLBSimulator.hh.

    {
      return true;
    }

Member Data Documentation

◆ compare

const struct JDETECTOR::JCLBDefaultSimulatorInterface::compare JDETECTOR::JCLBDefaultSimulatorInterface::compare

static

◆ TDC

std::unique_ptr<JTDC> JDETECTOR::JCLBDefaultSimulatorInterface::TDC

private

Definition at line 389 of file JCLBDefaultSimulatorInterface.hh.

◆ state_machine

std::unique_ptr<JStateMachine> JDETECTOR::JCLBDefaultSimulatorInterface::state_machine

private

Definition at line 390 of file JCLBDefaultSimulatorInterface.hh.

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

JCLBDefaultSimulatorInterface.hh

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ JPMT_t

◆ JTDC_t

◆ JTOT_t

Constructor & Destructor Documentation

◆ JCLBDefaultSimulatorInterface()

Member Function Documentation

◆ getDAQFrameStatus()

◆ processData()

◆ getUDPNumberOfReceivedPackets()

◆ getUDPMaximalSequenceNumber()

◆ hasUDPTrailer()

◆ setHighRateVeto()

◆ getHighRateVeto()

◆ getFIFOStatus()

◆ getMinimalToT()

◆ hasCLB()

Member Data Documentation

◆ compare

◆ TDC

◆ state_machine