JACOUSTICS::JEvent Struct Reference

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 std::string &oid, const int counter, const int id, T __begin, T __end)
	Constructor. More...
virtual	~JEvent ()
	Virtual destructor. More...
const std::string &	getOID () const
	Get detector identifier. More...
int	getCounter () const
	Get counter. More...
int	getOverlays () const
	Get overlays. More...
int	getID () const
	Get identifier. More...
void	merge (const JEvent &event)
	Merge event. More...
void	remove (const size_t ns, const double stdev)
	Remove outliers. More...
	ClassDef (JEvent, 2)
	ClassDefNV (JCounter, 1)

Protected Attributes
std::string	oid
int	overlays
int	id
int	counter

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

Detailed Description

Acoustic event.

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

Constructor & Destructor Documentation

JACOUSTICS::JEvent::JEvent ( )

inline

Default constructor.

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

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

template<class T >

JACOUSTICS::JEvent::JEvent ( const std::string &  oid, 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

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

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

                            :   
      JCounter(counter),
      oid     (oid),
      overlays(0),
      id      (id)
    {
      using namespace std;

      for (T i = __begin; i != __end; ++i) {
        push_back(*i);
      }

      sort(this->begin(), this->end());
    }

virtual JACOUSTICS::JEvent::~JEvent ( )

inlinevirtual

Virtual destructor.

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

    {}

Member Function Documentation

const std::string& JACOUSTICS::JEvent::getOID ( ) const

inline

Get detector identifier.

Returns

detector identifier.

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

    {
      return oid;
    }

int JACOUSTICS::JEvent::getCounter ( ) const

inline

Get counter.

Returns

counter

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

    {
      return counter;
    }

int JACOUSTICS::JEvent::getOverlays ( ) const

inline

Get overlays.

Returns

overlays

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

    {
      return overlays;
    }

int JACOUSTICS::JEvent::getID ( ) const

inline

Get identifier.

Returns

identifier

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

    {
      return id;
    }

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;
    }

void JACOUSTICS::JEvent::remove ( const size_t  ns, const double  stdev  )

inline

Remove outliers.

First, the transmissions are sorted according to their time-of-emission. The mean and standard deviation of the times of emission is then determined, excluding the first and last possible number of outliers from either side. From the excluded transmissions, the ones with a time-of-emission less than the given number of standard deviations away from the mean are retained.

Parameters

ns	number of outliers
stdev	number of standard deviations

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

    {
      using namespace std;
      using namespace JPP;

      if (ns > 0 && 2*ns < this->size()) {

        sort(this->begin(), this->end());

        iterator         p = this->begin();
        reverse_iterator q = this->rbegin();

        advance(p, ns);
        advance(q, ns);

        JQuantile Q;

        for (const_iterator i = p; i != q.base(); ++i) {
          Q.put(i->getToE());
        }

        const double t1 = Q.getMean()  -  stdev * Q.getSTDev();
        const double t2 = Q.getMean()  +  stdev * Q.getSTDev();

        for (size_t i = ns; i != 0 && p->getToE() >= t1; --i, --p) {}
        for (size_t i = ns; i != 0 && q->getToE() <= t2; --i, --q) {}

        vector<JTransmission> buffer(p, q.base());

        this->swap(buffer);
      }
    }

JACOUSTICS::JEvent::ClassDef	(	JEvent	,
		2
	)

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

inherited

Friends And Related Function Documentation

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 270 of file JAcoustics/JEvent.hh.

    {
      using namespace std;

      out << event.getOID()                 << 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()    << endl;
      }

      return out;
    }

Member Data Documentation

std::string JACOUSTICS::JEvent::oid

protected

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

int JACOUSTICS::JEvent::overlays

protected

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

int JACOUSTICS::JEvent::id

protected

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

int JACOUSTICS::JCounter::counter

protectedinherited

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

---

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

• JAcoustics/JEvent.hh