#include <TriggerConfiguration.h>

Classes
struct	CryoConfig

struct	GateConfig

Public Member Functions
float	getGateWidth (std::size_t source) const
	returns the effective gate width corrected for the veto delay in us More...

float	getDriftGateWidth (std::size_t source) const
	returns the width of the drift gate used for out-of-time light activity in us More...

unsigned int	getOffBeamRate (std::size_t source) const
	returns the prescale value used to open the offbeam gates with respect to the total number of beam gates seen More...

unsigned int	getMinBiasPrescale (std::size_t source) const
	returns the prescale value used to collect MinBias triggers with respect to the total number of gates seen of a particula type More...

void	dump (std::ostream &out, std::string const &indent, std::string const &firstIndent, unsigned int verbosity=MaxDumpVerbosity) const
	Dumps the content of the configuration into `out` stream. More...

void	dump (std::ostream &out, std::string const &indent="") const
	Dumps the content of the configuration into `out` stream. More...

void	dumpGateConfig (std::ostream &out, icarus::TriggerConfiguration::GateConfig const &gateConfig, std::string const &indent) const
	Dumps the content of the gate configuration into `out` stream. More...

void	dump (std::ostream &out, unsigned int verbosity, std::string const &indent="") const


bool	operator== (TriggerConfiguration const &other) const noexcept
	Comparison: all fields need to have the same values. More...

bool	operator!= (TriggerConfiguration const &other) const noexcept

Public Attributes
bool	useWrTime = false
	Use the WR time reference. More...

unsigned int	wrTimeOffset = 1'000'000'000
	Add an offset between the npt and tai time as used in the wr reference (normally it is 1 or 2 leap seconds) in ns. More...

unsigned int	vetoDelay = 0
	Veto (this delay has to be subtracted to the gate width ). Value is in ns. More...

std::array< CryoConfig, icarus::trigger::kNTriggerLocation >	cryoConfig
	Cryostat configuration. More...

std::string	majorityTriggerType
	Majority trigger type (consider triggers from one cryostats, either cryostats, or both cryostats) More...

std::string	runType
	Force the run to be fully a MinBias, if runType=="MinBias". If runType=="Majority" does a majority run with some prescaled minbias triggers depending on the gate selection in use. More...

unsigned int	tpcTriggerDelay = 0
	TPCTriggerDelay: distance between the Global trigger time and the output for the TPC. NB: It is in units of 400 ns. More...

std::array< GateConfig, icarus::trigger::kNTriggerSource >	gateConfig
	Gate Configuration. More...

Static Public Attributes
static constexpr unsigned int	MaxDumpVerbosity = 2U
	Maximum supported verbosity level supported by `dump()`. More...

static constexpr unsigned int	DefaultDumpVerbosity = MaxDumpVerbosity
	Default verbosity level for `dump()`. More...

Detailed Description

Definition at line 31 of file TriggerConfiguration.h.

Member Function Documentation

void icarus::TriggerConfiguration::dump	(	std::ostream &	out,
		std::string const &	indent,
		std::string const &	firstIndent,
		unsigned int	verbosity = `MaxDumpVerbosity`
	)		const

Dumps the content of the configuration into out stream.

Parameters

out	stream to dump the information into
indent	indentation string
firstIndent	special indentation string for the first line
verbosity	(default: `DefaultDumpVerbosity`) level of verbosity

The indentation string is prepended to each new line of the dump. The first line indentation string is prepended before the first line of the dump. The dump ends on a new empty line.

The amount of information printed depends on the verbosity level:

0: Boardreader configuration
1: FPGA configuration
2: SPEXI configuration

Definition at line 68 of file TriggerConfiguration.cxx.

        {
   
   do {
     // fake look for easy break: `goto` in disguise;
     // `break` will add a final `'\n'`, `return` will not.
     
     // start a new line with indentation:
     auto const outnl
       = [&out,&indent]() -> std::ostream& { return out << '\n' << indent; };
     
     unsigned int level = 0U;
     
     
     // --- verbosity: 0+ -------------------------------------------------------
     out << firstIndent
       << "Basic trigger configuration:";
       outnl() << " Use WR time:    " << std::boolalpha << useWrTime << std::noboolalpha;
       outnl() << " WR time offset: " << wrTimeOffset << " ns";
     
     if (++level > verbosity) break;
     // --- verbosity: 1+ -------------------------------------------------------
     
     auto printWindowMode = [&out](unsigned int slidingWindow){
         switch (slidingWindow) {
           case 0:  out << "fixed";   break;
           case 1:  out << "sliding"; break;
           default: out << "unknown";
         } // switch
         out << " (" << slidingWindow << ")";
       };
     
     outnl() << "FPGA Configuration:";
     outnl() << " Veto Delay:             "  <<  vetoDelay << " ns";
     outnl() << " MajLevelBeamCryoEAST:   "  <<  cryoConfig[icarus::trigger::kEast].majLevelInTime;
     outnl() << " MajLevelEnableCryoEAST: "  <<  cryoConfig[icarus::trigger::kEast].majLevelDrift;
     outnl() << " WindowCryoEAST:         ";
     printWindowMode(cryoConfig[icarus::trigger::kEast].slidingWindow);
     outnl() << " MajLevelBeamCryoWEST:   "  <<  cryoConfig[icarus::trigger::kWest].majLevelInTime;
     outnl() << " MajLevelEnableCryoWEST: "  <<  cryoConfig[icarus::trigger::kWest].majLevelDrift;
     outnl() << " WindowCryoWEST:         ";
     printWindowMode(cryoConfig[icarus::trigger::kWest].slidingWindow);
     outnl() << " MajorityTriggerType:   '"  <<  majorityTriggerType << "'";
     outnl() << " RunType:               '"  <<  runType << "'";
 
     out << "\n";
 
     if (++level > verbosity) return;
     // --- verbosity: 2+ -------------------------------------------------------
     
     out << indent // absorb the newline from the previous level
       << "SPEXI Configuration:\n";
       
       out << indent << " TPCTriggerDelay: " << (tpcTriggerDelay * 0.0004) << " ms ("
         << tpcTriggerDelay << " x 400 ns)\n";
       
       out << indent << " BNB:\n";
       dumpGateConfig( out, gateConfig[icarus::trigger::kBNB], indent+"  - " );
 
       out << indent << " NuMI:\n";
       dumpGateConfig( out, gateConfig[icarus::trigger::kNuMI], indent+"  - " );
 
       out << indent << " Offbeam BNB:\n";
       dumpGateConfig( out, gateConfig[icarus::trigger::kOffBeamBNB], indent + "  - " );
 
       out << indent << " Offbeam NuMI:\n";
       dumpGateConfig(out, gateConfig[icarus::trigger::kOffBeamNuMI], indent + "  - " );
 
 
       out << indent << " Calibration:\n";
       dumpGateConfig(out, gateConfig[icarus::trigger::kCalibration], indent + "  - ");
       if (gateConfig[icarus::trigger::kCalibration].hasGate) {
         out << indent << "  - " << "Period:                    " << gateConfig[icarus::trigger::kCalibration].period << " ns\n";
       }
 
     if (++level > verbosity) break;
     // --- verbosity: 3+ -------------------------------------------------------
     
     assert(level == MaxDumpVerbosity + 1U);
     
     // this is more debug information than anything else: verbosity was too high
     outnl() << "No more information available (reached level " << level << ").";
   
   } while(false);
   
   out << "\n";
   
 } // icarus::TriggerConfiguration::dump()

void icarus::TriggerConfiguration::dump	(	std::ostream &	out,
		std::string const &	indent = `""`
	)		const

inline

Dumps the content of the configuration into out stream.

Parameters

out	stream to dump the information into
indent	indentation level

See Also: dump(std::ostream&, std::string const&, std::string const&, unsigned int) const

Version of dump() with same first indentation level as the rest, and default verbosity.

Definition at line 254 of file TriggerConfiguration.h.

255 { dump(out, indent, indent); }

icarus::TriggerConfiguration::dump

void dump(std::ostream &out, std::string const &indent, std::string const &firstIndent, unsigned int verbosity=MaxDumpVerbosity) const

Dumps the content of the configuration into out stream.

Definition: TriggerConfiguration.cxx:68

void icarus::TriggerConfiguration::dump	(	std::ostream &	out,
		unsigned int	verbosity,
		std::string const &	indent = `""`
	)		const

inline

Definition at line 272 of file TriggerConfiguration.h.

276 { dump(out, indent, indent, verbosity); }

icarus::TriggerConfiguration::dump

void dump(std::ostream &out, std::string const &indent, std::string const &firstIndent, unsigned int verbosity=MaxDumpVerbosity) const

Dumps the content of the configuration into out stream.

Definition: TriggerConfiguration.cxx:68

void icarus::TriggerConfiguration::dumpGateConfig	(	std::ostream &	out,
		icarus::TriggerConfiguration::GateConfig const &	gateConfig,
		std::string const &	indent
	)		const

Dumps the content of the gate configuration into out stream.

Parameters

out	stream to dump the information into
gateConfig	the gate to be dumped
indent	(default: none) indentation string

See Also: dump(std::ostream&, std::string const&, std::string const&, unsigned int) const

Version of dump() with the specified verbosity level and same first indentation level as the rest.

Definition at line 22 of file TriggerConfiguration.cxx.

 {
   out << std::boolalpha
     << indent << "Gate Active:               " << gateConfig.hasGate << "\n";
   if (gateConfig.hasGate) {
     
     // gates
     out
       << indent << "Drift gate Active:         " << gateConfig.hasDriftGate << "\n"
       << indent << "MinBias Gate Active:       " << gateConfig.hasMinBiasGate << "\n"
       ;
     if (gateConfig.hasMinBiasGate)
       out << indent << "MinBias Drift Gate Active: " << gateConfig.hasMinBiasDriftGate << "\n";
     else if (gateConfig.hasMinBiasDriftGate)
       out << indent << "MinBias Drift Gate Active: " << gateConfig.hasMinBiasDriftGate << " (ignored)\n";
     
     // gate durations and offsets
     out << indent << "BeamWidth:                 " << (gateConfig.gateWidth - vetoDelay) << " ns";
     if (vetoDelay != 0)
       out << " (plus the veto of " << vetoDelay << " ns)";
     out << "\n";
     if (gateConfig.hasDriftGate)
       out << indent << "EnableWidth:               " << gateConfig.driftGateWidth << " ns\n";
     out << indent << "EarlyWarningOffset:        " << gateConfig.earlyWarningOffset << " ns\n";
     if (gateConfig.hasDriftGate)
       out << indent << "EarlyEarlyWarningOffset:   " << gateConfig.earlyEarlyWarningOffset << " ns\n";
     
     if (gateConfig.hasMinBiasGate)
       out << indent << "MinBias PreScale:          " << gateConfig.prescaleMinBias << "\n";
   }
   else {
     
     if (gateConfig.hasDriftGate)
       out << indent << "Drift gate Active:         " << gateConfig.hasDriftGate << " (ignored)\n";
     if (gateConfig.hasMinBiasGate)
       out << indent << "MinBias Gate Active:       " << gateConfig.hasMinBiasGate << " (ignored)\n";
     if (gateConfig.hasMinBiasDriftGate)
       out << indent << "MinBias Drift Gate Active: " << gateConfig.hasMinBiasDriftGate << " (ignored)\n";
     
   }
   
   out << std::noboolalpha;
 }

float icarus::TriggerConfiguration::getDriftGateWidth ( std::size_t source ) const

inline

returns the width of the drift gate used for out-of-time light activity in us

Parameters

source is the value of the sbn::bits::triggerSource enum type corresponding to the type of gate

Definition at line 164 of file TriggerConfiguration.h.

                                                     {
 
     return gateConfig[source].hasDriftGate ? 
       static_cast<float>( gateConfig[source].driftGateWidth )/1000. : 0U; 
 
   }

float icarus::TriggerConfiguration::getGateWidth ( std::size_t source ) const

inline

returns the effective gate width corrected for the veto delay in us

Parameters

source is the value of the sbn::bits::triggerSource enum type corresponding to the type of gate

Definition at line 148 of file TriggerConfiguration.h.

                                                {
 
     // We really want the vetoDelay to be shorter than the gateWidth
     assert(!gateConfig[source].hasGate || (gateConfig[source].gateWidth >= vetoDelay));
 
     return gateConfig[source].hasGate ? 
       static_cast<float>( gateConfig[source].gateWidth - vetoDelay )/1000.  : 0.;
  
   }

unsigned int icarus::TriggerConfiguration::getMinBiasPrescale ( std::size_t source ) const

inline

returns the prescale value used to collect MinBias triggers with respect to the total number of gates seen of a particula type

Parameters

source is the value of the sbn::bits::triggerSource enum type corresponding to the type of gate

Definition at line 189 of file TriggerConfiguration.h.

                                                             {
 
     return gateConfig[source].hasGate ? gateConfig[source].prescaleMinBias : 0U;
 
   }

unsigned int icarus::TriggerConfiguration::getOffBeamRate ( std::size_t source ) const

inline

returns the prescale value used to open the offbeam gates with respect to the total number of beam gates seen

Parameters

source is the value of the sbn::bits::triggerSource enum type corresponding to the type of gate

Definition at line 177 of file TriggerConfiguration.h.

                                                         {
      
     return gateConfig[source].hasGate ? gateConfig[source].offBeamGateRate : 0U;
    
   }

bool icarus::TriggerConfiguration::operator!= ( TriggerConfiguration const & other ) const

inlinenoexcept

Definition at line 202 of file TriggerConfiguration.h.

203 { return ! this->operator== (other); }

icarus::TriggerConfiguration::operator==

bool operator==(TriggerConfiguration const &other) const noexcept

Comparison: all fields need to have the same values.

Definition: TriggerConfiguration.h:289

bool icarus::TriggerConfiguration::operator== ( icarus::TriggerConfiguration const & other ) const

inlinenoexcept

Comparison: all fields need to have the same values.

Definition at line 289 of file TriggerConfiguration.h.

 {
 
  if ( useWrTime                             != other.useWrTime                             )   return false;
  if ( wrTimeOffset                          != other.wrTimeOffset                          )   return false;
  if ( vetoDelay                             != other.vetoDelay                             )   return false;
  if ( majorityTriggerType                   != other.majorityTriggerType                   )   return false;
  if ( runType                               != other.runType                               )   return false;
  if ( tpcTriggerDelay                       != other.tpcTriggerDelay                       )   return false; 
 
   
  return true;
 
 } 

Member Data Documentation

std::array<CryoConfig, icarus::trigger::kNTriggerLocation> icarus::TriggerConfiguration::cryoConfig

Cryostat configuration.

Definition at line 125 of file TriggerConfiguration.h.

constexpr unsigned int icarus::TriggerConfiguration::DefaultDumpVerbosity = MaxDumpVerbosity

static

Default verbosity level for dump().

Definition at line 218 of file TriggerConfiguration.h.

std::array<GateConfig, icarus::trigger::kNTriggerSource> icarus::TriggerConfiguration::gateConfig

Gate Configuration.

Definition at line 137 of file TriggerConfiguration.h.

std::string icarus::TriggerConfiguration::majorityTriggerType

Majority trigger type (consider triggers from one cryostats, either cryostats, or both cryostats)

Definition at line 128 of file TriggerConfiguration.h.

constexpr unsigned int icarus::TriggerConfiguration::MaxDumpVerbosity = 2U

static

Maximum supported verbosity level supported by dump().

Definition at line 215 of file TriggerConfiguration.h.

std::string icarus::TriggerConfiguration::runType

Force the run to be fully a MinBias, if runType=="MinBias". If runType=="Majority" does a majority run with some prescaled minbias triggers depending on the gate selection in use.

Definition at line 131 of file TriggerConfiguration.h.

unsigned int icarus::TriggerConfiguration::tpcTriggerDelay = 0

TPCTriggerDelay: distance between the Global trigger time and the output for the TPC. NB: It is in units of 400 ns.

Definition at line 134 of file TriggerConfiguration.h.

bool icarus::TriggerConfiguration::useWrTime = false

Use the WR time reference.

Definition at line 116 of file TriggerConfiguration.h.

unsigned int icarus::TriggerConfiguration::vetoDelay = 0

Veto (this delay has to be subtracted to the gate width ). Value is in ns.

Definition at line 122 of file TriggerConfiguration.h.

unsigned int icarus::TriggerConfiguration::wrTimeOffset = 1'000'000'000

Add an offset between the npt and tai time as used in the wr reference (normally it is 1 or 2 leap seconds) in ns.

Definition at line 119 of file TriggerConfiguration.h.

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

Classes

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation