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 (const Woss &woss)

virtual	~ShdResReader () override=default

virtual bool	initialize () override

virtual std::unique_ptr< Pressure >	readAvgPressure (double frequency, double tx_depth, double start_rx_depth, double start_rx_range, double end_rx_depth, double end_rx_range) override

virtual std::unique_ptr< Pressure >	readPressure (double frequency, double tx_depth, double rx_depth, double rx_range) const override

virtual std::unique_ptr< TimeArr >	readTimeArr (double frequency, double tx_depth, double rx_depth, double rx_range) const override

Public Member Functions inherited from woss::ResReader
	ResReader (const Woss &woss)

virtual	~ResReader ()=default

const Woss &	getWossRef () const

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

std::string	getFileName () const

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_ref

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()

ShdResReader::ShdResReader ( const Woss & woss )

ShdResReader constructor

Parameters

woss	const pointer to a const Woss object

◆ ~ShdResReader()

virtual woss::ShdResReader::~ShdResReader ( )

overridevirtualdefault

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::BELLHOP_CREATOR_SHD_FILE_SYNTAX_0, woss::BELLHOP_CREATOR_SHD_FILE_SYNTAX_1, 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_ref.

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

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 ( )

overridevirtual

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(), and getShdHeader().

Here is the call graph for this function:

◆ readAvgPressure()

std::unique_ptr< Pressure > ShdResReader::readAvgPressure	(	double	frequency,
		double	tx_depth,
		double	start_rx_depth,
		double	start_rx_range,
		double	end_rx_depth,
		double	end_rx_range
	)

overridevirtual

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 std::unique_ptr to a valid Pressure value; a not valid Pressure if shd_file hasn't been read yet

Implements woss::ResReader.

References 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