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

#include <ac-toolbox-arr-bin-reader.h>

Inheritance diagram for woss::ArrBinResReader:

Collaboration diagram for woss::ArrBinResReader:

Public Member Functions
	ArrBinResReader (const Woss &woss)
virtual	~ArrBinResReader () 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
const TimeArr &	accessMap (double frequency, double tx_depth, double rx_depth, double rx_range) const
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)
bool	getArrBinHeader ()
bool	getArrBinFile ()

Protected Attributes
bool	arr_bin_header_collected
bool	arr_bin_file_collected
std::ifstream	file_reader
std::streampos	skip_header
ArrData	arr_file
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 binary ARR file.

Class ArrAscResReader stores TimeArr provided by any acoustic toolbox binary ARR file in a ArrStruct. It also offers TimeArr manipulation and Pressure conversion methods.

Constructor & Destructor Documentation

◆ ArrBinResReader()

ArrBinResReader::ArrBinResReader ( const Woss & woss )

ArrBinResReader constructor

Parameters

woss	const pointer to a const Woss object

References arr_bin_file_collected, arr_bin_header_collected, arr_file, file_reader, last_end_rx_depth, last_end_rx_range, last_ret_value, last_start_rx_depth, last_start_rx_range, last_tx_depth, woss::ResReader::ResReader(), and skip_header.

Here is the call graph for this function:

◆ ~ArrBinResReader()

virtual woss::ArrBinResReader::~ArrBinResReader ( )

overridevirtualdefault

Member Function Documentation

◆ accessMap()

const TimeArr & woss::ArrBinResReader::accessMap	(	double	frequency,
		double	tx_depth,
		double	rx_depth,
		double	rx_range ) const

inlineprotected

Gets the TimeArr value from ArrData TimeArr 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]

Returns: a valid TimeArr value; a not valid TimeArr if arr_file hasn't been read yet

References arr_file.

Referenced by readTimeArr().

◆ getArrBinFile()

bool ArrBinResReader::getArrBinFile ( )

protected

Process the ARR file data

Returns: true if method was successful, false otherwise

References arr_bin_file_collected, arr_bin_header_collected, arr_file, woss::BELLHOP_CREATOR_ARR_FILE_SYNTAX_0, woss::BELLHOP_CREATOR_ARR_FILE_SYNTAX_1, woss::BELLHOP_CREATOR_ARR_FILE_SYNTAX_2, woss::DefHandler::createPressure(), woss::ResReader::file_name, file_reader, woss::BellhopWoss::getBellhopArrSyntax(), woss::Pressure::getTxLossDb(), woss::Singleton< DefHandler >::instance(), skip_header, and woss::ResReader::woss_ref.

Referenced by initialize().

Here is the call graph for this function:

◆ getArrBinHeader()

bool ArrBinResReader::getArrBinHeader ( )

protected

Process the ARR file header

Returns: true if method was successful, false otherwise

References arr_bin_header_collected, arr_file, woss::BELLHOP_CREATOR_ARR_FILE_SYNTAX_2, woss::DefHandler::createTimeArrArray(), woss::ResReader::file_name, file_reader, woss::BellhopWoss::getBellhopArrSyntax(), woss::Singleton< DefHandler >::instance(), skip_header, and woss::ResReader::woss_ref.

Referenced by initialize().

Here is the call graph for this function:

◆ initialize()

bool ArrBinResReader::initialize ( )

overridevirtual

Initializes the ArrBinResReader object, reads ARR file, and stores read TimeArr values

Returns: true if method was successful, false otherwise

Implements woss::ResReader.

References woss::ResReader::file_name, getArrBinFile(), getArrBinHeader(), and woss::ResReader::woss_ref.

Here is the call graph for this function:

◆ readAvgPressure()

std::unique_ptr< Pressure > ArrBinResReader::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. Returned Pressure is the coherent sum of the computed average TimeArr

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 arr_file hasn't been read yet

Implements woss::ResReader.

References arr_bin_file_collected, woss::Pressure::createNotValid(), woss::DefHandler::createPressure(), woss::Singleton< DefHandler >::instance(), and readMapAvgPressure().

Here is the call graph for this function:

◆ readMapAvgPressure()

std::complex< double > ArrBinResReader::readMapAvgPressure	(	double	frequency,
		double	tx_depth,
		double	start_rx_depth,
		double	start_rx_range,
		double	end_rx_depth,
		double	end_rx_range )

protected

Gets the average Pressure value in given rx range-depth box converted from ArrStruct TimeArr 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]