Auxiliary class to create summary data. More...

#include <JSummaryslice.hh>

Inheritance diagram for KM3NETDAQ::JSummaryslice:

Public Member Functions
	JSummaryslice ()
	Default constructor. More...

	JSummaryslice (const JDAQChronometer &chronometer, JObjectIterator< JDAQSummaryslice > &input, const JDetector &detector)
	Constructor. More...

	JSummaryslice (const JDAQChronometer &chronometer, const JDetectorSimulator &simbad)
	Constructor. More...

void	correct (const JPMTDefaultSimulatorInterface &simulator)
	Correct measured singles rates for the probability that a hit survives the simulation of the PMT. More...

std::ostream &	print (std::ostream &out, const bool lpr=false) const
	Print DAQ summary. More...

	ClassDef (JDAQSummaryslice, 6)

	ClassDef (JDAQPreamble, 1)

	ClassDef (JDAQSummarysliceHeader, 2)

	ClassDef (JDAQHeader, 2)

	ClassDef (JDAQChronometer, 3)

int	getLength () const
	Get length. More...

int	getDataType () const
	Get data type. More...

	ClassDefNV (JDAQAbstractPreamble, 1)

const JDAQSummarysliceHeader &	getDAQSummarysliceHeader () const
	Get DAQ summary slice header. More...

const JDAQHeader &	getDAQHeader () const
	Get DAQ header. More...

void	setDAQHeader (const JDAQHeader &header)
	Set DAQ header. More...

const JDAQChronometer &	getDAQChronometer () const
	Get DAQ chronometer. More...

void	setDAQChronometer (const JDAQChronometer &chronometer)
	Set DAQ chronometer. More...

int	getDetectorID () const
	Get detector identifier. More...

int	getRunNumber () const
	Get run number. More...

int	getFrameIndex () const
	Get frame index. More...

JDAQUTCExtended	getTimesliceStart () const
	Get start of timeslice. More...

void	setRunNumber (const int run)
	Set run number. More...

void	setFrameIndex (const int frame_index)
	Set frame index. More...

void	setTimesliceStart (const JDAQUTCExtended &timeslice_start)
	Set timeslice start time. More...

Static Public Member Functions
static void	actionAtFileOpen (int version)
	Action method at file open. More...

template<class T >
static JDAQPreamble	getDAQPreamble (const T &object)
	Get DAQ preamble. More...

Static Public Attributes
static const int	NPE = 1
	Number of photo-electrons corresponding to singles rate. More...

Protected Attributes
int	length

int	type

int	detector_id

int	run

int	frame_index

JDAQUTCExtended	timeslice_start

Detailed Description

Auxiliary class to create summary data.

Definition at line 38 of file JSummaryslice.hh.

Constructor & Destructor Documentation

◆ JSummaryslice() [1/3]

KM3NETDAQ::JSummaryslice::JSummaryslice ( )

inline

Default constructor.

Definition at line 44 of file JSummaryslice.hh.

45 {}

◆ JSummaryslice() [2/3]

KM3NETDAQ::JSummaryslice::JSummaryslice	(	const JDAQChronometer &	chronometer,
		JObjectIterator< JDAQSummaryslice > &	input,
		const JDetector &	detector
	)

inline

Constructor.

This constructor blends multiple KM3NETDAQ::JDAQSummaryslice's from an incomplete detector to a single KM3NETDAQ::JDAQSummaryslice for a complete detector.

Parameters

chronometer	DAQ chronometer
input	summary data
detector	detector

Definition at line 58 of file JSummaryslice.hh.

                                                                :
       JDAQSummaryslice(chronometer)
     {
       for (JDetector::const_iterator module = detector.begin(); module != detector.end() && input.hasNext(); ) {
  
         const JDAQSummaryslice* summary = input.next();
         
         for (const_iterator i = summary->begin(); i != summary->end() && module != detector.end(); ++i, ++module) {
  
           push_back(*i);
  
           rbegin()->setModuleIdentifier(module->getID());
         }
       }
     }

◆ JSummaryslice() [3/3]

KM3NETDAQ::JSummaryslice::JSummaryslice	(	const JDAQChronometer &	chronometer,
		const JDetectorSimulator &	simbad
	)

inline

Constructor.

This constructor directly creates a KM3NETDAQ::JDAQSummaryslice for a given detector simulation without the need to create first a KM3NETDAQ::JDAQTimeslice.

The high-rate veto of a given PMT is set to true when:

status of the PMT is not JPMTStatus::ON every time during the time slice; or
specified rate -corrected for the hit survival probability- exceeds KM3NETDAQ::HIGH_RATE_VETO_HZ.

Parameters

chronometer	chronometer
simbad	detector simulator

Definition at line 90 of file JSummaryslice.hh.

                                                     :
       JDAQSummaryslice()
     {
       using namespace JPP;
       using namespace KM3NETDAQ;
  
       setDAQChronometer(chronometer);
  
       try {
  
         const JK40DefaultSimulatorInterface& k40Simulator = dynamic_cast<const JK40DefaultSimulatorInterface&>(simbad.getK40Simulator());
         const JPMTDefaultSimulatorInterface& pmtSimulator = dynamic_cast<const JPMTDefaultSimulatorInterface&>(simbad.getPMTSimulator());
         const JCLBDefaultSimulatorInterface& clbSimulator = dynamic_cast<const JCLBDefaultSimulatorInterface&>(simbad.getCLBSimulator());
  
         for (JDetector::const_iterator module = simbad->begin(); module != simbad->end(); ++module) {
  
           if (!module->empty()) {
  
             push_back(JDAQSummaryFrame(module->getID()));
           
             this->rbegin()->setDAQFrameStatus(clbSimulator.getDAQFrameStatus(module->getID()));
  
             for (int pmt = 0; pmt != NUMBER_OF_PMTS; ++pmt) {
  
               const JPMTIdentifier id(module->getID(), pmt);
  
               double rate_Hz = k40Simulator.getSinglesRate(id);
  
               rate_Hz *= pmtSimulator.getPMTSignalProcessor(id).getSurvivalProbability(NPE);
  
               if (rate_Hz > HIGH_RATE_VETO_HZ) {
                 this->rbegin()->setHighRateVeto(pmt, true);
               }
  
               // correct rate for UDP packet loss
  
               const int n1  =  clbSimulator.getUDPNumberOfReceivedPackets(module->getID());
               const int n2  =  clbSimulator.getUDPMaximalSequenceNumber  (module->getID());
  
               if (n1 < n2 + 1) {
                 rate_Hz *= (double) n1 / (double) (n2 + 1);
               }
  
               this->rbegin()->setRate(pmt, rate_Hz);
             }
           }
         }
       }
       catch(const std::exception& error) {};
     }

Member Function Documentation

◆ correct()

void KM3NETDAQ::JSummaryslice::correct ( const JPMTDefaultSimulatorInterface & simulator )

inline

Correct measured singles rates for the probability that a hit survives the simulation of the PMT.

Parameters

simulator PMT simulator

Definition at line 148 of file JSummaryslice.hh.

     {
       using namespace JPP;
       using namespace KM3NETDAQ;
  
       for (iterator frame = this->begin(); frame != this->end(); ++frame) {
         
         for (int pmt = 0; pmt != NUMBER_OF_PMTS; ++pmt) {
           
           const JPMTIdentifier id(frame->getModuleID(), pmt);
           
           const double P = simulator.getPMTSignalProcessor(id).getSurvivalProbability(NPE);
           
           if (P > 0.0) 
             (*frame)[pmt].div(P);
           else
             (*frame)[pmt].setValue(0.0);
         }
       }
     }

◆ print()

std::ostream& KM3NETDAQ::JDAQSummaryslice::print	(	std::ostream &	out,
		const bool	lpr = `false`
	)		const

inlineinherited

Print DAQ summary.

Parameters

out	output stream
lpr	long print

Returns: output stream

Definition at line 88 of file JDAQSummaryslice.hh.

     {
       using namespace std;
  
       out << this->ClassName() << endl;
       out << dynamic_cast<const JDAQPreamble&>   (*this) << endl;
       out << dynamic_cast<const JDAQChronometer&>(*this) << endl;
     
       for (JDAQSummaryslice::const_iterator module = this->begin(); module != this->end(); ++module) {
  
         out << ' ' << setw(10) << module->getModuleID();
         out << ' ' << setw(8)  << setfill('0') << hex << module->getStatus()     << dec << setfill(' ');
         out << '|' << setw(8)  << setfill('0') << hex << module->getFIFOStatus() << dec << setfill(' ');
         out << ' ' << setw(2)  << module->getUDPNumberOfReceivedPackets();
         out << ' ' << setw(2)  << module->getUDPMaximalSequenceNumber();
  
         if (lpr) {
           for (int pmt = 0; pmt != NUMBER_OF_PMTS; ++pmt) {
             out << ' ' << fixed << showpoint << setw(4) << setprecision(1) << module->getRate(pmt) * 1.0e-3;
           }
         }
  
         out << endl;
       }
  
       return out;
     }

◆ actionAtFileOpen()

static void KM3NETDAQ::JDAQSummaryslice::actionAtFileOpen ( int version )

inlinestaticinherited

Action method at file open.

Parameters

version version

Definition at line 122 of file JDAQSummaryslice.hh.

     {
       JDAQSummaryFrame::ROOT_IO_VERSION = version;
     }

◆ ClassDef() [1/5]

KM3NETDAQ::JDAQSummaryslice::ClassDef	(	JDAQSummaryslice	,
		6
	)

inherited

◆ ClassDef() [2/5]

KM3NETDAQ::JDAQPreamble::ClassDef	(	JDAQPreamble	,
		1
	)

inherited

◆ ClassDef() [3/5]

KM3NETDAQ::JDAQSummarysliceHeader::ClassDef	(	JDAQSummarysliceHeader	,
		2
	)

inherited

◆ ClassDef() [4/5]

KM3NETDAQ::JDAQHeader::ClassDef	(	JDAQHeader	,
		2
	)

inherited

◆ ClassDef() [5/5]

KM3NETDAQ::JDAQChronometer::ClassDef	(	JDAQChronometer	,
		3
	)

inherited

◆ getDAQPreamble()

template<class T >

static JDAQPreamble KM3NETDAQ::JDAQPreamble::getDAQPreamble ( const T & object )

inlinestaticinherited

Get DAQ preamble.

This method should be used for binary I/O to get the actual data for the given object.
To this end, the following method should be overloaded for the corresponding data type.

   size_t  getSizeof(const T&);

Parameters

object object

Returns: preamble

Definition at line 76 of file JDAQPreamble.hh.

     {
       static JDAQPreamble preamble;
  
       preamble.length = getSizeof(object);
       preamble.type   = KM3NETDAQ::getDataType<T>();
  
       return preamble;
     }

◆ getLength()

int KM3NETDAQ::JDAQAbstractPreamble::getLength ( ) const

inlineinherited

Get length.

Returns: number of bytes

Definition at line 49 of file JDAQAbstractPreamble.hh.

     { 
       return length;
     }

◆ getDataType()

int KM3NETDAQ::JDAQAbstractPreamble::getDataType ( ) const

inlineinherited

Get data type.

Returns: data type

Definition at line 60 of file JDAQAbstractPreamble.hh.

     { 
       return type; 
     }

◆ ClassDefNV()

KM3NETDAQ::JDAQAbstractPreamble::ClassDefNV	(	JDAQAbstractPreamble	,
		1
	)

inherited

◆ getDAQSummarysliceHeader()

const JDAQSummarysliceHeader& KM3NETDAQ::JDAQSummarysliceHeader::getDAQSummarysliceHeader ( ) const

inlineinherited

Get DAQ summary slice header.

Returns: DAQ summary slice header

Definition at line 44 of file JDAQSummarysliceHeader.hh.

     {
       return static_cast<const JDAQSummarysliceHeader&>(*this);
     }

◆ getDAQHeader()

const JDAQHeader& KM3NETDAQ::JDAQHeader::getDAQHeader ( ) const

inlineinherited

Get DAQ header.

Returns: DAQ header

Definition at line 49 of file JDAQHeader.hh.

     { 
       return static_cast<const JDAQHeader&>(*this); 
     }

◆ setDAQHeader()

void KM3NETDAQ::JDAQHeader::setDAQHeader ( const JDAQHeader & header )

inlineinherited

Set DAQ header.

Parameters

header DAQ header

Definition at line 60 of file JDAQHeader.hh.

     { 
       static_cast<JDAQHeader&>(*this) = header;
     }

◆ getDAQChronometer()

const JDAQChronometer& KM3NETDAQ::JDAQChronometer::getDAQChronometer ( ) const

inlineinherited

Get DAQ chronometer.

Returns: DAQ chronometer

Definition at line 88 of file JDAQChronometer.hh.

     { 
       return static_cast<const JDAQChronometer&>(*this); 
     }

◆ setDAQChronometer()

void KM3NETDAQ::JDAQChronometer::setDAQChronometer ( const JDAQChronometer & chronometer )

inlineinherited

Set DAQ chronometer.

Parameters

chronometer DAQ chronometer

Definition at line 99 of file JDAQChronometer.hh.

     { 
       static_cast<JDAQChronometer&>(*this) = chronometer;
     }

◆ getDetectorID()

int KM3NETDAQ::JDAQChronometer::getDetectorID ( ) const

inlineinherited

Get detector identifier.

Returns: detector identifier

Definition at line 110 of file JDAQChronometer.hh.

     { 
       return detector_id; 
     }

◆ getRunNumber()

int KM3NETDAQ::JDAQChronometer::getRunNumber ( ) const

inlineinherited

Get run number.

Returns: run number

Definition at line 121 of file JDAQChronometer.hh.

     { 
       return run; 
     }

◆ getFrameIndex()

int KM3NETDAQ::JDAQChronometer::getFrameIndex ( ) const

inlineinherited

Get frame index.

Returns: frame index

Definition at line 132 of file JDAQChronometer.hh.

     { 
       return frame_index; 
     }

◆ getTimesliceStart()

JDAQUTCExtended KM3NETDAQ::JDAQChronometer::getTimesliceStart ( ) const

inlineinherited

Get start of timeslice.

Returns: timeslice start

Definition at line 144 of file JDAQChronometer.hh.

     {
       return timeslice_start;
     }

◆ setRunNumber()

void KM3NETDAQ::JDAQChronometer::setRunNumber ( const int run )

inlineinherited

Set run number.

Parameters

run	run number

Definition at line 155 of file JDAQChronometer.hh.

     { 
       this->run = run;
     }

◆ setFrameIndex()

void KM3NETDAQ::JDAQChronometer::setFrameIndex ( const int frame_index )

inlineinherited

Set frame index.

Parameters

frame_index frame index

Definition at line 166 of file JDAQChronometer.hh.

     { 
       this->frame_index = frame_index;
     }

◆ setTimesliceStart()

void KM3NETDAQ::JDAQChronometer::setTimesliceStart ( const JDAQUTCExtended & timeslice_start )

inlineinherited

Set timeslice start time.

Parameters

timeslice_start timeslice start time

Definition at line 177 of file JDAQChronometer.hh.

     {
       this->timeslice_start = timeslice_start;
     }

Member Data Documentation

◆ NPE

const int KM3NETDAQ::JSummaryslice::NPE = 1

static

Number of photo-electrons corresponding to singles rate.

Definition at line 169 of file JSummaryslice.hh.

◆ length

int KM3NETDAQ::JDAQAbstractPreamble::length

protectedinherited

Definition at line 69 of file JDAQAbstractPreamble.hh.

◆ type

int KM3NETDAQ::JDAQAbstractPreamble::type

protectedinherited

Definition at line 70 of file JDAQAbstractPreamble.hh.

◆ detector_id

int KM3NETDAQ::JDAQChronometer::detector_id

protectedinherited

Definition at line 187 of file JDAQChronometer.hh.

◆ run

int KM3NETDAQ::JDAQChronometer::run

protectedinherited

Definition at line 188 of file JDAQChronometer.hh.

◆ frame_index

int KM3NETDAQ::JDAQChronometer::frame_index

protectedinherited

Definition at line 189 of file JDAQChronometer.hh.

◆ timeslice_start

JDAQUTCExtended KM3NETDAQ::JDAQChronometer::timeslice_start

protectedinherited

Definition at line 190 of file JDAQChronometer.hh.

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

JSummaryslice.hh

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JSummaryslice() [1/3]

◆ JSummaryslice() [2/3]

◆ JSummaryslice() [3/3]

Member Function Documentation

◆ correct()

◆ print()

◆ actionAtFileOpen()

◆ ClassDef() [1/5]

◆ ClassDef() [2/5]

◆ ClassDef() [3/5]

◆ ClassDef() [4/5]

◆ ClassDef() [5/5]

◆ getDAQPreamble()

◆ getLength()

◆ getDataType()

◆ ClassDefNV()

◆ getDAQSummarysliceHeader()

◆ getDAQHeader()

◆ setDAQHeader()

◆ getDAQChronometer()

◆ setDAQChronometer()

◆ getDetectorID()

◆ getRunNumber()

◆ getFrameIndex()

◆ getTimesliceStart()

◆ setRunNumber()

◆ setFrameIndex()

◆ setTimesliceStart()

Member Data Documentation

◆ NPE

◆ length

◆ type

◆ detector_id

◆ run

◆ frame_index

◆ timeslice_start