Jpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Functions | Variables
JACOUSTICS Namespace Reference

Classes

struct  JAbstractSoundVelocity
 Interface for velocity of sound. More...
 
struct  JCounter
 Acoustic counter. More...
 
struct  JEKey
 Emitter key. More...
 
struct  JEmitter
 Acoustic emitter. More...
 
struct  JEvent
 Acoustic event. More...
 
class  JEventOverlap
 Match of two events considering overlap in time. More...
 
struct  JGeometry
 Auxiliary data structure to encapsulate different geometries. More...
 
struct  JPDFGauss
 Custom probability density function of time-of-arrival. More...
 
struct  JHit
 Acoustics hit. More...
 
struct  JKatoomba_t
 Auxiliary base class for fit function of acoustic model. 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  JModel
 Model for fit to acoustics data. More...
 
struct  JReceiver
 Acoustic receiver. More...
 
struct  JSoundVelocity
 Implementation for velocity of sound. More...
 
struct  JTransceiver
 Acoustic transceiver. More...
 
struct  JTransmission
 Acoustic transmission. More...
 
class  JTriggerOutput
 Set of acoustics events. More...
 
struct  JTriggerParameters
 Trigger parameters. More...
 

Functions

JPosition3D getPiezoPosition ()
 Get relative position of piezo in optical module. More...
 
double getT0 (const JModule &module)
 Get time offset of optical module. More...
 
double getT0 (const JBase &base)
 Get time offset of base module. 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...
 
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...
 

Variables

static const double PIEZO_DELAYTIME_US = 170.0
 Piezo delay time [us]. More...
 
static const double HYDROPHONE_DELAYTIME_US = 50.0
 Hydrophone delay time [us]. More...
 
static const double TBARZ_M = 1.0
 T-bar position relative to seabed [m]. More...
 
static const JSoundVelocity getSoundVelocity (1541.0,-17.0e-3,-2000.0)
 Function object for velocity of sound. More...
 

Detailed Description

Author
mdejong

Function Documentation

JPosition3D JACOUSTICS::getPiezoPosition ( )
inline

Get relative position of piezo in optical module.

Returns
position [m]

Definition at line 30 of file JAcousticsSupportkit.hh.

31  {
32  return JPosition3D(0.0, 0.0, -0.20);
33  }
double JACOUSTICS::getT0 ( const JModule &  module)
inline

Get time offset of optical module.

Parameters
modulemodule
Returns
time offset [ns]

Definition at line 29 of file JAcousticsToolkit.hh.

30  {
31  double t0 = 0.0;
32 
33  if (!module.empty()) {
34 
35  for (JModule::const_iterator i = module.begin(); i != module.end(); ++i) {
36  t0 += i->getT0();
37  }
38 
39  t0 /= module.size();
40  }
41 
42  return t0;
43  }
double JACOUSTICS::getT0 ( const JBase &  base)
inline

Get time offset of base module.

Parameters
basebase
Returns
time offset [ns]

Definition at line 52 of file JAcousticsToolkit.hh.

53  {
54  return base.getT0();
55  }
static bool JACOUSTICS::operator< ( const JCounter first,
const JCounter second 
)
inlinestatic

Less-than operator for two counters.

Parameters
firstfirst counter
secondsecond counter
Returns
true if first counter less than second; else false

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

66  {
67  return first.getCounter() < second.getCounter();
68  }
int getCounter() const
Get counter.
static bool JACOUSTICS::operator== ( const JCounter first,
const JCounter second 
)
inlinestatic

Equals operator for two counters.

Parameters
firstfirst counter
secondsecond counter
Returns
true if first counter equal to second; else false

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

79  {
80  return first.getCounter() == second.getCounter();
81  }
int getCounter() const
Get counter.
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
firstfirst event
secondsecond event
Returns
true if first event earliear than second; else false

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

217  {
218  if (!first.empty() && !second.empty())
219  return first.begin()->getToE() < second.begin()->getToE();
220  else
221  return first.getCounter() < second.getCounter();
222  }
int getCounter() const
Get counter.
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
firstfirst transmission
secondsecond transmission
Returns
true if first transmission earlier than second; else false

Definition at line 156 of file JTransmission.hh.

157  {
158  if (first.getToE() == second.getToE())
159  return first.getID() < second.getID();
160  else
161  return first.getToE() < second.getToE();
162  }
double getToE() const
Get absolute time of emission.
int getID() const
Get identifier.
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
firstfirst transmission
secondsecond transmission
Returns
true if first transmission equal to second; else false

Definition at line 174 of file JTransmission.hh.

175  {
176  return (first.getID() == second.getID() &&
177  first.getToE() == second.getToE());
178  }
double getToE() const
Get absolute time of emission.
int getID() const
Get identifier.

Variable Documentation

const double JACOUSTICS::PIEZO_DELAYTIME_US = 170.0
static

Piezo delay time [us].

Definition at line 19 of file JAcousticsSupportkit.hh.

const double JACOUSTICS::HYDROPHONE_DELAYTIME_US = 50.0
static

Hydrophone delay time [us].

Definition at line 20 of file JAcousticsSupportkit.hh.

const double JACOUSTICS::TBARZ_M = 1.0
static

T-bar position relative to seabed [m].

Definition at line 22 of file JAcousticsSupportkit.hh.

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

Function object for velocity of sound.