Web.h

Go to the documentation of this file.

/*****************************************
 * This file is documented for Doxygen.
 * If you modify this file please update
 * the comments so that Doxygen will still
 * be able to work.
 ****************************************/
#ifndef WEB_H
#define WEB_H

#include <threadbaseclass.h>

#include <json.h>
#include <utility>
#include <string>
#include <tuple>
#include <memory>
#include <vector>
#include <mutex>
#include <thread>
#include <queue>
#include <map>
#include <atomic>

#include "TravelTime.h"
#include "ZoneStats.h"

namespace glasscore {

// forward declarations
class CSite;
class CSiteList;
class CNode;
class CPick;

class CWeb : public glass3::util::ThreadBaseClass {
 public:
    explicit CWeb(int numThreads = 0, int sleepTime = 100, int checkInterval =
                            300);

    CWeb(std::string name, double thresh, int numDetect, int numNucleate,
            int resolution, bool update, bool save, bool allowControllingWebs,
            std::shared_ptr<traveltime::CTravelTime> firstTrav,
            std::shared_ptr<traveltime::CTravelTime> secondTrav,
            int numThreads = 0, int sleepTime = 100, int checkInterval = 300,
            double aziTaper = 360.0, double maxDepth = 800.0,
            double aSeismicThresh = -1.0, int numASeismicNucleate = -1);

    ~CWeb();

    void clear() override;

    bool receiveExternalMessage(std::shared_ptr<json::Object> com);

    bool initialize(std::string name, double thresh, int numDetect,
                    int numNucleate, int resolution, bool update, bool save,
                    bool allowControllingWebs,
                    std::shared_ptr<traveltime::CTravelTime> firstTrav,
                    std::shared_ptr<traveltime::CTravelTime> secondTrav,
                    double aziTaper = 360.0, double maxDepth = 800.0,
                    double aSeismicThresh = -1.0, int numASeismicNucleate = -1);

    bool generateLocalGrid(std::shared_ptr<json::Object> gridConfiguration);

    bool generateExplicitGrid(std::shared_ptr<json::Object> gridConfiguration);

    bool generateGlobalGrid(std::shared_ptr<json::Object> gridConfiguration);

    bool loadGridConfiguration(std::shared_ptr<json::Object> gridConfiguration);

    bool loadTravelTimes(json::Object *gridConfiguration);

    bool loadFilters(std::shared_ptr<json::Object> gridConfiguration);

    bool loadWebSiteList();

    void sortSiteListForNode(double lat, double lon, double depth);

    bool addSiteToSiteList(std::shared_ptr<CSite> site);

    bool removeSiteFromSiteList(std::shared_ptr<CSite> site);

    std::shared_ptr<CNode> generateNode(double lat, double lon, double z,
                                        double resol);

    bool addNode(std::shared_ptr<CNode> node);

    std::shared_ptr<CNode> generateNodeSites(std::shared_ptr<CNode> node);

    void addSite(std::shared_ptr<CSite> site);

    void removeSite(std::shared_ptr<CSite> site);

    bool nodesHaveSite(std::shared_ptr<CSite> site);

    bool isSiteAllowed(std::shared_ptr<CSite> site, bool checkEnabled = true);

    void addJob(std::function<void()> newjob);

    double getAzimuthTaper() const;

    double getMaxDepth() const;

    const CSiteList* getSiteList() const;

    void setSiteList(CSiteList* siteList);

    bool getUpdate() const;

    bool getSaveGrid() const;

    bool getAllowControllingWebs() const;

    double getNodeResolution() const;

    double getNucleationStackThreshold() const;

    int getNumStationsPerNode() const;

    int getNucleationDataCountThreshold() const;

    const std::string& getName() const;

    const std::shared_ptr<traveltime::CTravelTime>& getNucleationTravelTime1() const;  // NOLINT

    const std::shared_ptr<traveltime::CTravelTime>& getNucleationTravelTime2() const;  // NOLINT

    int getNetworksFilterSize() const;

    int getSitesFilterSize() const;

    bool getUseOnlyTeleseismicStations() const;

    int size() const;

    glass3::util::WorkState work() override;

    bool getZoneStatsAseismic(double dLat, double dLon);

    double getZoneStatsMaxDepth(double dLat, double dLon);

    double getASeismicNucleationStackThreshold() const;

    int getASeismicNucleationDataCountThreshold() const;

    double isWithin(double dLat, double dLon);

 private:
    CSiteList * m_pSiteList;

    std::vector<std::string> m_vNetworksFilter;

    std::vector<std::string> m_vSitesFilter;

    std::vector<std::string> m_vSourcesFilter;

    std::atomic<bool> m_bUseOnlyTeleseismicStations;

    std::vector<std::pair<double, std::shared_ptr<CSite>>>m_vSitesSortedForCurrentNode;  // NOLINT

    std::vector<std::shared_ptr<CNode>> m_vNode;

    mutable std::mutex m_vNodeMutex;

    std::string m_sName;

    std::atomic<double> m_dMinLatitude;

    std::atomic<double> m_dMinLongitude;

    std::atomic<double> m_dHeight;

    std::atomic<double> m_dWidth;

    std::atomic<int> m_iNumStationsPerNode;

    std::atomic<int> m_iNucleationDataCountThreshold;

    std::atomic<double> m_dNucleationStackThreshold;

    std::atomic<double> m_dNodeResolution;

    std::atomic<double> m_dAzimuthTaper;

    std::atomic<double> m_dMaxDepth;

    std::atomic<double> m_dQualityFilter;

    std::atomic<double> m_dMaxSiteDistanceFilter;

    std::atomic<double> m_dDepthResolution;

    std::atomic<bool> m_bUpdate;

    std::atomic<bool> m_bSaveGrid;

    std::atomic<bool> m_bAllowControllingWebs;

    std::atomic<double> m_dASeismicNucleationStackThreshold;

    std::atomic<double> m_iASeismicNucleationDataCountThreshold;

    std::shared_ptr<traveltime::CTravelTime> m_pNucleationTravelTime1;

    std::shared_ptr<traveltime::CTravelTime> m_pNucleationTravelTime2;

    std::mutex m_vSiteMutex;

    std::queue<std::function<void()>> m_JobQueue;

    std::mutex m_QueueMutex;

    std::string m_sZoneStatsFileName;
    std::shared_ptr<traveltime::CZoneStats> m_pZoneStats;

    mutable std::recursive_mutex m_WebMutex;

    std::atomic<int> m_tLastUpdated;

    static constexpr double k_dAzimuthTaperDefault = 360.0;

    static constexpr double k_dDepthResolutionUndefined = -1.0;

    static constexpr double k_dFibonacciRatio = 1.6180339888;

    static const int k_iNodeLatitudeIndex = 0;

    static const int k_iNodeLongitudeIndex = 1;

    static const int k_iNodeDepthIndex = 2;

    static constexpr double k_dMinimumMaxNodeDepth = 50.0;
};
}  // namespace glasscore
#endif  // WEB_H