Glass.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 GLASS_H
#define GLASS_H

#include <json.h>
#include <TTT.h>
#include <TravelTime.h>
#include <string>
#include <memory>
#include <atomic>
#include <vector>
namespace glasscore {

// forward declarations
class CWebList;
class CSiteList;
class CPickList;
class CHypoList;
class CDetection;
class CCorrelationList;
struct IGlassSend;

class CGlass {
 public:
    CGlass();

    ~CGlass();

    static void clear();

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

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

    static void setExternalInterface(glasscore::IGlassSend *newSend);

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

    static bool healthCheck();

    static double getBeamMatchingAzimuthWindow();

    static double getBeamMatchingDistanceWindow();

    static int getCorrelationCancelAge();

    static double getCorrelationMatchingTimeWindow();

    static double getCorrelationMatchingDistanceWindow();

    static double getHypoMergingTimeWindow();

    static double getHypoMergingDistanceWindow();

    static double getDistanceCutoffFactor();

    static double getMinDistanceCutoff();

    static double getDistanceCutoffRatio();

    static double getReportingStackThreshold();

    static double getNucleationStackThreshold();

    static double getPickAffinityExpFactor();

    static bool getGraphicsOut();

    static const std::string& getGraphicsOutFolder();

    static double getGraphicsStepKm();

    static int getGraphicsSteps();

    static int getProcessLimit();

    static bool getMinimizeTTLocator();

    static void setMinimizeTTLocator(bool use);

    static int getNumStationsPerNode();

    static int getNucleationDataCountThreshold();

    static int getReportingDataThreshold();

    static double getPickDuplicateTimeWindow();

    static double getAssociationSDCutoff();

    static double getPruningSDCutoff();

    static double getNonLocatingPhaseCutoffFactor();

    static double getTeleseismicDistanceLimit();

    static int getTeleseismicPhaseCountThreshold();

    static bool getTestLocator();

    static bool getTestTravelTimes();

    static int getMaxNumPicks();

    static void setMaxNumPicks(int max);

    static int getMaxNumCorrelations();

    static void setMaxNumCorrelations(int max);

    static void setMaxNumPicksPerSite(int max);

    static int getMaxNumHypos();

    static void setMaxNumHypos(int max);

    static double getEventFragmentDepthThreshold();

    static double getEventFragmentAzimuthThreshold();

    static bool getAllowPickUpdates();

    static double getPickNoiseClassificationThreshold();

    static double getPickPhaseClassificationThreshold();

    static double getPickDistanceClassificationThreshold();

    static double getDistanceClassUpperBound(double distClass);

    static double getDistanceClassLowerBound(double distClass);

    static double getPickAzimuthClassificationThreshold();

    static double getPickAzimuthClassificationUncertainty();

    static CCorrelationList* getCorrelationList();

    static CDetection* getDetectionProcessor();

    static CHypoList* getHypoList();

    static CPickList* getPickList();

    static CSiteList* getSiteList();

    static CWebList* getWebList();

    static std::shared_ptr<traveltime::CTravelTime>& getDefaultNucleationTravelTime();  // NOLINT

    static std::shared_ptr<traveltime::CTTT>& getAssociationTravelTimes();

    // constants
    static const int iMaxQueueLenPerThreadFactor = 10;

    static constexpr double k_dAssociationSecondsPerSigma = 1.0;

    static constexpr double k_dNucleationSecondsPerSigma = 5.0;

    static constexpr double k_dMaximumDepth = 800.0;

 private:
    static std::atomic<int> m_iNucleationDataCountThreshold;

    static std::atomic<double> m_dNucleationStackThreshold;

    static std::atomic<int> m_iNumStationsPerNode;

    static std::atomic<double> m_dAssociationSDCutoff;

    static std::atomic<double> m_dPruningSDCutoff;

    static std::atomic<double> m_dNonLocatingPhaseCutoffFactor;

        static std::atomic<double> m_dTeleseismicDistanceLimit;

        static std::atomic<int> m_iTeleseismicPhaseCountThreshold;

    static std::atomic<double> m_dPickAffinityExpFactor;

    static std::atomic<double> m_dDistanceCutoffFactor;

    static std::atomic<double> m_dDistanceCutoffRatio;

    static std::atomic<double> m_dMinDistanceCutoff;

    static std::atomic<int> m_iMaxNumPicks;

    static std::atomic<int> m_iMaxNumCorrelations;

    static std::atomic<int> m_iMaxNumHypos;

    static std::atomic<double> m_dPickDuplicateTimeWindow;

    static std::atomic<double> m_dCorrelationMatchingTimeWindow;

    static std::atomic<double> m_dCorrelationMatchingDistanceWindow;

    static std::atomic<double> m_dHypoMergingTimeWindow;

    static std::atomic<double> m_dHypoMergingDistanceWindow;

    static std::atomic<int> m_iCorrelationCancelAge;

    static std::atomic<double> m_dBeamMatchingAzimuthWindow;

    static std::atomic<double> m_dBeamMatchingDistanceWindow;

    static std::atomic<bool> m_bTestTravelTimes;

    static std::atomic<bool> m_bTestLocator;

    static std::atomic<bool> m_bGraphicsOut;

    static std::string m_sGraphicsOutFolder;

    static std::atomic<double> m_dGraphicsStepKM;

    static std::atomic<int> m_iGraphicsSteps;

    static std::atomic<int> m_iProcessLimit;

    static std::atomic<bool> m_bMinimizeTTLocator;

    static std::atomic<int> m_iReportingDataThreshold;

    static std::atomic<double> m_dReportingStackThreshold;

    static std::atomic<double> m_dEventFragmentDepthThreshold;

    static std::atomic<double> m_dEventFragmentAzimuthThreshold;

    static std::atomic<bool> m_bAllowPickUpdates;

    static std::atomic<double> m_dPickNoiseClassificationThreshold;

    static std::atomic<double> m_dPickPhaseClassificationThreshold;

    static std::atomic<double> m_dPickDistanceClassificationThreshold;

    static std::vector<double> m_dPickDistClassificationClasses;

    static std::vector<double> m_dPickDistClassificationClassesUpperBound;

    static std::vector<double> m_dPickDistClassificationClassesLowerBound;

    static std::atomic<double> m_dPickAzimuthClassificationThreshold;

    static std::atomic<double> m_dPickAzimuthClassificationUncertainty;

    static glasscore::IGlassSend *m_pExternalInterface;

    static CWebList * m_pWebList;

    static CSiteList * m_pSiteList;

    static CPickList * m_pPickList;

    static CHypoList * m_pHypoList;

    static CCorrelationList * m_pCorrelationList;

    static CDetection * m_pDetectionProcessor;

    static std::shared_ptr<traveltime::CTravelTime> m_pDefaultNucleationTravelTime;

    static std::shared_ptr<traveltime::CTTT> m_pAssociationTravelTimes;

    static std::mutex m_TTTMutex;

    // constants
    static const unsigned int k_nRangeArraySize = 4;

    static const unsigned int k_iTaperUpStart = 0;

    static const unsigned int k_iFullStart = 1;

    static const unsigned int k_iFullEnd = 2;

    static const unsigned int k_iTaperDownEnd = 3;

    static const unsigned int k_nAssocArraySize = 2;

    static const unsigned int k_iAssocRangeStart = 0;

    static const unsigned int k_iAssocRangeEnd = 1;

    static const unsigned int k_DefaultNumNucleationThreads = 5;

    static const unsigned int k_DefaultNumHypoThreads = 3;

    static const unsigned int k_DefaultNumWebThreads = 0;

    static const int k_nParamDisabled = -1;

    static const int k_DefaultHoursWithoutPicking = k_nParamDisabled;

    static const int k_DefaultHoursBeforeLookingUp = k_nParamDisabled;

    static const int k_DefaultMaxPicksPerHour = k_nParamDisabled;
};
}  // namespace glasscore
#endif  // GLASS_H