JDETECTOR::JCLBDefaultSimulator Class Reference

Default CLB simulation. More...

#include <JCLBDefaultSimulator.hh>

Inheritance diagram for JDETECTOR::JCLBDefaultSimulator:

Classes
class	JStateMachine
	Auxiliary class to mimic hit ordering effects due to state machine inside CLB. More...
class	JTDC
	Implementation of non-linearity of 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
	JCLBDefaultSimulator (const JDAQHit::JTDC_t Tmax=0)
	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	getHighRateVeto (const JPMTIdentifier &id) const
	Get high-rate veto of given PMT.

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
JLANG::JSinglePointer< JTDC >	TDC
JLANG::JSinglePointer< JStateMachine >	state_machine
std::vector< JDAQHit >	buffer

Detailed Description

Default CLB simulation.

This class provides for the implementation of the conversion of a time-over-threshold pulse to a hit.
A hit consists of:

• PMT readout channel;
• time stamp of the leading edge of the time-over-threshold pulse;
• length of the time-over-threshold pulse;

The time stamping and pulse length determination is done by a TDC which is integrated inside the FPGA. The observed non-linearity of the TDC is implemented in this class.

Although the hits from the same PMT are striclty time sorted, hits from different PMTs could be reordered due to the occupancy of the buffers inside the FPGA. This reordering is also implemented in the this class.

Definition at line 134 of file JCLBDefaultSimulator.hh.

Member Typedef Documentation

JPMT_t

JDAQHit::JPMT_t JDETECTOR::JCLBDefaultSimulatorInterface::JPMT_t

inherited

Definition at line 60 of file JCLBDefaultSimulatorInterface.hh.

JTDC_t

JDAQHit::JTDC_t JDETECTOR::JCLBDefaultSimulatorInterface::JTDC_t

inherited

Definition at line 61 of file JCLBDefaultSimulatorInterface.hh.

JTOT_t

JDAQHit::JTOT_t JDETECTOR::JCLBDefaultSimulatorInterface::JTOT_t

inherited

Definition at line 62 of file JCLBDefaultSimulatorInterface.hh.

Constructor & Destructor Documentation

JCLBDefaultSimulator()

JDETECTOR::JCLBDefaultSimulator::JCLBDefaultSimulator ( const JDAQHit::JTDC_t Tmax = 0 )

inline

Constructor.

Parameters

Tmax	maximal time difference for swap [ns]

Definition at line 223 of file JCLBDefaultSimulator.hh.

                                                       : 
      JCLBDefaultSimulatorInterface(new JTDC(), 
                                    new JStateMachine(Tmax))
    {}

Member Function Documentation

getDAQFrameStatus()

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

inlineinherited

Get DAQ frame status of given module.

Parameters

id	module identifier

Returns

DAQ frame status

Definition at line 142 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)) ? 1 : 0) ;            // high-rate veto
      }
 
      return JDAQFrameStatus(daq, status, fifo);
    }

processData()

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

inlineoverridevirtualinherited

Process data.

Parameters

id	module identifier
input	PMT data
output	CLB data

Implements JDETECTOR::JCLBSimulator.

Definition at line 166 of file JCLBDefaultSimulatorInterface.hh.

    {      
      using namespace std;
      using namespace KM3NETDAQ;
 
 
      const double Tmin  =  0.0;                // Minimal TDC value [ns]
      const double Tmax  =  getFrameTime();     // Maximal TDC value [ns]
 
      output.setDAQFrameStatus(getDAQFrameStatus(id));
 
      buffer.clear();
 
      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()) {
 
          output.setHighRateVeto(pmt, true);
          
          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) {
 
        JTDC_t t0 = (JTDC_t)   Tmin;
        JTDC_t ts = (JTDC_t) ((Tmax - Tmin) / (n2 + 1));
 
        for (int i = 0; i != n2 + 1; ++i, t0 += ts) {
          
          if (gRandom->Rndm() * (n2 + 1) >= (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

inlinevirtualinherited

Get number of received UDP packets.

Parameters

id	module identifier

Returns

2

Reimplemented in JTRIGGER::JCLBRunByRunSimulator.

Definition at line 271 of file JCLBDefaultSimulatorInterface.hh.

    {
      return 2;
    }

getUDPMaximalSequenceNumber()

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

inlinevirtualinherited

Get maximal sequence number of UDP packet.

Parameters

id	module identifier

Returns

1

Reimplemented in JTRIGGER::JCLBRunByRunSimulator.

Definition at line 283 of file JCLBDefaultSimulatorInterface.hh.

    {
      return 1;
    }

hasUDPTrailer()

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

inlinevirtualinherited

Get UDP trailer status.

Parameters

id	module identifier

Returns

true

Reimplemented in JTRIGGER::JCLBRunByRunSimulator.

Definition at line 295 of file JCLBDefaultSimulatorInterface.hh.

    {
      return true;
    }

getHighRateVeto()

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

inlinevirtualinherited

Get high-rate veto of given PMT.

Parameters

id	PMT identifier

Returns

false

Reimplemented in JTRIGGER::JCLBRunByRunSimulator.

Definition at line 307 of file JCLBDefaultSimulatorInterface.hh.

    {
      return false;
    }

getMinimalToT()

static double JDETECTOR::JCLBDefaultSimulatorInterface::getMinimalToT ( )

inlinestaticinherited

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

Returns

TDC value [ns]

Definition at line 318 of file JCLBDefaultSimulatorInterface.hh.

    {
      return 0.5;
    }

Member Data Documentation

compare

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

staticinherited

TDC

JLANG::JSinglePointer<JTDC> JDETECTOR::JCLBDefaultSimulatorInterface::TDC

privateinherited

Definition at line 356 of file JCLBDefaultSimulatorInterface.hh.

state_machine

JLANG::JSinglePointer<JStateMachine> JDETECTOR::JCLBDefaultSimulatorInterface::state_machine

privateinherited

Definition at line 357 of file JCLBDefaultSimulatorInterface.hh.

buffer

std::vector<JDAQHit> JDETECTOR::JCLBDefaultSimulatorInterface::buffer

mutableprivateinherited

Definition at line 358 of file JCLBDefaultSimulatorInterface.hh.

---

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

• JCLBDefaultSimulator.hh