ac-toolbox-shd-reader.h

Go to the documentation of this file.

/* WOSS - World Ocean Simulation System -
 * 
 * Copyright (C) 2009 2025 Federico Guerra
 * and regents of the SIGNET lab, University of Padova
 *
 * Author: Federico Guerra - WOSS@guerra-tlc.com
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */ 
 
 
#ifndef AC_TOOLBOX_RES_READER_DEFINITIONS_H
#define AC_TOOLBOX_RES_READER_DEFINITIONS_H
 
 
#include <fstream>
#include <memory>
#include <pressure-definitions.h>
#include <time-arrival-definitions.h>
#include "res-reader.h"
 
 
namespace woss {
  
    
  class ShdData {
 
    public:
 
    ShdData() = default;
 
    ~ShdData() = default;
    
    int32_t record_length = 0;
 
    std::unique_ptr<char[]> plot_type = nullptr;
 
    float frequency = 0.0;
 
    int32_t Ntheta = 0;
 
    std::unique_ptr<float[]> theta = nullptr;
 
    int32_t Nsd;
 
    std::unique_ptr<float[]> tx_depths = nullptr;
 
    int32_t Nrd = 0;
 
    std::unique_ptr<float[]> rx_depths = nullptr;
 
    int32_t Nrr = 0;
 
    std::unique_ptr<float[]> rx_ranges = nullptr;
 
    int32_t Nrx_per_range = 0;
 
    std::unique_ptr< std::complex<double>[] > press_values = nullptr;
 
    void initialize() { plot_type.reset(); Ntheta = 0; theta.reset(); Nrx_per_range = 0; record_length = 0; tx_depths.reset();
                        rx_depths.reset(); rx_ranges.reset(); Nrr = 0; Nrd = 0; Nsd = 0; press_values.reset(); frequency = 0.0; }
 
    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;
 
  };
 
  class ShdData_v1 {
 
    public:
 
    ShdData_v1() = default;
 
    ~ShdData_v1() = default;
 
    int32_t record_length = 0;
 
    std::unique_ptr< char[] > plot_type = nullptr;
 
    double frequency = 0.0;
 
    int32_t Nfreq = 0;
 
    std::unique_ptr< double[] > frequencies = nullptr;
 
    int32_t Ntheta = 0;
 
    std::unique_ptr< double[] > theta = nullptr;
 
    int32_t Nsd = 0;
 
    std::unique_ptr< float[] > tx_depths = nullptr;
 
    int32_t Nrd = 0;
 
    std::unique_ptr< float[] > rx_depths = nullptr;
 
    int32_t Nrr = 0;
 
    std::unique_ptr<double[]> rx_ranges = nullptr;
 
    int32_t Nrx_per_range = 0;
 
 
    double stabil_atten = 0.0;
 
    std::unique_ptr< std::complex<double>[] > press_values = nullptr;
 
    void initialize() { plot_type.reset(); frequency = 0.0; Nfreq = 0; frequencies.reset(); Ntheta = 0; 
                        theta.reset(); Nrx_per_range = 0; record_length = 0; tx_depths.reset(); stabil_atten = 0.0;
                        rx_depths.reset(); rx_ranges.reset(); Nrr = 0; Nrd = 0; Nsd = 0; press_values.reset(); }
 
    int getPressureIndex( double tx_freq, 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;
 
    int getIndex( double value, double array[], int32_t array_size ) const;
  };
 
  class ShdResReader : public ResReader {
 
    public:
 
    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; 
 
    protected:
 
    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;
 
    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();
 
  };
 
}
 
#endif /* AC_TOOLBOX_RES_READER_DEFINITIONS_H */