Class for reading and manipulating results provided by any acoustic toolbox SHD file. More...

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

Inheritance diagram for woss::ShdResReader:

Collaboration diagram for woss::ShdResReader:

Public Member Functions
	ShdResReader ()

	ShdResReader (const Woss *const woss)

virtual bool	initialize ()

virtual Pressure *	readAvgPressure (double frequency, double tx_depth, double start_rx_depth, double start_rx_range, double end_rx_depth, double end_rx_range)

virtual Pressure *	readPressure (double frequency, double tx_depth, double rx_depth, double rx_range) const

virtual TimeArr *	readTimeArr (double frequency, double tx_depth, double rx_depth, double rx_range) const

Public Member Functions inherited from woss::ResReader
	ResReader ()

	ResReader (const Woss *const woss)

ResReader &	setWossPtr (const Woss *const woss)

const Woss *const	getWossPtr ()

ResReader &	setFileName (const ::std::string &name)

::std::string	getFileName ()

Protected Member Functions
::std::complex< double >	readMapAvgPressure (double frequency, double tx_depth, double start_rx_depth, double start_rx_range, double end_rx_depth, double end_rx_range, double theta=0.0)

::std::complex< double >	accessMap (double frequency, double tx_depth, double rx_depth, double rx_range, double theta=0.0) const

bool	getShdFile ()

bool	getShdHeader ()

Protected Attributes
bool	shd_header_collected

bool	shd_file_collected

::std::ifstream	file_reader

ShdData	shd_file

ShdData_v1	shd_file_v1

double	last_tx_depth

double	last_start_rx_depth

double	last_start_rx_range

double	last_end_rx_depth

double	last_end_rx_range

::std::complex< double >	last_ret_value

Protected Attributes inherited from woss::ResReader
const Woss *	woss_ptr

::std::string	file_name

Detailed Description

Class for reading and manipulating results provided by any acoustic toolbox SHD file.

Class ShdResReader stores Pressure provided by any acoustic toolbox SHD file in a ShdData. It also offers Pressure manipulation and TimeArr conversion methods.

Constructor & Destructor Documentation

◆ ShdResReader() [1/2]

ShdResReader::ShdResReader ( )

ShdResReader default constructor

◆ ShdResReader() [2/2]

ShdResReader::ShdResReader ( const Woss *const woss )

ShdResReader constructor

Parameters

woss	const pointer to a const Woss object

Member Function Documentation

◆ accessMap()

std::complex< double > ShdResReader::accessMap	(	double	frequency,
		double	tx_depth,
		double	rx_depth,
		double	rx_range,
		double	theta = `0.0`
	)		const

protected

Gets the Pressure value from ShdData Pressure array associated to given parameters

Parameters

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

Returns: a valid Pressure value; a not valid Pressure if shd_file hasn't been read yet

References woss::BellhopWoss::getBellhopShdSyntax(), woss::ShdData::getPressureIndex(), woss::ShdData_v1::getPressureIndex(), woss::Woss::getWossId(), woss::ShdData::press_values, woss::ShdData_v1::press_values, shd_file, shd_file_v1, and woss::ResReader::woss_ptr.

Referenced by readPressure(), and readTimeArr().

Here is the call graph for this function:

◆ getShdFile()

bool ShdResReader::getShdFile ( )

protected

Process the SHD file data

Returns: true if method was successful, false otherwise

References woss::ResReader::file_name, file_reader, woss::BellhopWoss::getBellhopShdSyntax(), woss::Pressure::getTxLossDb(), woss::Woss::getWossId(), woss::ShdData::Nrd, woss::ShdData_v1::Nrd, woss::ShdData::Nrr, woss::ShdData_v1::Nrr, woss::ShdData::Nrx_per_range, woss::ShdData_v1::Nrx_per_range, woss::ShdData::Nsd, woss::ShdData_v1::Nsd, woss::ShdData::Ntheta, woss::ShdData_v1::Ntheta, woss::ShdData::press_values, woss::ShdData_v1::press_values, woss::ShdData::record_length, woss::ShdData_v1::record_length, woss::ShdData::rx_depths, woss::ShdData_v1::rx_depths, woss::ShdData::rx_ranges, woss::ShdData_v1::rx_ranges, shd_file, shd_file_collected, shd_file_v1, woss::ShdData::tx_depths, woss::ShdData_v1::tx_depths, woss::Woss::usingDebug(), and woss::ResReader::woss_ptr.

Referenced by initialize().

Here is the call graph for this function:

◆ getShdHeader()

bool ShdResReader::getShdHeader ( )

protected

Process the SHD file header

Returns: true if method was successful, false otherwise

Referenced by initialize().

Here is the call graph for this function:

◆ initialize()

bool ShdResReader::initialize ( )

virtual

Initializes the ShdResReader object, reads SHD file, and stores read Pressure values

Returns: true if method was successful, false otherwise

Implements woss::ResReader.

References woss::ResReader::file_name, getShdFile(), getShdHeader(), and woss::ResReader::woss_ptr.

Here is the call graph for this function:

◆ readAvgPressure()

Pressure * ShdResReader::readAvgPressure	(	double	frequency,
		double	tx_depth,
		double	start_rx_depth,
		double	start_rx_range,
		double	end_rx_depth,
		double	end_rx_range
	)

virtual

Gets the average Pressure value in given rx range-depth box

Parameters

frequency	frequency [hZ]
tx_depth	transmitter depth [m]
start_rx_depth	start receiver depth [m]
start_rx_range	start receiver range [m]
end_rx_depth	end receiver depth [m]
end_rx_range	end receiver range [m]

Returns: a valid Pressure value; a not valid Pressure if shd_file hasn't been read yet

Implements woss::ResReader.

References woss::Pressure::create(), woss::Pressure::createNotValid(), woss::Singleton< T >::instance(), readMapAvgPressure(), and shd_file_collected.

Here is the call graph for this function:

◆ readMapAvgPressure()

std::complex< double > ShdResReader::readMapAvgPressure	(	double	frequency,
		double	tx_depth,
		double	start_rx_depth,
		double	start_rx_range,
		double	end_rx_depth,
		double	end_rx_range,
		double	theta = `0.0`
	)

protected

Gets the average Pressure value in given rx range-depth box from ShdData Pressure array

Parameters

frequency	frequency [hZ]
tx_depth	transmitter depth [m]
start_rx_depth	start receiver depth [m]
start_rx_range	start receiver range [m]
end_rx_depth	end receiver depth [m]
end_rx_range	end receiver range [m]
theta	theta value