ssSonar.h

Go to the documentation of this file.

// Copyright JRM Enterprises, Inc. 2004
// All rights reserved.
//
// This code is the intellectual property of JRM Enterprises, Inc.
// It may not be used or released as source or compiled binary form
// without the prior written consent of JRM Enterprises, Inc.
//

#ifndef _ssSonar_
#define _ssSonar_

#include "ssEnvironment.h"
#include "ssObject.h"
#include "ssdllexport.h"

#include "Sonar.h"

// class: ssSonar
//
// description: sonar methods for generation of LOS acoustic return
//
class SIGSIMRT_API ssSonar
{
public:
 //   typedef std::map<int, ssObject *> ObjectMap;

    //ssSonar
    ssSonar();

    //~ssSonar
    ~ssSonar();


    // ssSonar::SetTransducerByMALOSonarCode
    //
    // code=1: SQS510HullMount              Halifax hull mount active
    // code=2: TAKRHullMount                T-AR Bob Hope hull mount active
    // code=3: TMS118AD                     CH148 dipper active
    // code=4: CP140SonoBuoy                CP-140 Sonobuoy
    // code=5: CP140LF                      CP-140 LF active
    // code=6: SINTRA2040HullMount          Victoria Hull Mount passive
    // code=7: CANTASSSQR501TowedArray      Halifax Towed Array passive
    // code=8: CANTASS2046TowedArray        Victoria Towed Array passive
    // code=9: DICASS62A                    
    // code=10: DICASS62B
    // code=11: DICASS62C
    // code=12: DICASS62D
    //
    void SetTransducerByMALOSonarCode(int code, ACOUSTIC_TRANSDUCER *transduce);

    // CalculateSourceLevelAndDirectivities
    //
    // Calculates Source Level (*SL), transmitter Directivity Index (*DIT), and receiver Directivity Index (*DI) in [dB]
    // at particular direction totargetFRD in transducer source's FRD frame.
    // 
    int CalculateSourceLevelAndDirectivities(ACOUSTIC_TRANSDUCER source, VECTOR totargetFRD, double *SL, double *DIT, double *DI);

    // LoadTS_DATABASE
    //        
    // Loads ATAS target strength database from disk. Assumes filenames are sent in via target_filelist.
    //
    int LoadTS_DATABASE(TS_DATABASE *tsd, char *target_filelist, char *sigsim_data_dir);

    // FreeTS_DATABASE
    //        
    // Frees ATAS target strength database.
    //
    void FreeTS_DATABASE(TS_DATABASE *tsd, jrmbool init);

    // LoadSubsurface1DProfile
    //        
    // Loads underwater pressure/temp/salinity profile from file on disk.
    //
    int LoadSubsurface1DProfile(char *file, SUBSURFACE_1DPROFILE *seadata);

    // FreeSubsurface1DProfile
    //        
    // Frees underwater pressure/temp/salinity profile.
    //
    void FreeSUBSURFACE_1DPROFILE(SUBSURFACE_1DPROFILE *seadata, jrmbool init);

    // AcousticPropagator
    //        
    // Calculates 1-way transmission loss, noise level, and reverberation level between two points.
    //
    // INPUTS :
    // E defines the Earth ellipsoid so that proper ranges and angles can be calculated
    // seadata gives the subsurface depths and physical properties (pressure, temp, salinity) at each depth
    // plc gives the sensor/target geometry
    // freq_khz [kHz] gives the frequency of interest
    // SL [dB] is the source power level (applicable only for active requests, and if the propagator supports reverberation)
    // OUTPUTS :
    // TL [dB] is the 1-way transmission loss between sensor and target
    // NL [dB] is the noise level
    // RL [dB] is the reverberation level (if supported)
    // delay_sec [s] is the propagation time
    //
    int AcousticPropagator(ellipsoid E, SUBSURFACE_1DPROFILE seadata, ST_PLACEMENT plc, double freq_khz, double SL, double *TL, double *NL, double *RL, double *delay_sec);


    // CalcSTGeometry
    //
    // Calculates range and LOS angles w.r.t. each position, based on ST_PLACEMENT input.
    //
    // range [m] source-target range
    // totargetFRD [unitless cosines] direction to target in sensor's FRD frame
    // tosourceFRD [unitless cosines] direction to source in target's FRD frame
    //
    void CalcSTGeometry(ST_PLACEMENT *plc);

    // CalculateTargetStrength
    //
    // Returns Target Strength (*TS) from ATAS target strength database, according to request parameters tsr.
    //
    int CalculateTargetStrength(TS_DATABASE tsd, TS_REQUEST tsr, double *TS);

    // SignalExcess
    //
    // Returns SE = Signal Excess [dB] , given the following :
    // SL = Signal Level [dB] 
    // DIT= Source Directivity Index [dB] 
    // DI = Receiver (hydrophone) Directivity Index [dB] 
    // TS = Target Strength [dB] 
    // TL1= 1-way Transmission Loss [dB] TO TARGET 
    // TL2= 1-way Transmission Loss [dB] FROM TARGET 
    // RL = Reverberation Level [dB]
    // NL = Noise Level [dB] 
    // RD = Recognition Differential [dB] = Threshold for detection, really. Depends on signal processing.
    //
    double SignalExcess(double SL, double DIT, double DI, double TL1, double TL2, double TS, double RL, double NL, double RD);

    // SonarAcquisitionStatus
    //
    // Returns acquisition status based on Signal Excess SE
    // 0 = no detect
    // 1 = detect
    // 2 = classify
    // 3 = recognize
    // 4 = identify
    //
    int SonarAcquisitionStatus(double SE, double *DSEED);      

    // SonarAcquisitionStatusKnownThresholds
    //
    // Returns acquisition status based on Signal Excess SE
    // 0 = no detect
    // 1 = detect
    // 2 = classify
    // 3 = recognize
    // 4 = identify
    //
    int SonarAcquisitionStatusKnownThresholds(double SE, double ThreshDetect, double ThreshClassify, double ThreshRecognize, double ThreshIdentify);

    // helpers

    //setEnvironment
    void setEnvironment(ssEnvironment *env);

    //*getEnvironment
    ssEnvironment *getEnvironment();

private:

    //setNumberObjects
    void setNumberObjects(unsigned int num);

    //getNumberObjects
    unsigned int getNumberObjects();

    //setObjectMap
 //   void setObjectMap(ObjectMap map);

    //setTerrain
    void setTerrain(ssObject *obj);

//    ObjectMap m_objectMap;
    unsigned int m_numberObjects;

    ssEnvironment *m_environment;

    ssObject *m_terrain;

    friend class SigSimRT;

};



#endif // _ssSonar_