icarus::trigger::TriggerGateBuilder Class Reference

Algorithm to produce trigger gates out of optical readout waveforms. More...

#include <TriggerGateBuilder.h>

Inheritance diagram for icarus::trigger::TriggerGateBuilder:

Classes
struct	Config
class	TriggerGates
	Container of logical gates for all triggering channels for a threshold. More...

Public Types
using	Channel_t = raw::Channel_t

Public Member Functions
	TriggerGateBuilder (Config const &config)
	Constructor: sets the configuration. More...
virtual	~TriggerGateBuilder ()=default
	Virtual destructor. Nothing special about it, except that it's virtual. More...
virtual void	setup (detinfo::DetectorTimings const &timings)
	Algorithm setup. More...
virtual void	reset ()
	Algorithm reset. It will require a new setup before using it again. More...
virtual void	resetup (detinfo::DetectorTimings const &timings)
	Resets and sets up. More...
virtual void	resetup (detinfo::DetectorTimings const &timings, std::vector< ADCCounts_t > const &thresholds)
	Resets and sets up (including a new set of thresholds). More...
virtual std::vector< TriggerGates >	build (std::vector< WaveformWithBaseline > const &waveforms) const =0
	Returns a collection of TriggerGates objects sorted by threshold. More...
std::vector< ADCCounts_t > const &	channelThresholds () const
	Returns all the configured thresholds. More...
std::size_t	nChannelThresholds () const
	Returns the number of configured thresholds. More...
optical_tick	timeToOpticalTick (microsecond time) const
	Converts a time [s] into optical ticks. More...
optical_tick	timeStampToOpticalTick (raw::TimeStamp_t time) const
	Converts a timestamp from raw::OpDetWaveform into optical ticks. More...

Static Public Member Functions
static constexpr bool	isValidChannel (Channel_t channel)
	Returns whether channel is valid. More...

Static Public Attributes
static constexpr Channel_t	InvalidChannel = std::numeric_limits<Channel_t>::max()
	Mnemonic for an invalid optical detector channel. More...

Protected Member Functions
detinfo::DetectorTimings const &	detTimings () const
	Returns a detector timings object. More...
std::vector< TriggerGates >	prepareAllGates () const
virtual void	doSetThresholds (std::vector< ADCCounts_t > const &thresholds)
	Sets all thresholds anew. More...

Private Attributes
std::vector< ADCCounts_t >	fChannelThresholds
	All single channel thresholds, sorted in increasing order. More...
std::optional < detinfo::DetectorTimings >	fDetTimings
	LArSoft detector timing utility. More...

Detailed Description

Algorithm to produce trigger gates out of optical readout waveforms.

See Also

icarus::trigger::DynamicTriggerGateBuilder, icarus::trigger::FixedTriggerGateBuilder

This is an abstract class. Derived algorithms need to provide a way to actually build() the gates.

Definition at line 102 of file TriggerGateBuilder.h.

Member Typedef Documentation

using icarus::trigger::TriggerGateBuilder::Channel_t = raw::Channel_t

Definition at line 108 of file TriggerGateBuilder.h.

Constructor & Destructor Documentation

icarus::trigger::TriggerGateBuilder::TriggerGateBuilder

(

Config const &

config

)

Constructor: sets the configuration.

Definition at line 129 of file TriggerGateBuilder.cxx.

  : fChannelThresholds(FHiCLsequenceWrapper(config.ChannelThresholds()))
{
  std::sort(fChannelThresholds.begin(), fChannelThresholds.end());
  
  if (!fChannelThresholds.empty()
    && (fChannelThresholds.front() < ADCCounts_t{0})
  ) {
    throw cet::exception("TriggerGateBuilder")
     << "icarus::trigger::TriggerGateBuilder does not support"
        " negative thresholds (like "
     << fChannelThresholds.front() << ").\n";
  }
  
} // icarus::trigger::TriggerGateBuilder::TriggerGateBuilder()

virtual icarus::trigger::TriggerGateBuilder::~TriggerGateBuilder ( )

virtualdefault

Virtual destructor. Nothing special about it, except that it's virtual.

Member Function Documentation

virtual std::vector<TriggerGates> icarus::trigger::TriggerGateBuilder::build ( std::vector< WaveformWithBaseline > const &  waveforms ) const

pure virtual

Returns a collection of TriggerGates objects sorted by threshold.

Implemented in icarus::trigger::FixedTriggerGateBuilder, and icarus::trigger::DynamicTriggerGateBuilder.

std::vector<ADCCounts_t> const& icarus::trigger::TriggerGateBuilder::channelThresholds ( ) const

inline

Returns all the configured thresholds.

Definition at line 220 of file TriggerGateBuilder.h.

    { return fChannelThresholds; }

detinfo::DetectorTimings const& icarus::trigger::TriggerGateBuilder::detTimings ( ) const

inlineprotected

Returns a detector timings object.

Definition at line 241 of file TriggerGateBuilder.h.

{ return *fDetTimings; }

virtual void icarus::trigger::TriggerGateBuilder::doSetThresholds ( std::vector< ADCCounts_t > const &  thresholds )

inlineprotectedvirtual

Sets all thresholds anew.

Definition at line 248 of file TriggerGateBuilder.h.

    { fChannelThresholds = thresholds; }

static constexpr bool icarus::trigger::TriggerGateBuilder::isValidChannel ( Channel_t  channel )

inlinestatic

Returns whether channel is valid.

Definition at line 235 of file TriggerGateBuilder.h.

    { return channel != InvalidChannel; }

std::size_t icarus::trigger::TriggerGateBuilder::nChannelThresholds ( ) const

inline

Returns the number of configured thresholds.

Definition at line 224 of file TriggerGateBuilder.h.

{ return channelThresholds().size(); }

auto icarus::trigger::TriggerGateBuilder::prepareAllGates ( ) const

protected

Creates an empty TriggerGates object for each threshold; thresholds are kept relative.

Definition at line 172 of file TriggerGateBuilder.cxx.

{

  // create an empty TriggerGates object for each threshold;
  // thresholds are kept relative
  std::vector<TriggerGates> allGates;
  allGates.reserve(nChannelThresholds());
  for (auto threshold: channelThresholds()) allGates.emplace_back(threshold);
  return allGates;
  
} // icarus::trigger::TriggerGateBuilder::prepareAllGates()

virtual void icarus::trigger::TriggerGateBuilder::reset ( )

inlinevirtual

Algorithm reset. It will require a new setup before using it again.

Definition at line 202 of file TriggerGateBuilder.h.

{}

virtual void icarus::trigger::TriggerGateBuilder::resetup ( detinfo::DetectorTimings const &  timings )

inlinevirtual

Resets and sets up.

Definition at line 205 of file TriggerGateBuilder.h.

    { reset(); setup(timings); }

virtual void icarus::trigger::TriggerGateBuilder::resetup ( detinfo::DetectorTimings const &  timings, std::vector< ADCCounts_t > const &  thresholds  )

inlinevirtual

Resets and sets up (including a new set of thresholds).

Definition at line 209 of file TriggerGateBuilder.h.

    { resetup(timings); doSetThresholds(thresholds); }

void icarus::trigger::TriggerGateBuilder::setup ( detinfo::DetectorTimings const &  timings )

virtual

Algorithm setup.

Reimplemented in icarus::trigger::FixedTriggerGateBuilder.

Definition at line 148 of file TriggerGateBuilder.cxx.

{
  fDetTimings = timings;
} // icarus::trigger::TriggerGateBuilder::setup()

auto icarus::trigger::TriggerGateBuilder::timeStampToOpticalTick

(

raw::TimeStamp_t

time

)

const

Converts a timestamp from raw::OpDetWaveform into optical ticks.

Definition at line 165 of file TriggerGateBuilder.cxx.

{
  return timeToOpticalTick(microsecond{ time });
} // icarus::trigger::TriggerGateBuilder::timeStampToOpticalTick()

auto icarus::trigger::TriggerGateBuilder::timeToOpticalTick

(

microsecond

time

)

const

Converts a time [s] into optical ticks.

Definition at line 156 of file TriggerGateBuilder.cxx.

{
  using optical_time = detinfo::timescales::optical_time;
  return detTimings().toTick<optical_tick>(optical_time{ time }); 
}

Member Data Documentation

std::vector<ADCCounts_t> icarus::trigger::TriggerGateBuilder::fChannelThresholds

private

All single channel thresholds, sorted in increasing order.

Definition at line 256 of file TriggerGateBuilder.h.

std::optional<detinfo::DetectorTimings> icarus::trigger::TriggerGateBuilder::fDetTimings

private

LArSoft detector timing utility.

Definition at line 264 of file TriggerGateBuilder.h.

constexpr Channel_t icarus::trigger::TriggerGateBuilder::InvalidChannel = std::numeric_limits<Channel_t>::max()

static

Mnemonic for an invalid optical detector channel.

Definition at line 112 of file TriggerGateBuilder.h.

---

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

• TriggerGateBuilder.h
• TriggerGateBuilder.cxx