JACOUSTICS Namespace Reference

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

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

Classes
struct	event_type
	Event. More...
struct	getEvt
	Auxiliary data structure to convert model to event. More...
struct	getModel
	Auxiliary data structure to convert event to model. More...
struct	getSuperEvt
	Auxiliary data structure to convert model to super event. More...
struct	hit_type
	Acoustic hit. More...
struct	JAbstractSoundVelocity
	Interface for depth dependend velocity of sound. More...
struct	JAttenuationLength
	Auxiliary data structure for calculation of attenuation length. More...
struct	JCheck
	Auxiliary data structure for final check on event. More...
struct	JConstantSoundVelocity
	Implementation for depth independend velocity of sound. More...
struct	JCounter
	Acoustic counter. More...
struct	JDetectorMechanics
	Auxiliary data structure for mechanical model parameters of strings in a given detector. 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 and position. More...
struct	JEvt
	Acoustic event fit. More...
struct	JFilenames
	Auxiliary data structure for handling of file names. More...
struct	JFit
	Acoustic single fit. More...
struct	JFitParameters
	Fit parameters. More...
class	JFremantle
	Thread pool for global fits. More...
class	JGandalf
	Place holder for custom implementation. More...
struct	JGlobalfit
	Global fit of prameterised detector geometry to acoustics data. More...
struct	JHead
	Acoustic event header. More...
struct	JHit
	Acoustics hit. More...
struct	JKatoomba
	Template definition of 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< JGandalf >
	Template specialisation of fit function of acoustic model based on JGandalf minimiser. More...
struct	JKatoomba< JSimplex >
	Template specialisation of fit function of acoustic model based on JSimplex minimiser. More...
struct	JKatoomba< JType >
	Auxiliary base class for fit function of acoustic model. More...
class	JMatch1D
	1D match criterion for acoustic signals. More...
class	JMatch3D
	3D match criterion for acoustic signals. More...
struct	JMechanics
	Auxiliary data structure for parameters of mechanical model. More...
struct	JModel
	Model for fit to acoustics data. More...
class	JPlatypus
	Thread pool for global fits using super events. More...
struct	JReceiver
	Acoustic receiver. More...
struct	JSetup
	Auxiliary data structure for setup of complete system. More...
struct	JSoundVelocity
	Implementation for depth dependend velocity of sound. More...
struct	JSuperEvt
	Acoustic super event fit. More...
struct	JSydney
	Main class for pre-calibration using acoustics data. More...
struct	JToA
	Time-of-arrival data from acoustic piezo sensor or hydrophone. 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	JVelo
	Vertex locator. More...
struct	JWaveform
	Utility class for emitter power and frequency. More...
struct	JWeight
	Auxiliary data structure to unify weights of acoustics data according to the number of pings per emitter. More...
struct	TMatrixDS
	Auxiliary data structure for compatibility of symmetric matrix. More...
struct	vertex_type
	Vertex. More...

Typedefs
typedef JGEOMETRY::JDetector	JGeometry
	Type definition of detector geometry.
typedef JContainer< std::vector< JTripod > >	tripods_container
typedef JContainer< std::vector< JHydrophone > >	hydrophones_container
typedef JContainer< std::vector< JTransmitter > >	transmitters_container
typedef JTOOLS::JRange< double >	JTimeRange
	Type definition for time range (unit [s]).
typedef JAbstractHistogram< double >	JHistogram_t
	Type definition for scan along axis.

Enumerations
enum	JMatrix_t { SVD_t = 1 , LDU_t = 2 }
	Algorithm for matrix inversion. 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.
int	getWaveformID (int id)
	Get waveform identifier.
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.
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.
double	getUNIXTime (const KM3NETDAQ::JDAQChronometer &chronometer)
	Get UNIX time of given DAQ object.
double	getQuality (const JEvent &evt)
	Get average quality.
static bool	operator< (const JCounter &first, const JCounter &second)
	Less-than operator for two counters.
static bool	operator== (const JCounter &first, const JCounter &second)
	Equals operator for two counters.
bool	operator< (const JHead &first, const JHead &second)
	Less than operator for acoustics event headers.
double	getQuality (const double chi2, const int NDF)
	Get quality of fit.
template<class T >
size_t	getNumberOfEmitters (T __begin, T __end)
	Get number of emitters.
template<class T >
size_t	getMinimumNumberOfEmitters (T __begin, T __end)
	Get minimum number of emitters for any string in data.
JMODEL::JString	getString (const JFit &fit)
	Get model parameters of string.
JFit	getFit (const int id, const JMODEL::JString &string)
	Get fit parameters of string.
template<class T >
double	getWeight (T __begin, T __end)
	Get total weight of data points.
JTreeParameters	getTreeParameters (const JType< JToA > &type)
JTreeParameters	getTreeParameters (const JType< JEvent > &type)
JTreeParameters	getTreeParameters (const JType< JEvt > &type)
JTreeParameters	getTreeParameters (const JType< JSuperEvt > &type)
static bool	operator< (const JTransmission &first, const JTransmission &second)
	Less-than operator for two transmissions.
static bool	operator== (const JTransmission &first, const JTransmission &second)
	Equals operator for two transmissions.
double	getGravity (const double phi)
	Get gravitational constant.
double	getVelocityMackenzie (const double D, const double S, const double T)
	Get sound velocity.
double	getVelocityCoppens (const double D, const double S, const double T)
	Get sound velocity.
double	getVelocityUNESCO (const double P, const double S, const double T)
	Get sound velocity.
double	getVelocityDelGrosso (const double p, const double S, const double T)
	Get sound velocity.
double	getDepth (const double P, const double phi, const bool option=true)
	Get depth.
double	getPressure (const double z, const double phi, const bool option=true)
	Get pressure.
void	print (std::ostream &out, const JEvent &event)
	Print event.

Variables
static const double	TOAMIN_S = 0.0000000
	Minimal allowed time-of-arrival [s].
static const double	TOAMAX_S = 0.6310912
	Maximal allowed time-of-arrival [s].
static const JAttenuationLength	getAttenuationLength (13.2, 38.0, 8.0)
	Function object to calculate attenutation length.
static JEmitterID	getEmitterID
	Function object for emitter identification.
static JDetectorMechanics	getMechanics
	Function object to get string mechanics.
static const JSoundVelocity	getSoundVelocity (1541.0, -17.0e-3, -2000.0)
	Function object for velocity of sound.
static const char	skip_t = '#'
	Script commands.
static const std::string	initialise_t = "initialise"
	initialise
static const std::string	fix_t = "fix"
	fix objects
static const std::string	string_t = "string"
	string
static const std::string	tripod_t = "tripod"
	tripod
static const std::string	stage_t = "stage"
	fit stage
constexpr double	ONE_TICK_IN_NS = 16E-9
constexpr double	SECOND_IN_NANOSECOND = 1E-9
constexpr double	SECOND_IN_MICROSECOND = 1E-6
constexpr int64_t	NANOSECONDS_IN_ONE_SECOND = 1000000000LL
constexpr int64_t	NANOSECONDS_IN_ONE_TICK = 16LL

Detailed Description

Auxiliary classes and methods for acoustic position calibration.

Author

mdejong

Typedef Documentation

JGeometry

typedef JGEOMETRY::JDetector JACOUSTICS::JGeometry

Type definition of detector geometry.

Definition at line 639 of file JGeometry.hh.

tripods_container

typedef JContainer< std::vector<JTripod> > JACOUSTICS::tripods_container

Definition at line 79 of file JSydney.cc.

hydrophones_container

typedef JContainer< std::vector<JHydrophone> > JACOUSTICS::hydrophones_container

Definition at line 80 of file JSydney.cc.

transmitters_container

typedef JContainer< std::vector<JTransmitter> > JACOUSTICS::transmitters_container

Definition at line 81 of file JSydney.cc.

JTimeRange

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

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

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

JHistogram_t

typedef JAbstractHistogram<double> JACOUSTICS::JHistogram_t

Type definition for scan along axis.

Definition at line 61 of file JBillabong.cc.

Enumeration Type Documentation

JMatrix_t

enum JACOUSTICS::JMatrix_t

Algorithm for matrix inversion.

Enumerator
SVD_t	SVD.
LDU_t	LDU.

Definition at line 345 of file JKatoomba_t.hh.

                 {
    SVD_t   =   1,      //!< SVD
    LDU_t   =   2       //!< LDU
  };

Function Documentation

getQ()

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

getWaveformID()

int JACOUSTICS::getWaveformID ( int id )

inline

Get waveform identifier.

Conform TriDASManager configuration of acoustic data filter (DAQ_ADF_DOM_configuration), private communication Cristiano Bozza.

Parameters

id	waveform identifier

Returns

waveform identifier

Definition at line 39 of file JAcousticsToolkit.hh.

  {
    if (id < 0)
      return -id - 1;
    else
      return  id;
  }

getPosition() [1/2]

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 149 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.");
  }

getPosition() [2/2]

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 172 of file JAcousticsToolkit.hh.

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

getUNIXTime()

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 192 of file JAcousticsToolkit.hh.

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

getQuality() [1/2]

double JACOUSTICS::getQuality ( const JEvent & evt )

inline

Get average quality.

Parameters

evt

event

Returns

quality

Definition at line 424 of file JAcousticsTriggerProcessor.cc.

  {
    double Q = 0.0;
 
    if (!evt.empty()) {
 
      for (const auto& i : evt) {
        Q += i.getQ();
      }
 
      Q /= evt.size();
    }
 
    return Q;
  }

operator<() [1/3]

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 99 of file JAcoustics/JCounter.hh.

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

operator==() [1/2]

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 112 of file JAcoustics/JCounter.hh.

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

operator<() [2/3]

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 282 of file JAcoustics/JEvt.hh.

  {
    if (first.detid == second.detid) {
 
      if (first.UNIXTimeStart == second.UNIXTimeStart) {
 
        return first.UNIXTimeStop  < second.UNIXTimeStop;
 
      } else {
 
        return first.UNIXTimeStart < second.UNIXTimeStart;
      }
 
    } else {
 
      return first.detid < second.detid;
    }
  }

getQuality() [2/2]

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 31 of file JAcoustics/JEvtToolkit.hh.

  {
    return NDF  -  0.25 * chi2 / NDF;
  }

getNumberOfEmitters()

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 45 of file JAcoustics/JEvtToolkit.hh.

  {
    using namespace std;
 
    set<int> buffer;
 
    for (T i = __begin; i != __end; ++i) {
      if (!i->empty()) {
        buffer.insert(i->getID());
      }
    }
 
    return buffer.size();
  }

getMinimumNumberOfEmitters()

template<class T >

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

inline

Get minimum number of emitters for any string in data.

Parameters

__begin	begin of events
__end	end of events

Returns

number of emitters

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

  {
    using namespace std;
 
    map<int, set<int> > buffer;
 
    for (T i = __begin; i != __end; ++i) {
      buffer[i->getString()].insert(i->getID());
    }
 
    if (!buffer.empty()) {
 
      size_t n = numeric_limits<size_t>::max();
 
      for (map<int, set<int> >::const_iterator i = buffer.begin(); i != buffer.end(); ++i) {
        if (i->second.size() < n) {
          n = i->second.size();
        }
      }
 
      return n;
    }
    
    return 0;
  }

getString()

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

inline

Get model parameters of string.

Parameters

fit	fit parameters

Returns

model parameters

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

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

getFit()

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 115 of file JAcoustics/JEvtToolkit.hh.

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

getWeight()

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 60 of file JKatoomba_t.hh.

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

getTreeParameters() [1/4]

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

inline

Parameters

type

data type

Returns

TTree parameters

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

  {
    return JTreeParameters("TOA", "toa", "", 2);
  }

getTreeParameters() [2/4]

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

inline

Parameters

type

data type

Returns

TTree parameters

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

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

getTreeParameters() [3/4]

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

inline

Parameters

type

data type

Returns

TTree parameters

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

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

getTreeParameters() [4/4]

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

inline

Parameters

type

data type

Returns

TTree parameters

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

  {
    return JTreeParameters("ACOUSTICS_SUPER_FIT", "acoustics_super_fit", "",  2, 65536, 2);
  }

operator<() [3/3]

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 288 of file JTransmission.hh.

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

operator==() [2/2]

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 306 of file JTransmission.hh.

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

getGravity()

double JACOUSTICS::getGravity ( const double phi )

inline

Get gravitational constant.

Parameters

phi	latitude [deg]

Returns

g [m/s^2]

Definition at line 25 of file JUNESCO.hh.

  {
    const double sd  = sin(phi * PI / 180.0);
    const double s2  = sd*sd;
    const double s4  = s2*s2;
 
    return 9.780318 * (1.0 + 5.2788e-3*s2 + 2.36e-5*s4);
  }

getVelocityMackenzie()

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

inline

Get sound velocity.

K.V. Mackenzie, Nine-term equation for the sound speed in the oceans (1981)
J. Acoust. Soc. Am. 70(3), pp 807-812

Parameters

D	depth [m]
S	salinity [ppk]
T	temperature [C]

Returns

sound velocity [m/s]

Definition at line 46 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);
  }

getVelocityCoppens()

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

inline

Get sound velocity.

A.B. Coppens, Simple equations for the speed of sound in Neptunian waters (1981)
J. Acoust. Soc. Am. 69(3), pp 862-863

Parameters

D	depth [m]
S	salinity [ppk]
T	temperature [C]

Returns

sound velocity [m/s]

Definition at line 71 of file JUNESCO.hh.

  {
    const double t = T * 0.1;
    const double d = D * 1.0e-3;
    const double c = 1449.05 + 45.7 * t - 5.21 * t*t + 0.23 * t*t*t + (1.333 - 0.126*t + 0.009 * t*t)*(S - 35);
 
    return (c + 
            (16.23 + 0.253*t) * d    + 
            (0.213 - 0.1*t)   * d*d  + 
            (0.016 + 0.0002*(S-35))*(S - 35)*t*d);
  }

getVelocityUNESCO()

double JACOUSTICS::getVelocityUNESCO ( const double P, const double S, const double T )

inline

Get sound velocity.

C-T. Chen and F.J. Millero, Speed of sound in seawater at high pressures (1977)
J. Acoust. Soc. Am. 62(5) pp 1129-1135

Parameters

P	pressure [bar]
S	salinity [ppk]
T	temperature [C]

Returns

sound velocity [m/s]

Definition at line 95 of file JUNESCO.hh.

  {
    const double A00  =         1.389;
    const double A01  =     -1.262E-2;
    const double A02  =      7.166E-5;
    const double A03  =      2.008E-6;
    const double A04  =      -3.21E-8;
    const double A10  =     9.4742E-5;
    const double A11  =    -1.2583E-5;
    const double A12  =    -6.4928E-8;
    const double A13  =     1.0515E-8;
    const double A14  =   -2.0142E-10;
    const double A20  =    -3.9064E-7;
    const double A21  =     9.1061E-9;
    const double A22  =   -1.6009E-10;
    const double A23  =     7.994E-12;
    const double A30  =     1.100E-10;
    const double A31  =     6.651E-12;
    const double A32  =    -3.391E-13;
    const double B00  =     -1.922E-2;
    const double B01  =      -4.42E-5;
    const double B10  =     7.3637E-5;
    const double B11  =     1.7950E-7;
    const double C00  =      1402.388;
    const double C01  =       5.03830;
    const double C02  =   -5.81090E-2;
    const double C03  =     3.3432E-4;
    const double C04  =   -1.47797E-6;
    const double C05  =     3.1419E-9;
    const double C10  =      0.153563;
    const double C11  =     6.8999E-4;
    const double C12  =    -8.1829E-6;
    const double C13  =     1.3632E-7;
    const double C14  =   -6.1260E-10;
    const double C20  =     3.1260E-5;
    const double C21  =    -1.7111E-6;
    const double C22  =     2.5986E-8;
    const double C23  =   -2.5353E-10;
    const double C24  =    1.0415E-12;
    const double C30  =    -9.7729E-9;
    const double C31  =    3.8513E-10;
    const double C32  =   -2.3654E-12;
    const double D00  =      1.727E-3;
    const double D10  =    -7.9836E-6;
 
    const double T2 = T  * T;
    const double T3 = T2 * T;
    const double T4 = T3 * T;
    const double T5 = T4 * T;
 
    const double P2 = P  * P;
    const double P3 = P2 * P;
 
    const double Cw =
      (C00 + C01 * T + C02 * T2 + C03 * T3 + C04 * T4 + C05 * T5) +
      (C10 + C11 * T + C12 * T2 + C13 * T3 + C14 * T4) * P        +
      (C20 + C21 * T + C22 * T2 + C23 * T3 + C24 * T4) * P2       +
      (C30 + C31 * T + C32 * T2) * P3;
 
    const double A =
      (A00 + A01 * T + A02 * T2 + A03 * T3 + A04 * T4)     +
      (A10 + A11 * T + A12 * T2 + A13 * T3 + A14 * T4) * P +
      (A20 + A21 * T + A22 * T2 + A23 * T3) * P2           +
      (A30 + A31 * T + A32 * T2) * P3;
 
    const double B = B00 + B01 * T + (B10 + B11 * T) * P;
 
    const double D = D00 + D10 * P;
 
    return Cw + A*S + B*S*sqrt(S) + D*S*S;
  }

getVelocityDelGrosso()

double JACOUSTICS::getVelocityDelGrosso ( const double p, const double S, const double T )

inline

Get sound velocity.

V.A. Del Grosso, New equation for the speed of sound in natural waters (with comparisons to other equations) (1974)
J. Acoust. Soc. Am 56(4) pp 1084-1091

G.S.K. Wong and S Zhu, Speed of sound in seawater as a function of salinity, temperature and pressure (1995)
J. Acoust. Soc. Am. 97(3) pp 1732-1736

Parameters

p	pressure [bar]
S	salinity [ppk]
T	temperature [C]

Returns

sound velocity [m/s]

Definition at line 182 of file JUNESCO.hh.

  {
    const double C000   =        1402.392;
    const double CT1    =     0.5012285E1;
    const double CT2    =    -0.551184E-1;
    const double CT3    =     0.221649E-3;
    const double CS1    =     0.1329530E1;
    const double CS2    =    0.1288598E-3;
    const double CP1    =       0.1560592;
    const double CP2    =    0.2449993E-4;
    const double CP3    =   -0.8833959E-8;
    const double CST    =   -0.1275936E-1;
    const double CTP    =    0.6353509E-2;
    const double CT2P2  =    0.2656174E-7;
    const double CTP2   =   -0.1593895E-5;
    const double CTP3   =    0.5222483E-9;
    const double CT3P   =   -0.4383615E-6;
    const double CS2P2  =   -0.1616745E-8;
    const double CST2   =    0.9688441E-4;
    const double CS2TP  =    0.4857614E-5;
    const double CSTP   =   -0.3406824E-3;
 
    // 1 bar = 100 kPa = 1.019716 kg/cm^2.
 
    const double f  = 1.019716;
    const double P  = p * f;
 
    const double T2 = T  * T;
    const double T3 = T2 * T;
 
    const double S2 = S  * S;
 
    const double P2 = P  * P;
    const double P3 = P2 * P;
 
    const double DCT   = CT1 * T + CT2 * T2 + CT3 * T3;
    const double DCS   = CS1 * S + CS2 * S2;
    const double DCP   = CP1 * P + CP2 * P2 + CP3 * P3;
    const double DCSTP = CTP * T*P + CT3P * T3*P + CTP2 * T*P2 + CT2P2 * T2*P2 + CTP3 * T*P3 + CST * S*T + CST2 * S*T2 + CSTP * S*T*P + CS2TP * S2*T*P + CS2P2 * S2*P2;
 
    return C000 + DCT + DCS + DCP + DCSTP;
  }

getDepth()

double JACOUSTICS::getDepth ( const double P, const double phi, const bool option = true )

inline

Get depth.

Claude C. Leroy and Francois Parthiot, Depth-pressure relationships in the oceans and seas
J. Acoust. Soc. Am. 103(3), pp 1346-1352

Parameters

P	pressure [MPa]
phi	latitude [deg]
option	option for Mediterranean

Returns

depth [m]

Definition at line 237 of file JUNESCO.hh.

  { 
    const double sd  = sin(phi * PI / 180.0);
    const double g   = 9.780318 * (1.0 + 5.2788e-3 * sd*sd + 2.363e-5 * sd*sd*sd*sd);
    const double z   = (9.72659e2 * P - 2.2512e-1 * P*P + 2.279e-4 * P*P*P - 1.82e-7 * P*P*P*P) / (g + 1.092e-4 * P);
    const double dz  = -7e-2 * P + 2e-3* (P*P);
 
    return z + (option ? dz : 0.0);
  }

getPressure()

double JACOUSTICS::getPressure ( const double z, const double phi, const bool option = true )

inline

Get pressure.

Claude C. Leroy and Francois Parthiot, Depth-pressure relationships in the oceans and seas
J. Acoust. Soc. Am. 103(3), pp 1346-1352

Parameters

z	depth [m]
phi	latitude [deg]
option	option for Mediterranean

Returns

pressure [MPa]

Definition at line 259 of file JUNESCO.hh.

  { 
    const double sd  = sin(phi * PI / 180.0);
    const double g   = 9.78031 * (1.0 + 5.3e-3 * sd*sd);
    const double h45 = 1.00818e-2 * z + 2.465e-8 * z*z - 1.25e-13 * z*z*z + 2.8e-19 * z*z*z*z;
    const double k   = (g - 2e-5*z) / (9.80612 - 2e-5 * z);
    const double dp  = -8.5e-6 * z + 1.4e-9 * z*z;
 
    return h45 * k - (option ? dp : 0.0);
  }

print()

void JACOUSTICS::print ( std::ostream & out, const JEvent & event )

inline

Print event.

Parameters

out	output stream
event	event

Definition at line 296 of file JBillabong.cc.

  {
    using namespace std;
    
    out << "event: " << setw(6) << event.getCounter() << ' ' << FIXED(12,2) << 0.5 * (event.begin()->getToA() + event.rbegin()->getToA()) << " [s] " << setw(4) << event.size() << endl;
  }

Variable Documentation

TOAMIN_S

const double JACOUSTICS::TOAMIN_S = 0.0000000

static

Minimal allowed time-of-arrival [s].

Definition at line 20 of file JAcousticsSupportkit.hh.

TOAMAX_S

const double JACOUSTICS::TOAMAX_S = 0.6310912

static

Maximal allowed time-of-arrival [s].

Definition at line 21 of file JAcousticsSupportkit.hh.

getAttenuationLength

const JAttenuationLength JACOUSTICS::getAttenuationLength(13.2, 38.0, 8.0) ( 13. 2, 38. 0, 8. 0 )

static

Function object to calculate attenutation length.

getEmitterID

JEmitterID JACOUSTICS::getEmitterID

static

Function object for emitter identification.

Definition at line 119 of file JEmitterID.hh.

getMechanics

JDetectorMechanics JACOUSTICS::getMechanics

static

Function object to get string mechanics.

Definition at line 242 of file JMechanics.hh.

getSoundVelocity

const JSoundVelocity JACOUSTICS::getSoundVelocity(1541.0, -17.0e-3, -2000.0) ( 1541. 0, -17.0e- 3, -2000. 0 )

static

Function object for velocity of sound.

skip_t

const char JACOUSTICS::skip_t = '#'

static

Script commands.

skip line

Definition at line 87 of file JSydney.cc.

initialise_t

const std::string JACOUSTICS::initialise_t = "initialise"

static

initialise

Definition at line 88 of file JSydney.cc.

fix_t

const std::string JACOUSTICS::fix_t = "fix"

static

fix objects

Definition at line 89 of file JSydney.cc.

string_t

const std::string JACOUSTICS::string_t = "string"

static

string

Definition at line 90 of file JSydney.cc.

tripod_t

const std::string JACOUSTICS::tripod_t = "tripod"

static

tripod

Definition at line 91 of file JSydney.cc.

stage_t

const std::string JACOUSTICS::stage_t = "stage"

static

fit stage

Definition at line 92 of file JSydney.cc.

ONE_TICK_IN_NS

double JACOUSTICS::ONE_TICK_IN_NS = 16E-9

constexpr

Definition at line 27 of file JToAImp.cc.

SECOND_IN_NANOSECOND

double JACOUSTICS::SECOND_IN_NANOSECOND = 1E-9

constexpr

Definition at line 28 of file JToAImp.cc.

SECOND_IN_MICROSECOND

double JACOUSTICS::SECOND_IN_MICROSECOND = 1E-6

constexpr

Definition at line 29 of file JToAImp.cc.

NANOSECONDS_IN_ONE_SECOND

int64_t JACOUSTICS::NANOSECONDS_IN_ONE_SECOND = 1000000000LL

constexpr

Definition at line 30 of file JToAImp.cc.

NANOSECONDS_IN_ONE_TICK

int64_t JACOUSTICS::NANOSECONDS_IN_ONE_TICK = 16LL

constexpr

Definition at line 31 of file JToAImp.cc.