JACOUSTICS::JWeight Struct Reference

Auxiliary data structure to unify weights of acoustics data according to the number of pings per emitter. More...

#include <JAcousticsToolkit.hh>

Inheritance diagram for JACOUSTICS::JWeight:

Public Member Functions
template<class T >
	JWeight (T __begin, T __end)
	Constructor. More...
double	operator() (const int id) const
	Get weight. More...

Static Public Member Functions
static bool	getUnify ()
	Get option to unify weights. More...
static void	setUnify (const bool unify)
	Set option to unify weights. More...

Static Private Member Functions
static bool &	get_unify ()
	Get option to unify weights. More...

Private Attributes
size_t	min

Detailed Description

Auxiliary data structure to unify weights of acoustics data according to the number of pings per emitter.

The default option is to unify the weights.

Definition at line 36 of file JAcousticsToolkit.hh.

Constructor & Destructor Documentation

JWeight()

template<class T >

JACOUSTICS::JWeight::JWeight ( T  __begin, T  __end  )

inline

Constructor.

Parameters

__begin	begin of data
__end	end of data

Definition at line 46 of file JAcousticsToolkit.hh.

                                :
      min(std::numeric_limits<size_t>::max())
    {
      for (T i = __begin; i != __end; ++i) {
        (*this)[i->getID()] += 1;
      }
 
      for (const_iterator i = this->begin(); i != this->end(); ++i) {
        if (i->second < min) {
          min = i->second;
        }
      }
    }

Member Function Documentation

getUnify()

static bool JACOUSTICS::JWeight::getUnify ( )

inlinestatic

Get option to unify weights.

Returns

option

Definition at line 66 of file JAcousticsToolkit.hh.

    {
      return get_unify();
    }

setUnify()

static void JACOUSTICS::JWeight::setUnify ( const bool  unify )

inlinestatic

Set option to unify weights.

Parameters

unify

option

Definition at line 77 of file JAcousticsToolkit.hh.

    {
      get_unify() = unify;
    }

operator()()

double JACOUSTICS::JWeight::operator() ( const int  id ) const

inline

Get weight.

Parameters

id	identifier

Returns

weight

Definition at line 89 of file JAcousticsToolkit.hh.

    {
      if (getUnify()) {
        
        const_iterator p = this->find(id);
 
        if (p != this->end())
          return (double) min / (double) p->second;
        else
          THROW(JValueOutOfRange, "Invalid identifier " << id);
 
      } else {
 
        return 1.0;
      }
    }

get_unify()

static bool& JACOUSTICS::JWeight::get_unify ( )

inlinestaticprivate

Get option to unify weights.

Returns

option

Definition at line 112 of file JAcousticsToolkit.hh.

    {
      static bool unify = true;
 
      return unify;
    }

Member Data Documentation

min

size_t JACOUSTICS::JWeight::min

private

Definition at line 119 of file JAcousticsToolkit.hh.

---

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

• JAcousticsToolkit.hh