This class represents the linearised QIE output from the trigger scintillator, in charge (fC). More...

#include <EventReadout.h>

Public Member Functions
	EventReadout ()=default
	Class constructor.

	~EventReadout ()=default
	Class destructor.

void	clear (Option_t *option="")
	Clear the data in the object.

void	print (Option_t *option="") const
	Print out the object.

void	setPedestal (const float pedestal)
	Set channel (linearized.

float	getEarlyPedestal () const
	Get the pedestal calculated only from first N time samples.

void	setEarlyPedestal (const float earlyPed)
	Set channel (linearized.

float	getPedestal () const
	Get the pedestal.

void	setNoise (const float noise)
	Set channel (linearized, charge-equiv) noise.

float	getNoise () const
	Get the channel noise.

void	setQualityFlag (const uint flag)
	Set channel data quality flag.

float	getQualityFlag () const
	Get the channel data quality flag.

void	setQ (const std::vector< float > q)
	Store charges of all time samples.

std::vector< float >	getQ () const
	Get charges of all time samples.

void	setQError (const std::vector< float > qErr)
	Store charge quantization errors of all time samples.

std::vector< float >	getQError () const
	Get charges of all time samples.

void	setTotQ (const float totQ)
	Set channel (linearized, charge-equiv) average charge.

float	getTotQ () const
	Get the channel totQ.

void	setAvgQ (const float avgQ)
	Set channel (linearized, charge-equiv) average charge.

float	getAvgQ () const
	Get the channel avgQ.

void	setMinQ (const float minQ)
	Set channel (linearized, charge-equiv) minimum charge.

float	getMinQ () const
	Get the channel minQ.

void	setMaxQ (const float maxQ)
	Set channel (linearized, charge-equiv) maximum charge.

float	getMaxQ () const
	Get the channel maxQ.

void	setMedQ (const float medQ)
	Set channel (linearized, charge-equiv) median charge.

float	getMedQ () const
	Get the channel medQ.

void	setTimeOffset (const int timeOffset)
	Set channel readout itme offset (in units of samples)

int	getTimeOffset () const
	Get the channel timeOffset.

void	setFiberNb (const int fiberNb)
	Set channel readout fiber number.

int	getFiberNb () const
	Get the channel fiberNb.

bool	operator< (const EventReadout &rhs) const
	A dummy operator overloading.

Public Member Functions inherited from trigscint::TrigScintQIEDigis
	TrigScintQIEDigis ()=default
	Default constructor.

virtual	~TrigScintQIEDigis ()=default
	Default destructor.

void	clear (Option_t *option="")
	A dummy function.

bool	operator< (const TrigScintQIEDigis &rhs) const
	A dummy operator overloading.

int	getChanID () const
	Get channel ID.

int	getElecID () const
	Get electronics ID.

std::vector< int >	getADC () const
	Get ADCs of all time samples.

std::vector< int >	getTDC () const
	Get tdcs of all time samples.

std::vector< int >	getCID () const
	Get Cap IDs of all time samples.

void	setTimeSinceSpill (const uint32_t timeSpill)
	Store the event time since spill counter.

uint32_t	getTimeSinceSpill () const
	Store the event time since spill counter.

void	setChanID (const int chanid)
	Store the channel ID.

void	setElecID (const int elecid)
	Store the electronics ID.

void	setADC (const std::vector< int > adc)
	Store adcs of all time samples.

void	setTDC (const std::vector< int > tdc)
	Store tdcs of all time samples.

void	setCID (const std::vector< int > cid)
	Store cids of all time samples.

Private Member Functions
	ClassDef (EventReadout, 2)

Private Attributes
std::vector< float >	qs_
	analog to digital counts

std::vector< float >	q_errs_

float	pedestal_ {-999.}

float	early_pedestal_ {-999.}

float	noise_ {-1.}

float	tot_q_ {-999.}

float	avg_q_ {-999.}

float	min_q_ {-999.}

float	max_q_ {-999.}

float	med_q_ {-999.}

int	time_offset_ {0}

int	fiber_nb_ {-1}

uint	flag_ {0}

Additional Inherited Members
Protected Attributes inherited from trigscint::TrigScintQIEDigis
int	chan_id_
	channel ID

int	elec_id_ {-1}
	channel ID

std::vector< int >	adcs_
	analog to digital counts

std::vector< int >	tdcs_
	Time to Digital counts.

uint32_t	time_since_spill_counter_
	Time since spill (a counter, to be divided by 125e6 or so)

Detailed Description

This class represents the linearised QIE output from the trigger scintillator, in charge (fC).

Definition at line 24 of file EventReadout.h.

Member Function Documentation

◆ clear()

void trigscint::EventReadout::clear ( Option_t * option = "" )

Clear the data in the object.

Definition at line 22 of file EventReadout.cxx.

22{}

◆ getAvgQ()

float trigscint::EventReadout::getAvgQ ( ) const

inline

Get the channel avgQ.

Definition at line 136 of file EventReadout.h.

136{ return avg_q_; }

◆ getEarlyPedestal()

float trigscint::EventReadout::getEarlyPedestal ( ) const

inline

Get the pedestal calculated only from first N time samples.

Definition at line 55 of file EventReadout.h.

55{ return early_pedestal_; }

◆ getFiberNb()

int trigscint::EventReadout::getFiberNb ( ) const

inline

Get the channel fiberNb.

Definition at line 191 of file EventReadout.h.

191{ return fiber_nb_; }

Referenced by trigscint::EventReadoutProducer::produce().

◆ getMaxQ()

float trigscint::EventReadout::getMaxQ ( ) const

inline

Get the channel maxQ.

Definition at line 158 of file EventReadout.h.

158{ return max_q_; }

◆ getMedQ()

float trigscint::EventReadout::getMedQ ( ) const

inline

Get the channel medQ.

Definition at line 169 of file EventReadout.h.

169{ return med_q_; }

◆ getMinQ()

float trigscint::EventReadout::getMinQ ( ) const

inline

Get the channel minQ.

Definition at line 147 of file EventReadout.h.

147{ return min_q_; }

◆ getNoise()

float trigscint::EventReadout::getNoise ( ) const

inline

Get the channel noise.

Definition at line 78 of file EventReadout.h.

78{ return noise_; }

Referenced by trigscint::EventReadoutProducer::produce().

◆ getPedestal()

float trigscint::EventReadout::getPedestal ( ) const

inline

Get the pedestal.

Definition at line 67 of file EventReadout.h.

67{ return pedestal_; }

Referenced by trigscint::EventReadoutProducer::produce().

◆ getQ()

std::vector< float > trigscint::EventReadout::getQ ( ) const

inline

Get charges of all time samples.

Definition at line 104 of file EventReadout.h.

104{ return qs_; }

trigscint::EventReadout::qs_

std::vector< float > qs_

analog to digital counts

Definition EventReadout.h:203

References qs_.

◆ getQError()

std::vector< float > trigscint::EventReadout::getQError ( ) const

inline

Get charges of all time samples.

Definition at line 115 of file EventReadout.h.

115{ return q_errs_; }

◆ getQualityFlag()

float trigscint::EventReadout::getQualityFlag ( ) const

inline

Get the channel data quality flag.

Definition at line 93 of file EventReadout.h.

93{ return flag_; }

◆ getTimeOffset()

int trigscint::EventReadout::getTimeOffset ( ) const

inline

Get the channel timeOffset.

Definition at line 180 of file EventReadout.h.

180{ return time_offset_; }

◆ getTotQ()

float trigscint::EventReadout::getTotQ ( ) const

inline

Get the channel totQ.

Definition at line 125 of file EventReadout.h.

125{ return tot_q_; }

Referenced by trigscint::EventReadoutProducer::produce().

◆ operator<()

bool trigscint::EventReadout::operator< ( const EventReadout & rhs ) const

inline

A dummy operator overloading.

Note: required for declaring std::vector<> in EventDef.h

Definition at line 197 of file EventReadout.h.

                                                {
    return this->chan_id_ < rhs.chan_id_;
  }

References trigscint::TrigScintQIEDigis::chan_id_.

◆ print()

void trigscint::EventReadout::print ( Option_t * option = "" ) const

Print out the object.

Definition at line 15 of file EventReadout.cxx.

                                               {
  std::cout << "EventReadout { " << "chan_id = " << chan_id_ << ", "
            << "ADC[0]= " << adcs_[0] << ", " << "charge[0]= " << qs_[0] << ", "
            << "pedestal= " << pedestal_ << ", " << "noise= " << noise_ << ", "
            << "}\n";
}

References trigscint::TrigScintQIEDigis::adcs_, trigscint::TrigScintQIEDigis::chan_id_, and qs_.

◆ setAvgQ()

void trigscint::EventReadout::setAvgQ ( const float avgQ )

inline

Set channel (linearized, charge-equiv) average charge.

Parameters

avgQ	The (time sample) average charge of the channel

Definition at line 132 of file EventReadout.h.

132{ avg_q_ = avgQ; };

Referenced by trigscint::EventReadoutProducer::produce().

◆ setEarlyPedestal()

void trigscint::EventReadout::setEarlyPedestal ( const float earlyPed )

inline

Set channel (linearized.

charge) pedestal calculated from beginning of readout

Parameters

pedestal The pedestal of the first N time samples in the channel

Definition at line 63 of file EventReadout.h.

63{ early_pedestal_ = earlyPed; };

Referenced by trigscint::EventReadoutProducer::produce().

◆ setFiberNb()

void trigscint::EventReadout::setFiberNb ( const int fiberNb )

inline

Set channel readout fiber number.

Parameters

fiberNb The channel readout fiber number

Definition at line 187 of file EventReadout.h.

187{ fiber_nb_ = fiberNb; };

Referenced by trigscint::EventReadoutProducer::produce().

◆ setMaxQ()

void trigscint::EventReadout::setMaxQ ( const float maxQ )

inline

Set channel (linearized, charge-equiv) maximum charge.

Parameters

maxQ	The (time sample) maximum charge of the channel

Definition at line 154 of file EventReadout.h.

154{ max_q_ = maxQ; };

Referenced by trigscint::EventReadoutProducer::produce().

◆ setMedQ()

void trigscint::EventReadout::setMedQ ( const float medQ )

inline

Set channel (linearized, charge-equiv) median charge.

Parameters

medQ	The (time sample) median charge of the channel

Definition at line 165 of file EventReadout.h.

165{ med_q_ = medQ; };

Referenced by trigscint::EventReadoutProducer::produce().

◆ setMinQ()

void trigscint::EventReadout::setMinQ ( const float minQ )

inline

Set channel (linearized, charge-equiv) minimum charge.

Parameters

minQ	The (time sample) minimum charge of the channel

Definition at line 143 of file EventReadout.h.

143{ min_q_ = minQ; };

Referenced by trigscint::EventReadoutProducer::produce().

◆ setNoise()

void trigscint::EventReadout::setNoise ( const float noise )

inline

Set channel (linearized, charge-equiv) noise.

Parameters

noise The noise of the channel

Definition at line 74 of file EventReadout.h.

74{ noise_ = noise; };

Referenced by trigscint::EventReadoutProducer::produce().

◆ setPedestal()

void trigscint::EventReadout::setPedestal ( const float pedestal )

inline

Set channel (linearized.

charge) pedestal

Parameters

pedestal The pedestal of the channel

Definition at line 51 of file EventReadout.h.

51{ pedestal_ = pedestal; };

Referenced by trigscint::EventReadoutProducer::produce().

◆ setQ()

void trigscint::EventReadout::setQ ( const std::vector< float > q )

inline

Store charges of all time samples.

Parameters

q_	array of qs

Definition at line 99 of file EventReadout.h.

99{ qs_ = q; }

References qs_.

Referenced by trigscint::EventReadoutProducer::produce().

◆ setQError()

void trigscint::EventReadout::setQError ( const std::vector< float > qErr )

inline

Store charge quantization errors of all time samples.

Parameters

qErr_ array of quantization errors

Definition at line 110 of file EventReadout.h.

110{ q_errs_ = qErr; }

Referenced by trigscint::EventReadoutProducer::produce().

◆ setQualityFlag()

void trigscint::EventReadout::setQualityFlag ( const uint flag )

inline

Set channel data quality flag.

This is the binary combination of 4 flags: spike: 1 plateau: 10 long pulse: 100 (not implemented yet) oscillation: 1000

Parameters

flag	The quality flag of the channel

Definition at line 89 of file EventReadout.h.

89{ this->flag_ = flag; };

Referenced by trigscint::EventReadoutProducer::produce().

◆ setTimeOffset()

void trigscint::EventReadout::setTimeOffset ( const int timeOffset )

inline

Set channel readout itme offset (in units of samples)

Parameters

timeOffset The (time sample) offset in channel readout

Definition at line 176 of file EventReadout.h.

176{ time_offset_ = timeOffset; };

Referenced by trigscint::EventReadoutProducer::produce().

◆ setTotQ()

void trigscint::EventReadout::setTotQ ( const float totQ )

inline

Set channel (linearized, charge-equiv) average charge.

Parameters

totQ	The (time sample) average charge of the channel

Definition at line 122 of file EventReadout.h.

122{ tot_q_ = totQ; };

Referenced by trigscint::EventReadoutProducer::produce().

Member Data Documentation

◆ avg_q_

float trigscint::EventReadout::avg_q_ {-999.}

private

Definition at line 210 of file EventReadout.h.

210{-999.};

◆ early_pedestal_

float trigscint::EventReadout::early_pedestal_ {-999.}

private

Definition at line 207 of file EventReadout.h.

207{-999.};

◆ fiber_nb_

int trigscint::EventReadout::fiber_nb_ {-1}

private

Definition at line 215 of file EventReadout.h.

215{-1};

◆ flag_

uint trigscint::EventReadout::flag_ {0}

private

Definition at line 217 of file EventReadout.h.

217{0};

◆ max_q_

float trigscint::EventReadout::max_q_ {-999.}

private

Definition at line 212 of file EventReadout.h.

212{-999.};

◆ med_q_

float trigscint::EventReadout::med_q_ {-999.}

private

Definition at line 213 of file EventReadout.h.

213{-999.};

◆ min_q_

float trigscint::EventReadout::min_q_ {-999.}

private

Definition at line 211 of file EventReadout.h.

211{-999.};

◆ noise_

float trigscint::EventReadout::noise_ {-1.}

private

Definition at line 208 of file EventReadout.h.

208{-1.};

◆ pedestal_

float trigscint::EventReadout::pedestal_ {-999.}

private

Definition at line 206 of file EventReadout.h.

206{-999.};

◆ q_errs_

std::vector<float> trigscint::EventReadout::q_errs_

private

Definition at line 204 of file EventReadout.h.

◆ qs_

std::vector<float> trigscint::EventReadout::qs_

private

analog to digital counts

Definition at line 203 of file EventReadout.h.

Referenced by getQ(), print(), and setQ().

◆ time_offset_

int trigscint::EventReadout::time_offset_ {0}

private

Definition at line 214 of file EventReadout.h.

214{0};

◆ tot_q_

float trigscint::EventReadout::tot_q_ {-999.}

private

Definition at line 209 of file EventReadout.h.

209{-999.};

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

TrigScint/include/TrigScint/Event/EventReadout.h
TrigScint/src/TrigScint/Event/EventReadout.cxx

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clear()

◆ getAvgQ()

◆ getEarlyPedestal()

◆ getFiberNb()

◆ getMaxQ()

◆ getMedQ()

◆ getMinQ()

◆ getNoise()

◆ getPedestal()

◆ getQ()

◆ getQError()

◆ getQualityFlag()

◆ getTimeOffset()

◆ getTotQ()

◆ operator<()

◆ print()

◆ setAvgQ()

◆ setEarlyPedestal()

◆ setFiberNb()

◆ setMaxQ()

◆ setMedQ()

◆ setMinQ()

◆ setNoise()

◆ setPedestal()

◆ setQ()

◆ setQError()

◆ setQualityFlag()

◆ setTimeOffset()

◆ setTotQ()

Member Data Documentation

◆ avg_q_

◆ early_pedestal_

◆ fiber_nb_

◆ flag_

◆ max_q_

◆ med_q_

◆ min_q_

◆ noise_

◆ pedestal_

◆ q_errs_

◆ qs_

◆ time_offset_

◆ tot_q_