woss::ShdData Class Reference

class for storing data of any acoustic toolbox SHD file More...

#include <ac-toolbox-shd-reader.h>

Collaboration diagram for woss::ShdData:

Public Member Functions
	~ShdData ()
void	initialize ()
int	getPressureIndex (double tx_depth, double rx_depth, double rx_range, double theta=0.0) const
int	getIndex (float value, float *array, int32_t array_size) const

Public Attributes
int32_t	record_length
char *	plot_type
float	frequency
int32_t	Ntheta
float *	theta
int32_t	Nsd
float *	tx_depths
int32_t	Nrd
float *	rx_depths
int32_t	Nrr
float *	rx_ranges
int32_t	Nrx_per_range
::std::complex< double > *	press_values

Detailed Description

class for storing data of any acoustic toolbox SHD file

class ShdData stores Pressure provided by any acoustic toolbox SHD file

Constructor & Destructor Documentation

~ShdData()

woss::ShdData::~ShdData ( )

inline

Destructor

References press_values, rx_depths, rx_ranges, theta, and tx_depths.

Member Function Documentation

getIndex()

int ShdData::getIndex	(	float	value,
		float *	array,
		int32_t	array_size
	)		const

Returns the index of given array associated to given value

Parameters

value	test value
array	valid pointer to an array
array_size	size of passed array

Returns

valid array index value

Referenced by getPressureIndex().

getPressureIndex()

int ShdData::getPressureIndex	(	double	tx_depth,
		double	rx_depth,
		double	rx_range,
		double	theta = 0.0
	)		const

Returns the press_values index associated to given parameters

Parameters

tx_depth	transmitter depth [m]
rx_depth	receiver depth [m]
rx_range	receiver range [m]
theta	theta value

Returns

valid press_values index value

References getIndex(), Nrr, Nrx_per_range, Nsd, Ntheta, rx_depths, rx_ranges, theta, and tx_depths.

Referenced by woss::ShdResReader::accessMap(), and woss::ShdResReader::readMapAvgPressure().

Here is the call graph for this function:

initialize()

void woss::ShdData::initialize ( )

inline

Initializes the struct

References frequency, Nrd, Nrr, Nrx_per_range, Nsd, Ntheta, plot_type, press_values, record_length, rx_depths, rx_ranges, theta, and tx_depths.

Member Data Documentation

frequency

float woss::ShdData::frequency

Frequency value [Hz]

Referenced by woss::ShdResReader::getShdHeader(), and initialize().

Nrd

int32_t woss::ShdData::Nrd

Total number of receiver depths

Referenced by woss::ShdResReader::getShdFile(), woss::ShdResReader::getShdHeader(), and initialize().

Nrr

int32_t woss::ShdData::Nrr

Total number of receiver ranges

Referenced by getPressureIndex(), woss::ShdResReader::getShdFile(), woss::ShdResReader::getShdHeader(), and initialize().

Nrx_per_range

int32_t woss::ShdData::Nrx_per_range

Total number of receiver per range

Referenced by getPressureIndex(), woss::ShdResReader::getShdFile(), woss::ShdResReader::getShdHeader(), and initialize().

Nsd

int32_t woss::ShdData::Nsd

Total number of transmitter depths

Referenced by getPressureIndex(), woss::ShdResReader::getShdFile(), woss::ShdResReader::getShdHeader(), and initialize().

Ntheta

int32_t woss::ShdData::Ntheta

Total number of theta values. See Bellhop code for more info

Referenced by getPressureIndex(), woss::ShdResReader::getShdFile(), woss::ShdResReader::getShdHeader(), and initialize().

plot_type

char* woss::ShdData::plot_type

Plot typename. See Bellhop code for more info

Referenced by woss::ShdResReader::getShdHeader(), and initialize().

press_values

::std::complex<double>* woss::ShdData::press_values

Pointer to an array of complex<double> values [m]

Referenced by woss::ShdResReader::accessMap(), woss::ShdResReader::getShdFile(), woss::ShdResReader::getShdHeader(), initialize(), woss::ShdResReader::readMapAvgPressure(), and ~ShdData().

record_length

int32_t woss::ShdData::record_length

Record byte length of a binary SHD file. See Bellhop code for more info

Referenced by woss::ShdResReader::getShdFile(), woss::ShdResReader::getShdHeader(), and initialize().

rx_depths

float* woss::ShdData::rx_depths

Pointer to an array of receiver depths [m]

Referenced by getPressureIndex(), woss::ShdResReader::getShdFile(), woss::ShdResReader::getShdHeader(), initialize(), and ~ShdData().

rx_ranges

float* woss::ShdData::rx_ranges

Pointer to an array of receiver ranges [m]

Referenced by getPressureIndex(), woss::ShdResReader::getShdFile(), woss::ShdResReader::getShdHeader(), initialize(), and ~ShdData().

theta

float* woss::ShdData::theta

Pointer to an array of theta values

Referenced by getPressureIndex(), woss::ShdResReader::getShdHeader(), initialize(), and ~ShdData().

tx_depths

float* woss::ShdData::tx_depths

Pointer to an array of transmitter depths [m]

Referenced by getPressureIndex(), woss::ShdResReader::getShdFile(), woss::ShdResReader::getShdHeader(), initialize(), and ~ShdData().

---

The documentation for this class was generated from the following files:

• woss/ac-toolbox-shd-reader.h
• woss/ac-toolbox-shd-reader.cpp