icarus::trigger::OpticalTriggerGate Class Reference

Logical multi-level gate associated to one or more waveforms. More...

#include <OpticalTriggerGate.h>

Inheritance diagram for icarus::trigger::OpticalTriggerGate:

Public Types
using	GateData_t = OpticalTriggerGateData_t
	Type for gate data access. More...
using	ChannelID_t = GateData_t::ChannelID_t
	Type of channel identifier. More...
Public Types inherited from icarus::trigger::ReadoutTriggerGate< Tick, TickInterval, ChannelIDType >
using	ClockTick_t = Tick
	Tick point. More...
using	ClockTicks_t = TickInterval
	Tick interval. More...
using	ChannelID_t = ChannelIDType
	Type of stored channel ID. More...
using	GateData_t = Base_t
	Type for gate data access. More...
using	ChannelList_t = std::vector< ChannelID_t >
	Type of list of associated channels. More...
Public Types inherited from icarus::trigger::TriggerGateData< Tick, TickInterval >
using	triggergatedata_t = TriggerGateData< Tick, TickInterval >
	This type. More...
using	ClockTick_t = Tick
	Type of a point in time, measured in ticks. More...
using	ClockTicks_t = TickInterval
	Type of a time interval, measured in ticks. More...
using	OpeningCount_t = unsigned int
	Type of count of number of open channels. More...
using	OpeningDiff_t = std::make_signed_t< OpeningCount_t >
	Type representing a variation of open channels. More...

Public Member Functions
	OpticalTriggerGate ()=default
	Constructor: a closed gate with no associated waveform (add() them). More...
	OpticalTriggerGate (OpticalTriggerGate const &)=default
	OpticalTriggerGate (OpticalTriggerGate &&)=default
OpticalTriggerGate &	operator= (OpticalTriggerGate const &)=default
OpticalTriggerGate &	operator= (OpticalTriggerGate &&)=default
	OpticalTriggerGate (raw::OpDetWaveform const &waveform)
	Constructor: a closed gate for the channel in waveform. More...
	fWaveforms ({&waveform})
	OpticalTriggerGate (ChannelID_t channel)
	Constructor: a closed gate for the specified channel. More...
bool	add (raw::OpDetWaveform const &waveform)
	Adds another waveform to the gate (unless it has already been added). More...
bool	operator== (OpticalTriggerGate const &) const
bool	operator!= (OpticalTriggerGate const &) const
template<typename Op >
icarus::trigger::OpticalTriggerGate	SymmetricCombination (Op &&op, OpticalTriggerGate const &a, OpticalTriggerGate const &b, TriggerGateTicks_t aDelay, TriggerGateTicks_t bDelay)
OpticalTriggerGate &	operator= (GateData_t const &data)
	Copies/steals all the levels and channels from the specified data. More...
OpticalTriggerGate &	operator= (GateData_t &&data)
Query
GateData_t &	gateLevels ()
	Access to the underlying gate level data (mutable). More...
GateData_t const &	gateLevels () const
	Access to the underlying gate level data (immutable). More...
std::vector < raw::OpDetWaveform const * >	waveforms () const
Public Member Functions inherited from icarus::trigger::ReadoutTriggerGate< Tick, TickInterval, ChannelIDType >
	ReadoutTriggerGate ()=default
	ReadoutTriggerGate (ReadoutTriggerGate const &)=default
	ReadoutTriggerGate (ReadoutTriggerGate &&)=default
ReadoutTriggerGate &	operator= (ReadoutTriggerGate const &)=default
ReadoutTriggerGate &	operator= (ReadoutTriggerGate &&)=default
	ReadoutTriggerGate (std::initializer_list< ChannelID_t > channels)
	Constructor: a closed gate associated to the specified channels. More...
bool	hasChannels () const
	Returns whether there is any channel id associated to the gate data. More...
bool	hasChannel () const
	Returns whether exactly one channel id associated to the gate data. More...
std::size_t	nChannels () const
	Returns the number of associated channels. More...
decltype(auto)	channels () const
	Returns the channels associated to the gate data. More...
ChannelID_t	channel () const
	Returns the channel associated to the gate data. More...
This_t &	addChannel (ChannelID_t const channel)
	Associates the specified channel to this readout gate. More...
This_t &	addChannels (std::initializer_list< ChannelID_t > channels)
	Associates the specified channels to this readout gate. More...
bool	operator== (ReadoutTriggerGate const &) const
bool	operator!= (ReadoutTriggerGate const &) const
ReadoutTriggerGate &	operator= (GateData_t const &data)
	Copies/steals all the levels from the specified data. More...
ReadoutTriggerGate &	operator= (GateData_t &&data)
GateData_t const &	gateLevels () const
	Access to the underlying gate level data. More...
GateData_t &	gateLevels ()
	Access to the underlying gate level data (mutable). More...
ReadoutTriggerGate &	Min (ReadoutTriggerGate const &other)
	Combines with a gate, keeping the minimum opening among the two. More...
ReadoutTriggerGate &	Max (ReadoutTriggerGate const &other)
	Combines with a gate, keeping the maximum opening among the two. More...
ReadoutTriggerGate &	Sum (ReadoutTriggerGate const &other)
	Combines with a gate, keeping the sum of openings of the two. More...
ReadoutTriggerGate &	Mul (ReadoutTriggerGate const &other)
	Combines with a gate, keeping the product of openings of the two. More...
Public Member Functions inherited from icarus::trigger::TriggerGateData< Tick, TickInterval >
	TriggerGateData ()
	Constructor: a closed gate for the channel in waveform. More...
bool	operator== (TriggerGateData const &) const
bool	operator!= (TriggerGateData const &) const
ClockTick_t	lastTick () const
	Returns the number of ticks this gate covers. More...
OpeningCount_t	openingCount (ClockTick_t tick) const
	Returns the opening count of the gate at the specified tick. More...
bool	alwaysClosed () const
	Returns whether this gate never opened. More...
bool	isOpen (ClockTick_t tick) const
	Returns whether the gate is open at all at the specified tick. More...
ClockTick_t	findOpen (OpeningCount_t minOpening=1U, ClockTick_t start=MinTick, ClockTick_t end=MaxTick) const
	Returns the tick at which the gate opened. More...
ClockTick_t	findClose (OpeningCount_t minOpening=1U, ClockTick_t start=MinTick, ClockTick_t end=MaxTick) const
	Returns the tick at which the gate closed. More...
ClockTick_t	findMaxOpen (ClockTick_t start=MinTick, ClockTick_t end=MaxTick) const
	Returns the tick at which the gate has the maximum opening. More...
std::pair< OpeningCount_t, OpeningCount_t >	openingRange (ClockTick_t start, ClockTick_t end) const
	Returns the range of trigger opening values in the specified range. More...
void	setOpeningAt (ClockTick_t tick, OpeningCount_t openingCount)
	Changes the opening to match openingCount at the specified time. More...
void	openAt (ClockTick_t tick, OpeningDiff_t count)
	Open this gate at the specified time (increase the opening by count). More...
void	openAt (ClockTick_t tick)
	Open this gate at the specified time (increase the opening by 1). More...
void	openBetween (ClockTick_t start, ClockTick_t end, OpeningDiff_t count=1)
	Open this gate at specified start tick, and close it at end tick. More...
void	openFor (ClockTick_t tick, ClockTicks_t length, OpeningDiff_t count=1)
	Open this gate at the specified time, and close it length ticks later. More...
void	closeAt (ClockTick_t tick, OpeningDiff_t count)
	Close this gate at the specified time (decrease the opening by count). More...
void	closeAt (ClockTick_t tick)
	Close this gate at the specified time. More...
void	closeAllAt (ClockTick_t tick)
	Completely close this gate at the specified time. More...
void	clear ()
	Sets the gate levels in the state at construction. More...
triggergatedata_t &	Min (triggergatedata_t const &other)
	Combines with a gate, keeping the minimum opening among the two. More...
triggergatedata_t &	Max (triggergatedata_t const &other)
	Combines with a gate, keeping the maximum opening among the two. More...
triggergatedata_t &	Sum (triggergatedata_t const &other)
	Combines with a gate, keeping the sum of openings of the two. More...
triggergatedata_t &	Mul (triggergatedata_t const &other)
	Combines with a gate, keeping the product of openings of the two. More...

Protected Types
using	Waveforms_t = std::vector< raw::OpDetWaveform const * >
	Internal list of registered waveforms. More...
Protected Types inherited from icarus::trigger::ReadoutTriggerGate< Tick, TickInterval, ChannelIDType >
using	GateEvolution_t = typename Base_t::GateEvolution_t
Protected Types inherited from icarus::trigger::TriggerGateData< Tick, TickInterval >
using	EventType = details::TriggerGateEventType
using	Status = details::TriggerGateStatus< ClockTick_t, OpeningCount_t >
using	GateEvolution_t = std::vector< Status >
	Type to describe the time evolution of the gate. More...

Protected Member Functions
	OpticalTriggerGate (GateEvolution_t &&gateLevel, Waveforms_t &&waveforms)
	Protected constructor: set the data directly. More...
void	registerWaveforms (Waveforms_t const &moreWaveforms)
	Registers the waveforms from the specified list. More...
void	mergeWaveformsFromGate (OpticalTriggerGate const &other)
	Registers the waveforms from the other gate into this one. More...
Protected Member Functions inherited from icarus::trigger::ReadoutTriggerGate< Tick, TickInterval, ChannelIDType >
	ReadoutTriggerGate (GateEvolution_t &&gateLevel, ChannelList_t &&channels)
	Protected constructor: set the data directly. More...
template<typename BIter , typename EIter >
	ReadoutTriggerGate (GateEvolution_t &&gateLevel, BIter b, EIter e)
	Protected constructor: set the data directly. More...
ChannelList_t &	normalizeChannels ()
	Removes duplicate channel IDs and sorts the remaining ones. More...
void	associateChannelsFromGate (ReadoutTriggerGate const &other)
	Associates this data with the channels from the other gate. More...
void	associateChannels (std::initializer_list< ChannelID_t > const &moreChannels)
	Associates this data with the channels from the specified list. More...
void	associateChannels (ChannelList_t const &moreChannels)
Protected Member Functions inherited from icarus::trigger::TriggerGateData< Tick, TickInterval >
	TriggerGateData (GateEvolution_t &&gateLevel)
	Protected constructor: set the data directly. More...

Static Protected Member Functions
static Waveforms_t	mergeWaveforms (Waveforms_t const &a, Waveforms_t const &b)
	Registers the waveforms from the other gate into this one. More...
Static Protected Member Functions inherited from icarus::trigger::ReadoutTriggerGate< Tick, TickInterval, ChannelIDType >
template<typename BIter , typename EIter >
static ChannelList_t &	mergeSortedChannelsInto (ChannelList_t &channels, BIter b, EIter e)
static ChannelList_t &	normalizeSortedChannels (ChannelList_t &channels)
	Removes duplicate channel IDs. More...
template<typename BIter , typename EIter >
static ChannelList_t &	mergeChannelsInto (ChannelList_t &channels, BIter b, EIter e)
	Adds channels from iterators b to e into channels (returned). More...
static ChannelList_t	mergeChannels (ChannelList_t const &a, ChannelList_t const &b)
	Returns a merged list of channels from a and b. More...
static ChannelList_t &	normalizeChannels (ChannelList_t &channels)
	Removes duplicate channel IDs and sorts the remaining ones. More...
static ChannelList_t	normalizeChannels (ChannelList_t &&channels)

Static Private Member Functions
static GateData_t::ChannelList_t	extractChannels (Waveforms_t const &waveforms)
	Returns the list of all channels from the waveforms (duplicate allowed). More...
static GateData_t::ChannelList_t	waveformChannels (Waveforms_t const &waveforms)
	Returns the list of all unique channels (sorted) from the waveforms. More...

Private Attributes
std::vector < raw::OpDetWaveform const * >	fWaveforms
	List of waveforms involved in this channel. More...

Combination operations
OpticalTriggerGate &	Min (OpticalTriggerGate const &other)
	Combines with a gate, keeping the minimum opening among the two. More...
OpticalTriggerGate &	Max (OpticalTriggerGate const &other)
	Combines with a gate, keeping the maximum opening among the two. More...
OpticalTriggerGate &	Sum (OpticalTriggerGate const &other)
	Combines with a gate, keeping the sum of openings of the two. More...
OpticalTriggerGate &	Mul (OpticalTriggerGate const &other)
	Combines with a gate, keeping the product of openings of the two. More...
static OpticalTriggerGate	Min (OpticalTriggerGate const &a, OpticalTriggerGate const &b)
	Returns a gate with the minimum opening between the specified two. More...
static OpticalTriggerGate	Max (OpticalTriggerGate const &a, OpticalTriggerGate const &b)
	Returns a gate with the maximum opening between the specified two. More...
static OpticalTriggerGate	Sum (OpticalTriggerGate const &a, OpticalTriggerGate const &b)
	Returns a gate with opening sum of the specified two. More...
static OpticalTriggerGate	Mul (OpticalTriggerGate const &a, OpticalTriggerGate const &b)
	Returns a gate with opening product of the specified two. More...
template<typename Op >
static OpticalTriggerGate	SymmetricCombination (Op &&op, OpticalTriggerGate const &a, OpticalTriggerGate const &b, TriggerGateTicks_t aDelay=TriggerGateTicks_t{0}, TriggerGateTicks_t bDelay=TriggerGateTicks_t{0})
	Returns a gate combination of the openings of two other gates. More...

Additional Inherited Members
Static Public Member Functions inherited from icarus::trigger::ReadoutTriggerGate< Tick, TickInterval, ChannelIDType >
static ReadoutTriggerGate	Min (ReadoutTriggerGate const &a, ReadoutTriggerGate const &b)
	Returns a gate with the minimum opening between the specified two. More...
static ReadoutTriggerGate	Max (ReadoutTriggerGate const &a, ReadoutTriggerGate const &b)
	Returns a gate with the maximum opening between the specified two. More...
static ReadoutTriggerGate	Sum (ReadoutTriggerGate const &a, ReadoutTriggerGate const &b)
	Returns a gate with opening sum of the specified two. More...
static ReadoutTriggerGate	Mul (ReadoutTriggerGate const &a, ReadoutTriggerGate const &b)
	Returns a gate with opening product of the specified two. More...
template<typename Op >
static ReadoutTriggerGate	SymmetricCombination (Op &&op, ReadoutTriggerGate const &a, ReadoutTriggerGate const &b, ClockTicks_t aDelay=ClockTicks_t{0}, ClockTicks_t bDelay=ClockTicks_t{0})
	Returns a gate combination of the openings of two other gates. More...
Static Public Member Functions inherited from icarus::trigger::TriggerGateData< Tick, TickInterval >
static triggergatedata_t	Min (triggergatedata_t const &a, triggergatedata_t const &b)
	Returns a gate with the minimum opening between the specified two. More...
static triggergatedata_t	Max (triggergatedata_t const &a, triggergatedata_t const &b)
	Returns a gate with the maximum opening between the specified two. More...
static triggergatedata_t	Sum (triggergatedata_t const &a, triggergatedata_t const &b)
	Returns a gate with opening sum of the specified two. More...
static triggergatedata_t	Mul (triggergatedata_t const &a, triggergatedata_t const &b)
	Returns a gate with opening product of the specified two. More...
template<typename Op >
static triggergatedata_t	SymmetricCombination (Op &&op, triggergatedata_t const &a, triggergatedata_t const &b, ClockTicks_t aDelay=ClockTicks_t{}, ClockTicks_t bDelay=ClockTicks_t{})
	Returns a gate combination of the openings of two other gates. More...
Static Public Attributes inherited from icarus::trigger::TriggerGateData< Tick, TickInterval >
static constexpr ClockTick_t	MinTick = std::numeric_limits<ClockTick_t>::min()
	An unbearably small tick number. More...
static constexpr ClockTick_t	MaxTick = std::numeric_limits<ClockTick_t>::max()
	An unbearably large tick number. More...

Detailed Description

Logical multi-level gate associated to one or more waveforms.

This object is a trigger gate associated with one or more optical waveforms.

Note

This object should be parametrized with optical ticks (detinfo::timescales::optical_tick). But currently the quantities (util::quantity derived objects) are not well suited to be serialized by ROOT, because

1. they are defined in lardataalg rather than lardataobj
2. writing all their serialization is daunting (see how ROOT dealt with GenVector vectors for an example of how to do it) So we chicken out here and use simple data types instead.

Definition at line 64 of file OpticalTriggerGate.h.

Member Typedef Documentation

using icarus::trigger::OpticalTriggerGate::ChannelID_t = GateData_t::ChannelID_t

Type of channel identifier.

Definition at line 72 of file OpticalTriggerGate.h.

using icarus::trigger::OpticalTriggerGate::GateData_t = OpticalTriggerGateData_t

Type for gate data access.

Definition at line 70 of file OpticalTriggerGate.h.

using icarus::trigger::OpticalTriggerGate::Waveforms_t = std::vector<raw::OpDetWaveform const*>

protected

Internal list of registered waveforms.

Definition at line 238 of file OpticalTriggerGate.h.

Constructor & Destructor Documentation

icarus::trigger::OpticalTriggerGate::OpticalTriggerGate ( )

default

Constructor: a closed gate with no associated waveform (add() them).

icarus::trigger::OpticalTriggerGate::OpticalTriggerGate ( OpticalTriggerGate const &  )

default

icarus::trigger::OpticalTriggerGate::OpticalTriggerGate ( OpticalTriggerGate &&  )

default

icarus::trigger::OpticalTriggerGate::OpticalTriggerGate ( raw::OpDetWaveform const &  waveform )

inline

Constructor: a closed gate for the channel in waveform.

Definition at line 83 of file OpticalTriggerGate.h.

    : GateData_t({ waveform.ChannelNumber() })

icarus::trigger::OpticalTriggerGate::OpticalTriggerGate ( ChannelID_t  channel )

inline

Constructor: a closed gate for the specified channel.

Definition at line 89 of file OpticalTriggerGate.h.

: GateData_t{ channel } {}

icarus::trigger::OpticalTriggerGate::OpticalTriggerGate ( GateEvolution_t &&  gateLevel, Waveforms_t &&  waveforms  )

inlineprotected

Protected constructor: set the data directly.

Definition at line 241 of file OpticalTriggerGate.h.

    : ReadoutTriggerGate(std::move(gateLevel), waveformChannels(waveforms))
    , fWaveforms(std::move(waveforms))
    {}

Member Function Documentation

bool icarus::trigger::OpticalTriggerGate::add

(

raw::OpDetWaveform const &

waveform

)

Adds another waveform to the gate (unless it has already been added).

Definition at line 201 of file OpticalTriggerGate.cxx.

{
  // insertion keeps the list ordered and the elements unique
  auto const& insertionPoint = std::lower_bound
    (fWaveforms.begin(), fWaveforms.end(), &waveform, ::OpDetWaveformComp());
  if ((insertionPoint != fWaveforms.end()) && (*insertionPoint == &waveform))
    return false;
  fWaveforms.insert(insertionPoint, &waveform);
  addChannel(waveform.ChannelNumber());
  return true;
} // icarus::trigger::OpticalTriggerGate::add()

auto icarus::trigger::OpticalTriggerGate::extractChannels ( Waveforms_t const &  waveforms )

staticprivate

Returns the list of all channels from the waveforms (duplicate allowed).

Definition at line 216 of file OpticalTriggerGate.cxx.

{
  GateData_t::ChannelList_t channels;
  channels.reserve(waveforms.size());
  std::transform(
                 waveforms.begin(), waveforms.end(), std::back_inserter(channels),
                 std::mem_fn(&raw::OpDetWaveform::ChannelNumber)
                 );
  return channels;
} // icarus::trigger::OpticalTriggerGate::extractChannels()

icarus::trigger::OpticalTriggerGate::fWaveforms ( {&waveform}  )

inline

Definition at line 85 of file OpticalTriggerGate.h.

                 { &waveform })
    {}

GateData_t& icarus::trigger::OpticalTriggerGate::gateLevels ( )

inline

Access to the underlying gate level data (mutable).

Definition at line 109 of file OpticalTriggerGate.h.

{ return *this; }

GateData_t const& icarus::trigger::OpticalTriggerGate::gateLevels ( ) const

inline

Access to the underlying gate level data (immutable).

Definition at line 112 of file OpticalTriggerGate.h.

{ return *this; }

icarus::trigger::OpticalTriggerGate & icarus::trigger::OpticalTriggerGate::Max

(

OpticalTriggerGate const &

other

)

Combines with a gate, keeping the maximum opening among the two.

Parameters

other

gate to combine to

Returns

this object

See Also

Min(), Sum()

Multi-level equivalent of an or logical operation.

Definition at line 111 of file OpticalTriggerGate.cxx.

{
  GateData_t::Max(other);
  mergeWaveformsFromGate(other);
  return *this;
} // icarus::trigger::OpticalTriggerGate::Max()

icarus::trigger::OpticalTriggerGate icarus::trigger::OpticalTriggerGate::Max ( OpticalTriggerGate const &  a, OpticalTriggerGate const &  b  )

static

Returns a gate with the maximum opening between the specified two.

Parameters

a	first gate
b	second gate

Returns

gate with at every tick the maximum opening among a and b

See Also

Min(), Sum()

Multi-level equivalent of an or logical operation.

Definition at line 147 of file OpticalTriggerGate.cxx.

{ auto combination { a }; combination.Max(b); return combination; }

auto icarus::trigger::OpticalTriggerGate::mergeWaveforms ( Waveforms_t const &  a, Waveforms_t const &  b  )

staticprotected

Registers the waveforms from the other gate into this one.

Definition at line 81 of file OpticalTriggerGate.cxx.

{
  Waveforms_t merged;
  merged.reserve(a.size() + b.size());
  std::merge(
             a.begin(), a.end(), b.begin(), b.end(), std::back_inserter(merged),
             ::OpDetWaveformComp()
             );
  
  // finally remove any duplicate (there should be non, should it?)
  auto const actualEnd
    = std::unique(merged.begin(), merged.end()); // pointer comparison
  merged.erase(actualEnd, merged.end());
  
  return merged;
} // icarus::trigger::OpticalTriggerGate::mergeWaveforms()

void icarus::trigger::OpticalTriggerGate::mergeWaveformsFromGate ( OpticalTriggerGate const &  other )

inlineprotected

Registers the waveforms from the other gate into this one.

Definition at line 251 of file OpticalTriggerGate.h.

  { registerWaveforms(other.waveforms()); }

icarus::trigger::OpticalTriggerGate & icarus::trigger::OpticalTriggerGate::Min

(

OpticalTriggerGate const &

other

)

Combines with a gate, keeping the minimum opening among the two.

Parameters

other

gate to combine to

Returns

this object

See Also

Max()

Multi-level equivalent of an and logical operation.

Definition at line 101 of file OpticalTriggerGate.cxx.

{
  GateData_t::Min(other);
  mergeWaveformsFromGate(other);
  return *this;
} // icarus::trigger::OpticalTriggerGate::Min()

icarus::trigger::OpticalTriggerGate icarus::trigger::OpticalTriggerGate::Min ( OpticalTriggerGate const &  a, OpticalTriggerGate const &  b  )

static

Returns a gate with the minimum opening between the specified two.

Parameters

a	first gate
b	second gate

Returns

gate with at every tick the minimum opening among a and b

See Also

Max()

Multi-level equivalent of an and logical operation.

Definition at line 141 of file OpticalTriggerGate.cxx.

{ auto combination { a }; combination.Min(b); return combination; }

icarus::trigger::OpticalTriggerGate & icarus::trigger::OpticalTriggerGate::Mul

(

OpticalTriggerGate const &

other

)

Combines with a gate, keeping the product of openings of the two.

Parameters

other

gate to combine to

Returns

this object

See Also

Min(), Max(), Sum()

Definition at line 131 of file OpticalTriggerGate.cxx.

{
  GateData_t::Mul(other);
  mergeWaveformsFromGate(other);
  return *this;
} // icarus::trigger::OpticalTriggerGate::Mul()

icarus::trigger::OpticalTriggerGate icarus::trigger::OpticalTriggerGate::Mul ( OpticalTriggerGate const &  a, OpticalTriggerGate const &  b  )

static

Returns a gate with opening product of the specified two.

Parameters

a	first gate
b	second gate

Returns

gate with at every tick the product of openings of a and b

See Also

Max()

Definition at line 159 of file OpticalTriggerGate.cxx.

{ auto combination { a }; combination.Mul(b); return combination; }

bool icarus::trigger::OpticalTriggerGate::operator!=

(

OpticalTriggerGate const &

other

)

const

Definition at line 192 of file OpticalTriggerGate.cxx.

{
  return
    (gateLevels() != other.gateLevels()) || (waveforms() != other.waveforms());
} // icarus::trigger::OpticalTriggerGate::operator==()

OpticalTriggerGate& icarus::trigger::OpticalTriggerGate::operator= ( OpticalTriggerGate const &  )

default

OpticalTriggerGate& icarus::trigger::OpticalTriggerGate::operator= ( OpticalTriggerGate &&  )

default

OpticalTriggerGate& icarus::trigger::OpticalTriggerGate::operator= ( GateData_t const &  data )

inline

Copies/steals all the levels and channels from the specified data.

Definition at line 97 of file OpticalTriggerGate.h.

    { GateData_t::operator=(data); return *this; }

OpticalTriggerGate& icarus::trigger::OpticalTriggerGate::operator= ( GateData_t &&  data )

inline

Definition at line 99 of file OpticalTriggerGate.h.

    { GateData_t::operator=(std::move(data)); return *this; }

bool icarus::trigger::OpticalTriggerGate::operator==

(

OpticalTriggerGate const &

other

)

const

Definition at line 183 of file OpticalTriggerGate.cxx.

{
  return
    (gateLevels() == other.gateLevels()) && (waveforms() == other.waveforms());
} // icarus::trigger::OpticalTriggerGate::operator==()

void icarus::trigger::OpticalTriggerGate::registerWaveforms ( Waveforms_t const &  moreWaveforms )

protected

Registers the waveforms from the specified list.

Definition at line 55 of file OpticalTriggerGate.cxx.

{
  //
  // add channels
  //
  associateChannels(extractChannels(moreWaveforms));

  //
  // merge the two lists, then sort them
  //
  auto const middle = fWaveforms.insert
    (fWaveforms.end(), moreWaveforms.begin(), moreWaveforms.end());
  std::inplace_merge
    (fWaveforms.begin(), middle, fWaveforms.end(), ::OpDetWaveformComp());

  // finally remove any duplicate (there should be none, should it?)
  auto const actualEnd
    = std::unique(fWaveforms.begin(), fWaveforms.end()); // pointer comparison
  fWaveforms.erase(actualEnd, fWaveforms.end());


} // OpticalTriggerGate::registerWaveforms()

icarus::trigger::OpticalTriggerGate & icarus::trigger::OpticalTriggerGate::Sum

(

OpticalTriggerGate const &

other

)

Combines with a gate, keeping the sum of openings of the two.

Parameters

other

gate to combine to

Returns

this object

See Also

Min(), Max()

Definition at line 121 of file OpticalTriggerGate.cxx.

{
  GateData_t::Sum(other);
  mergeWaveformsFromGate(other);
  return *this;
} // icarus::trigger::OpticalTriggerGate::Sum()

icarus::trigger::OpticalTriggerGate icarus::trigger::OpticalTriggerGate::Sum ( OpticalTriggerGate const &  a, OpticalTriggerGate const &  b  )

static

Returns a gate with opening sum of the specified two.

Parameters

a	first gate
b	second gate

Returns

gate with at every tick the total opening of a and b

See Also

Max()

Definition at line 153 of file OpticalTriggerGate.cxx.

{ auto combination { a }; combination.Sum(b); return combination; }

template<typename Op >

icarus::trigger::OpticalTriggerGate icarus::trigger::OpticalTriggerGate::SymmetricCombination	(	Op &&	op,
		OpticalTriggerGate const &	a,
		OpticalTriggerGate const &	b,
		TriggerGateTicks_t	aDelay,
		TriggerGateTicks_t	bDelay
	)

Definition at line 166 of file OpticalTriggerGate.cxx.

{
  return { 
    GateData_t::SymmetricCombination
      (std::forward<Op>(op), a, b, aDelay, bDelay),
      OpticalTriggerGate::mergeWaveforms(a.waveforms(), b.waveforms())
      };
  
} // icarus::trigger::OpticalTriggerGate::SymmetricCombination()

template<typename Op >

static OpticalTriggerGate icarus::trigger::OpticalTriggerGate::SymmetricCombination ( Op &&  op, OpticalTriggerGate const &  a, OpticalTriggerGate const &  b, TriggerGateTicks_t  aDelay = TriggerGateTicks_t{0}, TriggerGateTicks_t  bDelay = TriggerGateTicks_t{0}  )

static

Returns a gate combination of the openings of two other gates.

Template Parameters

Op	binary operation: OpeningCount_t (x2) to OpeningCount_t

Parameters

op	symmetric binary combination operation
a	first gate
b	second gate

Returns

gate with opening combination of a and b

For this algorithm to work, the operation needs to be symmetric, i.e. op(c1, c2) == op(c2, c1) for every valid combinations of counts c1 and c2.

auto icarus::trigger::OpticalTriggerGate::waveformChannels ( Waveforms_t const &  waveforms )

staticprivate

Returns the list of all unique channels (sorted) from the waveforms.

Definition at line 230 of file OpticalTriggerGate.cxx.

{
  return GateData_t::normalizeChannels(extractChannels(waveforms));
} // icarus::trigger::OpticalTriggerGate::waveformChannels()

std::vector<raw::OpDetWaveform const*> icarus::trigger::OpticalTriggerGate::waveforms ( ) const

inline

Returns a list of pointers to the waveforms associated to the gate, sorted.

Definition at line 116 of file OpticalTriggerGate.h.

    { return fWaveforms; }

Member Data Documentation

std::vector<raw::OpDetWaveform const*> icarus::trigger::OpticalTriggerGate::fWaveforms

private

List of waveforms involved in this channel.

Definition at line 261 of file OpticalTriggerGate.h.

---

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

• OpticalTriggerGate.h
• OpticalTriggerGate.cxx