JACOUSTICS Namespace Reference

Auxiliary classes and methods for acoustic position calibration. More...

Namespaces
	JGEOMETRY
	Auxiliary namespace to encapsulate different geometries.
	JMODEL
	Auxiliary namespace to encapsulate different model parameters.

Classes
struct	JAbstractSoundVelocity
	Interface for depth dependend velocity of sound. More...
struct	JAttenuationLength
	Auxiliary data structure for calculation of attenuation length. More...
struct	JWaveform
	Utility class for emitter power and frequency. More...
struct	JCounter
	Acoustic counter. More...
struct	JEKey
	Emitter key. More...
struct	JEmitter
	Acoustic emitter. More...
struct	JEmitterID
	Auxiliary class for emitter identification. More...
struct	JEvent
	Acoustic event. More...
struct	JEventOverlap
	Match of two events considering overlap in time. More...
struct	JFit
	Acoustic single fit. More...
struct	JHead
	Acoustic event header. More...
struct	JEvt
	Acoustic event fit. More...
struct	JFitParameters
	Fit parameters. More...
struct	JPDFGauss
	Custom probability density function of time-of-arrival. More...
struct	JHit
	Acoustics hit. More...
struct	JKatoomba
	Template definition of fit function of acoustic model. More...
struct	JKatoomba< JType >
	Auxiliary base class for fit function of acoustic model. More...
struct	JKatoomba< JAbstractMinimiser >
	Template specialisation of fit function of acoustic model based on JAbstractMinimiser minimiser. More...
struct	JKatoomba< JEstimator >
	Template specialisation of fit function of acoustic model based on linear approximation. More...
struct	JKatoomba< JSimplex >
	Template specialisation of fit function of acoustic model based on JSimplex minimiser. More...
class	JGandalf
struct	JKatoomba< JGandalf >
	Template specialisation of fit function of acoustic model based on JGandalf minimiser. More...
struct	JKatoomba_t
	Worker class for fit function of acoustic model. More...
struct	JMechanics
	Auxiliary data structure for parameters of mechanical model. More...
struct	JDetectorMechanics
	Auxiliary data structure for mechanical model parameters of strings in a given detector. More...
struct	JModel
	Model for fit to acoustics data. More...
struct	JNarrabri
	Dynamic position calibration. More...
struct	JReceiver
	Acoustic receiver. More...
struct	JSoundVelocity
	Implementation for depth dependend velocity of sound. More...
struct	JTransceiver
	Acoustic transceiver. More...
struct	JTransmission
	Acoustic transmission. More...
struct	JTransmission_t
	Acoustic transmission identifier. More...
class	JTriggerOutput
	Set of acoustics events. More...
struct	JTriggerParameters
	Trigger parameters. More...
struct	hit_type
	Acoustic hit. More...
class	JMatch3D
	3D match criterion for acoustic signals. More...

Typedefs
typedef JGEOMETRY::JDetector	JGeometry
	Type definition of detector geometry. More...
typedef JTOOLS::JRange< double >	JTimeRange
	Type definition for time range (unit [s]). More...

Enumerations
enum	JFit_t { linear_t = 0, simplex_t, gandalf_t }
	Enumeration for fit algorithms. More...

Functions
double	getQ (const double D_m, const double f_kHz, const double d_m)
	Get relative quality for given frequency at given distance. More...
template<class T , class JTypename_t , class JComparator_t >
JVector3D	getPosition (T __begin, T __end, const JPredicate< JTypename_t, JComparator_t > &predicate)
	Get position from element in data which corresponds to given predicate. More...
template<class T , class JTypename_t , class JComparator_t >
JVector3D	getPosition (T __begin, T __end, const JPredicate< JTypename_t, JComparator_t > &predicate, const JVector3D &position)
	Get position from element in data which corresponds to given predicate. More...
double	getUNIXTime (const KM3NETDAQ::JDAQChronometer &chronometer)
	Get UNIX time of given DAQ object. More...
static bool	operator< (const JCounter &first, const JCounter &second)
	Less-than operator for two counters. More...
static bool	operator== (const JCounter &first, const JCounter &second)
	Equals operator for two counters. More...
bool	operator< (const JEvent &first, const JEvent &second)
	Less than operator for acoustics events. More...
template<class T >
void	overlap (T p, T q, const double Tmax_s)
	Empty overlapping events. More...
bool	operator< (const JHead &first, const JHead &second)
	Less than operator for acoustics event headers. More...
double	getQuality (const double chi2, const int NDF)
	Get quality of fit. More...
template<class T >
size_t	getNumberOfEmitters (T __begin, T __end)
	Get number of emitters. More...
JMODEL::JString	getModel (const JFit &fit)
	Get model parameters of string. More...
JFit	getFit (const int id, const JMODEL::JString &string)
	Get fit parameters of string. More...
JModel	getModel (const JEvt &evt)
	Get model of detector. More...
JEvt	getEvt (const JHead &header, const JModel &model)
	Get event. More...
template<class T >
double	getWeight (T __begin, T __end)
	Get total weight of data points. More...
JTreeParameters	getTreeParameters (const JType< JEvent > &type)
JTreeParameters	getTreeParameters (const JType< JEvt > &type)
static bool	operator< (const JTransmission &first, const JTransmission &second)
	Less-than operator for two transmissions. More...
static bool	operator== (const JTransmission &first, const JTransmission &second)
	Equals operator for two transmissions. More...
double	getVelocity (const double D, const double S, const double T)
	Get sound velocity according UNESCO equation. More...

Variables
static const double	TOAMIN_S = 0.0000000
	Minimal allowed time-of-arrival [s]. More...
static const double	TOAMAX_S = 0.6310912
	Maximal allowed time-of-arrival [s]. More...
static const JAttenuationLength	getAttenuationLength (13.2, 38.0, 8.0)
	Function object to calculate attenutation length. More...
static JEmitterID	getEmitterID
	Function object for emitter identification. More...
struct {
}	compare
	Auxiliary data structure to sort transmissions. More...
static JDetectorMechanics	getMechanics
	Function object to get string mechanics. More...
static const JSoundVelocity	getSoundVelocity (1541.0,-17.0e-3,-2000.0)
	Function object for velocity of sound. More...

Detailed Description

Auxiliary classes and methods for acoustic position calibration.

Author

mdejong

Typedef Documentation

typedef JGEOMETRY::JDetector JACOUSTICS::JGeometry

Type definition of detector geometry.

Definition at line 610 of file JGeometry.hh.

typedef JTOOLS::JRange<double> JACOUSTICS::JTimeRange

Type definition for time range (unit [s]).

Definition at line 19 of file JAcoustics/JTimeRange.hh.

Enumeration Type Documentation

enum JACOUSTICS::JFit_t

Enumeration for fit algorithms.

Enumerator
linear_t	Linear fit.
simplex_t	Simplex fit.
gandalf_t	Gandalf fit.

Definition at line 105 of file JKatoomba.hh.

              {
    linear_t      = 0,            //!< Linear  fit
    simplex_t,                    //!< Simplex fit
    gandalf_t                     //!< Gandalf fit
  };

Function Documentation

double JACOUSTICS::getQ ( const double  D_m, const double  f_kHz, const double  d_m  )

inline

Get relative quality for given frequency at given distance.

Parameters

D_m	depth [m]
f_kHz	frequency [kHz]
d_m	distance [m]

Returns

quality

Definition at line 92 of file JAcousticsSupportkit.hh.

  {
    return exp(-0.5 * d_m / getAttenuationLength(D_m, f_kHz)) / d_m;
  }

template<class T , class JTypename_t , class JComparator_t >

JVector3D JACOUSTICS::getPosition ( T  __begin, T  __end, const JPredicate< JTypename_t, JComparator_t > &  predicate  )

inline

Get position from element in data which corresponds to given predicate.

Parameters

__begin	begin of data
__end	end of data
predicate	predicate

Returns

position

Definition at line 37 of file JAcousticsToolkit.hh.

  {
    T p = std::find_if(__begin, __end, predicate);

    if (p != __end) 
      return p->getPosition();
    else
      THROW(JValueOutOfRange, "No element in container which corresponds to given predicate.");
  }

template<class T , class JTypename_t , class JComparator_t >

JVector3D JACOUSTICS::getPosition ( T  __begin, T  __end, const JPredicate< JTypename_t, JComparator_t > &  predicate, const JVector3D &  position  )

inline

Get position from element in data which corresponds to given predicate.

Parameters

__begin	begin of data
__end	end of data
predicate	predicate
position	default position

Returns

position

Definition at line 60 of file JAcousticsToolkit.hh.

  {
    try {
      return getPosition(__begin, __end, predicate);
    }
    catch(const std::exception&) {
      return position;
    }
  }

double JACOUSTICS::getUNIXTime ( const KM3NETDAQ::JDAQChronometer &  chronometer )

inline

Get UNIX time of given DAQ object.

Parameters

chronometer

chronometer

Returns

UNIX time [s]

Definition at line 80 of file JAcousticsToolkit.hh.

  {
    return chronometer.getTimesliceStart().getTimeNanoSecond() * 1.0e-9;
  }

static bool JACOUSTICS::operator< ( const JCounter &  first, const JCounter &  second  )

inlinestatic

Less-than operator for two counters.

Parameters

first	first counter
second	second counter

Returns

true if first counter less than second; else false

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

  {
    return first.getCounter() < second.getCounter();
  }

static bool JACOUSTICS::operator== ( const JCounter &  first, const JCounter &  second  )

inlinestatic

Equals operator for two counters.

Parameters

first	first counter
second	second counter

Returns

true if first counter equal to second; else false

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

  {
    return first.getCounter() == second.getCounter();
  }

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

inline

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

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

template<class T >

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

inline

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

bool JACOUSTICS::operator< ( const JHead &  first, const JHead &  second  )

inline

Less than operator for acoustics event headers.

The less than operator is applied to the object identifier, the UNIX start time and the UNIX stop time, respectively.

Parameters

first	first header
second	second header

Returns

true if first event header earliear than second; else false

Definition at line 184 of file JAcoustics/JEvt.hh.

  {
    if (first.oid == second.oid) {

      if (first.UNIXTimeStart == second.UNIXTimeStart) {

        return first.UNIXTimeStop  < second.UNIXTimeStop;

      } else {

        return first.UNIXTimeStart < second.UNIXTimeStart;
      }

    } else {

      return first.oid < second.oid;
    }
  }

double JACOUSTICS::getQuality ( const double  chi2, const int  NDF  )

inline

Get quality of fit.

The larger the quality, the better the fit.

Parameters

chi2	chi2
NDF	number of degrees of freedom

Returns

quality

Definition at line 29 of file JAcoustics/JEvtToolkit.hh.

  {
    return NDF  -  0.25 * chi2 / NDF;
  }

template<class T >

size_t JACOUSTICS::getNumberOfEmitters ( T  __begin, T  __end  )

inline

Get number of emitters.

Parameters

__begin	begin of events
__end	end of events

Returns

number of emitters

Definition at line 43 of file JAcoustics/JEvtToolkit.hh.

  {
    std::set<int> buffer;

    for (T i = __begin; i != __end; ++i) {
      if (!i->empty()) {
        buffer.insert(i->getID());
      }
    }

    return buffer.size();
  }

JMODEL::JString JACOUSTICS::getModel ( const JFit &  fit )

inline

Get model parameters of string.

Parameters

fit	fit parameters

Returns

model parameters

Definition at line 63 of file JAcoustics/JEvtToolkit.hh.

  {
    return JMODEL::JString(fit.tx, fit.ty, fit.tx2, fit.ty2, fit.vs);
  }

JFit JACOUSTICS::getFit ( const int  id, const JMODEL::JString &  string  )

inline

Get fit parameters of string.

Parameters

id	identifier
string	model parameters

Returns

fit parameters

Definition at line 76 of file JAcoustics/JEvtToolkit.hh.

  {
    return JFit(id, string.tx, string.ty, string.tx2, string.ty2, string.vs);
  }

JModel JACOUSTICS::getModel ( const JEvt &  evt )

inline

Get model of detector.

Parameters

evt

event

Returns

model

Definition at line 88 of file JAcoustics/JEvtToolkit.hh.

  {
    JModel model;

    for (JEvt::const_iterator i = evt.begin(); i != evt.end(); ++i) {
      model.string[i->id] = getModel(*i);
    }

    return model;
  }

JEvt JACOUSTICS::getEvt ( const JHead &  header, const JModel &  model  )

inline

Get event.

Parameters

header	header
model	model

Returns

event

Definition at line 107 of file JAcoustics/JEvtToolkit.hh.

  {
    JEvt evt(header);

    for (JModel::string_type::const_iterator i = model.string.begin(); i != model.string.end(); ++i) {
      evt.push_back(getFit(i->first, i->second));
    }

    return evt;
  }

template<class T >

double JACOUSTICS::getWeight ( T  __begin, T  __end  )

inline

Get total weight of data points.

Parameters

__begin	begin of data
__end	end of data

Returns

total weight

Definition at line 59 of file JKatoomba.hh.

  {
    double W = 0;

    for (T i = __begin; i != __end; ++i) {
      W += i->getWeight();
    }

    return W;
  }

JTreeParameters JACOUSTICS::getTreeParameters ( const JType< JEvent > &  type )

inline

Parameters

type

data type

Returns

TTree parameters

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

  {
    return JTreeParameters("ACOUSTICS", "acoustics_event", "",  2, 65536, 2);
  }

JTreeParameters JACOUSTICS::getTreeParameters ( const JType< JEvt > &  type )

inline

Parameters

type

data type

Returns

TTree parameters

Definition at line 43 of file JAcoustics/JSupport.hh.

  {
    return JTreeParameters("ACOUSTICS_FIT", "acoustics_fit", "",  2, 65536, 2);
  }

static bool JACOUSTICS::operator< ( const JTransmission &  first, const JTransmission &  second  )

inlinestatic

Less-than operator for two transmissions.

The less-than operator is first applied to the time-of-emission and then to the identifier.

Parameters

first	first transmission
second	second transmission

Returns

true if first transmission earlier than second; else false

Definition at line 244 of file JTransmission.hh.

  {
    if (first.getToE() == second.getToE())
      return first.getID()  < second.getID();
    else
      return first.getToE() < second.getToE();
  }

static bool JACOUSTICS::operator== ( const JTransmission &  first, const JTransmission &  second  )

inlinestatic

Equals operator for two transmissions.

The equal operator is applied to the time-of-emission and the identifier.

Parameters

first	first transmission
second	second transmission

Returns

true if first transmission equal to second; else false

Definition at line 262 of file JTransmission.hh.

  {
    return (first.getID()  == second.getID()   &&
            first.getToE() == second.getToE());
  }

double JACOUSTICS::getVelocity ( const double  D, const double  S, const double  T  )

inline

Get sound velocity according UNESCO equation.

Parameters

D	Depth [m]
S	Salinity [ppk]
T	Temperature [C]

Returns

sound velocity [m/s]

Definition at line 23 of file JUNESCO.hh.

  {
    return (1448.96
            + 4.591 * T
            - 5.304e-2  * T*T
            + 2.374e-4  * T*T*T
            + 1.340 * (S - 35)
            + 1.630e-2  * D
            + 1.675e-7  * D*D
            - 1.025e-2  * T * (S - 35)
            - 7.139e-13 * T*D*D*D);
  }

Variable Documentation

const double JACOUSTICS::TOAMIN_S = 0.0000000

static

Minimal allowed time-of-arrival [s].

Definition at line 20 of file JAcousticsSupportkit.hh.

const double JACOUSTICS::TOAMAX_S = 0.6310912

static

Maximal allowed time-of-arrival [s].

Definition at line 21 of file JAcousticsSupportkit.hh.

const JAttenuationLength JACOUSTICS::getAttenuationLength(13.2,38.0,8.0)

static

Function object to calculate attenutation length.

JEmitterID JACOUSTICS::getEmitterID

static

Function object for emitter identification.

Definition at line 119 of file JEmitterID.hh.

struct { ... } JACOUSTICS::compare

Auxiliary data structure to sort transmissions.

JDetectorMechanics JACOUSTICS::getMechanics

static

Function object to get string mechanics.

Definition at line 243 of file JMechanics.hh.

const JSoundVelocity JACOUSTICS::getSoundVelocity(1541.0,-17.0e-3,-2000.0)

static

Function object for velocity of sound.