Acoustic event. More...

#include <JEvent.hh>

Inheritance diagram for JACOUSTICS::JEvent:

Classes
struct	JEvaluator
	Auxiliary class to determine value of acoustic events. More...

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

template<class T >
	JEvent (const int detid, const int counter, const int id, T __begin, T __end)
	Constructor. More...

virtual	~JEvent ()
	Virtual destructor. More...

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

int	getOverlays () const
	Get number of overlayed events. More...

int	getID () const
	Get emitter identifier. More...

void	merge (const JEvent &event)
	Merge event. More...

virtual JReader &	read (JReader &in) override
	Read from input. More...

virtual JWriter &	write (JWriter &out) const override
	Write to output. More...

	ClassDefOverride (JEvent, 4)

int	getCounter () const
	Get counter. More...

	ClassDefNV (JCounter, 1)

Static Public Member Functions
template<class T >
static void	overlap (T p, T q, const double Tmax_s)
	Empty overlapping events. More...

Protected Attributes
int	detid

int	overlays

int	id

int	counter

Friends
void	swap (JEvent &first, JEvent &second)
	Swap events. More...

bool	operator< (const JEvent &first, const JEvent &second)
	Less than operator for acoustics events. More...

std::ostream &	operator<< (std::ostream &out, const JEvent &event)
	Write event to output stream. More...

Detailed Description

Acoustic event.

Definition at line 38 of file JAcoustics/JEvent.hh.

Constructor & Destructor Documentation

◆ JEvent() [1/2]

JACOUSTICS::JEvent::JEvent ( )

inline

Default constructor.

Definition at line 78 of file JAcoustics/JEvent.hh.

              :
       JCounter(),
       overlays(0),
       id      (-1)
     {}

◆ JEvent() [2/2]

template<class T >

JACOUSTICS::JEvent::JEvent	(	const int	detid,
		const int	counter,
		const int	id,
		T	__begin,
		T	__end
	)

inline

Constructor.

The transmissions will be sorted to ensure proper functioning of method JEvent::merge and class JEventOverlap.

Parameters

detid	detector identifier
counter	counter
id	identifier
__begin	begin of data
__end	end of data

Definition at line 97 of file JAcoustics/JEvent.hh.

                             :   
       JCounter(counter),
       detid   (detid),
       overlays(0),
       id      (id)
     {
       using namespace std;
  
       for (T i = __begin; i != __end; ++i) {
         push_back(*i);
       }
  
       sort(this->begin(), this->end());
     }

◆ ~JEvent()

virtual JACOUSTICS::JEvent::~JEvent ( )

inlinevirtual

Virtual destructor.

Definition at line 120 of file JAcoustics/JEvent.hh.

121 {}

Member Function Documentation

◆ getDetectorID()

const int JACOUSTICS::JEvent::getDetectorID ( ) const

inline

Get detector identifier.

Returns: detector identifier.

Definition at line 129 of file JAcoustics/JEvent.hh.

     {
       return detid;
     }

◆ getOverlays()

int JACOUSTICS::JEvent::getOverlays ( ) const

inline

Get number of overlayed events.

Returns: overlays

Definition at line 140 of file JAcoustics/JEvent.hh.

     {
       return overlays;
     }

◆ getID()

int JACOUSTICS::JEvent::getID ( ) const

inline

Get emitter identifier.

Returns: identifier

Definition at line 151 of file JAcoustics/JEvent.hh.

     {
       return id;
     }

◆ merge()

void JACOUSTICS::JEvent::merge ( const JEvent & event )

inline

Merge event.

It is assumed that the transmissions in both events are ordered according the default less-than operator.

Parameters

event event

Definition at line 165 of file JAcoustics/JEvent.hh.

     {
       using namespace std;
  
       vector<JTransmission> buffer;
  
       const_iterator __hit1 = this ->begin();
       const_iterator __end1 = this ->end();
  
       const_iterator __hit2 = event.begin();
       const_iterator __end2 = event.end();
  
       buffer.resize(this->size() + event.size());
  
       iterator out = buffer.begin();
  
       while (__hit1 != __end1 && __hit2 != __end2) {
  
         if        (*__hit1 < *__hit2) {
  
           *out = *__hit1;
           ++__hit1;
  
         } else if (*__hit2 < *__hit1) {
  
           *out = *__hit2;
           ++__hit2;
  
         } else {
  
           *out  = *__hit1;
  
           ++__hit1;
           ++__hit2;
         }
  
         ++out;
       }
  
       // append remaining hits from either set
  
       out = copy(__hit1, __end1, out);
       out = copy(__hit2, __end2, out);
  
       buffer.resize(distance(buffer.begin(), out));
  
       this->swap(buffer);
  
       ++overlays;
     }

◆ overlap()

template<class T >

static void JACOUSTICS::JEvent::overlap	(	T	p,
		T	q,
		const double	Tmax_s
	)

inlinestatic

Empty overlapping events.

The events should be time sorted on input.
The time window applies to the difference between the first transmission of an event and the last transmission of the previous event.

Parameters

p	begin of events
q	end of events
Tmax_s	time window [s]

Definition at line 247 of file JAcoustics/JEvent.hh.

     {
       for (T __q = p, __p = __q++; __p != q && __q != q; __p = __q++) {
  
         if (!__p->empty()                                            &&
             !__q->empty()                                            &&
             __q->begin()->getToE() < __p->rbegin()->getToE() + Tmax_s) {
  
           __p->clear();                            // clear first
  
           for (__p = __q++; __p != q && __q != q; __p = __q++) {
  
             if (__q->begin()->getToE() < __p->rbegin()->getToE() + Tmax_s)
               __p->clear();                        // clear intermediate
             else
               break;
           }
  
           __p->clear();                            // clear last
         }
       }
     }

◆ read()

virtual JReader& JACOUSTICS::JEvent::read ( JReader & in )

inlineoverridevirtual

Read from input.

Parameters

in reader

Returns: reader

Implements JIO::JSerialisable.

Definition at line 326 of file JAcoustics/JEvent.hh.

     {
       in >> static_cast<JCounter&>(*this);
       in >> this->detid;
       in >> this->overlays;
       in >> this->id;
       in >> static_cast<std::vector<JTransmission>&>(*this);
   
       return in;
     }

◆ write()

virtual JWriter& JACOUSTICS::JEvent::write ( JWriter & out ) const

inlineoverridevirtual

Write to output.

Parameters

out writer

Returns: writer

Implements JIO::JSerialisable.

Definition at line 344 of file JAcoustics/JEvent.hh.

     {
       out << static_cast<const JCounter&>(*this);
       out << this->detid;
       out << this->overlays;
       out << this->id;
       out << static_cast<const std::vector<JTransmission>&>(*this);
  
       return out;
     }

◆ ClassDefOverride()

JACOUSTICS::JEvent::ClassDefOverride	(	JEvent	,
		4
	)

◆ getCounter()

int JACOUSTICS::JCounter::getCounter ( ) const

inlineinherited

Get counter.

Returns: counter

Definition at line 51 of file JAcoustics/JCounter.hh.

     {
       return counter;
     }

◆ ClassDefNV()

JACOUSTICS::JCounter::ClassDefNV	(	JCounter	,
		1
	)

inherited

Friends And Related Function Documentation

◆ swap

void swap	(	JEvent &	first,
		JEvent &	second
	)

friend

Swap events.

Parameters

first	first event
second	second event

Definition at line 223 of file JAcoustics/JEvent.hh.

     {
       std::swap(first.counter,  second.counter);
       std::swap(first.detid,    second.detid);
       std::swap(first.overlays, second.overlays);
       std::swap(first.id,       second.id);
  
       static_cast<std::vector<JTransmission>&>(first).swap(static_cast<std::vector<JTransmission>&>(second));
     }

◆ operator<

bool operator<	(	const JEvent &	first,
		const JEvent &	second
	)

friend

Less than operator for acoustics events.

The less than operator is applied to the first hit in the events.
If there are no hits in either event, the counter of the events is used.

Parameters

first	first event
second	second event

Returns: true if first event earliear than second; else false

Definition at line 281 of file JAcoustics/JEvent.hh.

     {
       if (!first.empty() && !second.empty())
         return first.begin()->getToE() < second.begin()->getToE();
       else
         return first.getCounter() < second.getCounter();
     }

◆ operator<<

std::ostream& operator<<	(	std::ostream &	out,
		const JEvent &	event
	)

friend

Write event to output stream.

Parameters

out	output stream
event	event

Returns: output stream

Definition at line 297 of file JAcoustics/JEvent.hh.

     {
       using namespace std;
  
       out << event.getDetectorID()          << endl;
       out << setw(8) << event.getCounter()  << endl;
       out << setw(2) << event.getOverlays() << endl;
       out << setw(3) << event.getID()       << endl;
  
       for (const_iterator i = event.begin(); i != event.end(); ++i) {
  
         out << setw(10) << i->getID()        << ' ' 
             << setw(10) << i->getRunNumber() << ' ' 
             << fixed << setw(12) << setprecision(6) << i->getToA()  << ' '
             << fixed << setw(12) << setprecision(6) << i->getToE()  << ' '
             << fixed << setw(8)  << setprecision(0) << i->getQ()    << ' '
             << fixed << setw(8)  << setprecision(0) << i->getW()    << endl;
       }
  
       return out;
     }

Member Data Documentation

◆ detid

int JACOUSTICS::JEvent::detid

protected

Definition at line 358 of file JAcoustics/JEvent.hh.

◆ overlays

int JACOUSTICS::JEvent::overlays

protected

Definition at line 359 of file JAcoustics/JEvent.hh.

◆ id

int JACOUSTICS::JEvent::id

protected

Definition at line 360 of file JAcoustics/JEvent.hh.

◆ counter

int JACOUSTICS::JCounter::counter

protectedinherited

Definition at line 89 of file JAcoustics/JCounter.hh.

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

JAcoustics/JEvent.hh

Classes

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ JEvent() [1/2]

◆ JEvent() [2/2]

◆ ~JEvent()

Member Function Documentation

◆ getDetectorID()

◆ getOverlays()

◆ getID()

◆ merge()

◆ overlap()

◆ read()

◆ write()

◆ ClassDefOverride()

◆ getCounter()

◆ ClassDefNV()

Friends And Related Function Documentation

◆ swap

◆ operator<

◆ operator<<

Member Data Documentation

◆ detid

◆ overlays

◆ id

◆ counter