Jpp 20.0.0-rc.9-29-gccc23c492-D
the software that should make you happy
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | Friends | List of all members
JACOUSTICS::JHit Struct Reference

Acoustics hit. More...

#include <JHit.hh>

Inheritance diagram for JACOUSTICS::JHit:
JACOUSTICS::JEmitter JACOUSTICS::JCounter

Public Member Functions

 JHit ()
 Default constructor.
 
 JHit (const JEmitter &emitter, const JCounter &counter, const JLocation &location, const double toa_s, const double sigma_s, const double weight)
 Constructor.
 
JEKey getEKey () const
 Get emitter hash key of this hit.
 
double getValue () const
 Get expectation value of time-of-arrival.
 
double getSigma () const
 Get resolution of time-of-arrival.
 
double getWeight () const
 Get weight.
 
const JEmittergetEmitter () const
 Get emitter.
 
int getCounter () const
 Get counter.
 
 ClassDefNV (JCounter, 1)
 

Protected Attributes

double toa
 
double sigma
 
double weight
 
int counter
 

Friends

std::ostream & operator<< (std::ostream &out, const JHit &hit)
 Write hit to output stream.
 

Detailed Description

Acoustics hit.

Definition at line 31 of file JHit.hh.

Constructor & Destructor Documentation

◆ JHit() [1/2]

JACOUSTICS::JHit::JHit ( )
inline

Default constructor.

Definition at line 39 of file JHit.hh.

40 {}

◆ JHit() [2/2]

JACOUSTICS::JHit::JHit ( const JEmitter & emitter,
const JCounter & counter,
const JLocation & location,
const double toa_s,
const double sigma_s,
const double weight )
inline

Constructor.

Parameters
emitteremitter
countercounter
locationreceiver location
toa_stime-of-arrival [s]
sigma_sresolution [s]
weightweight

Definition at line 53 of file JHit.hh.

58 :
59 JEmitter(emitter),
61 JLocation(location),
62 toa(toa_s),
63 sigma(sigma_s),
65 {}
JCounter()
Default constructor.
Definition JCounter.hh:30
JEmitter()
Default constructor.
Definition JEmitter.hh:34
double weight
Definition JHit.hh:138
double sigma
Definition JHit.hh:137

Member Function Documentation

◆ getEKey()

JEKey JACOUSTICS::JHit::getEKey ( ) const
inline

Get emitter hash key of this hit.

Returns
hash key

Definition at line 73 of file JHit.hh.

74 {
75 return JEKey(getID(), getCounter());
76 }
int getCounter() const
Get counter.
Definition JCounter.hh:50

◆ getValue()

double JACOUSTICS::JHit::getValue ( ) const
inline

Get expectation value of time-of-arrival.

Returns
time-of-arrival [s]

Definition at line 84 of file JHit.hh.

85 {
86 return toa;
87 }

◆ getSigma()

double JACOUSTICS::JHit::getSigma ( ) const
inline

Get resolution of time-of-arrival.

Returns
resulution [s]

Definition at line 95 of file JHit.hh.

96 {
97 return sigma;
98 }

◆ getWeight()

double JACOUSTICS::JHit::getWeight ( ) const
inline

Get weight.

Returns
weight

Definition at line 106 of file JHit.hh.

107 {
108 return weight;
109 }

◆ getEmitter()

const JEmitter & JACOUSTICS::JEmitter::getEmitter ( ) const
inlineinherited

Get emitter.

Returns
emitter

Definition at line 57 of file JEmitter.hh.

58 {
59 return static_cast<const JEmitter&>(*this);
60 }

◆ getCounter()

int JACOUSTICS::JCounter::getCounter ( ) const
inlineinherited

Get counter.

Returns
counter

Definition at line 50 of file JCounter.hh.

51 {
52 return counter;
53 }

◆ ClassDefNV()

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

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream & out,
const JHit & hit )
friend

Write hit to output stream.

Parameters
outoutput stream
hithit
Returns
output stream

Definition at line 119 of file JHit.hh.

120 {
121 using namespace std;
122 using namespace JPP;
123
124 out << setw(3) << hit.getID() << ' '
125 << setw(3) << hit.getCounter() << ' '
126 << getLabel(hit.getLocation())
127 << FIXED(20,5) << hit.getValue() << ' '
128 << FIXED(9,6) << hit.getSigma() << ' '
129 << FIXED(6,2) << hit.getWeight();
130
131 return out;
132 }

Member Data Documentation

◆ toa

double JACOUSTICS::JHit::toa
protected

Definition at line 136 of file JHit.hh.

◆ sigma

double JACOUSTICS::JHit::sigma
protected

Definition at line 137 of file JHit.hh.

◆ weight

double JACOUSTICS::JHit::weight
protected

Definition at line 138 of file JHit.hh.

◆ counter

int JACOUSTICS::JCounter::counter
protectedinherited

Definition at line 88 of file JCounter.hh.


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