Pick.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 PICK_H
#define PICK_H

#include <json.h>
#include <memory>
#include <string>
#include <vector>
#include <mutex>
#include <atomic>

namespace glasscore {

// forward declarations
class CSite;
class CHypo;
class CSiteList;
class CPickList;

class CPick {
 public:
    CPick();

    CPick(std::shared_ptr<CSite> pickSite, double pickTime,
            std::string pickIdString, double backAzimuth, double slowness);

    CPick(std::shared_ptr<CSite> pickSite, double pickTime,
            std::string pickIdString, std::string source, double backAzimuth,
            double slowness, std::string phase, double phaseProb, double distance,
            double distanceProb, double azimuth, double azimuthProb,
            double depth, double depthProb, double magnitude,
            double magnitudeProb);

    CPick(std::shared_ptr<json::Object> pick, CSiteList *pSiteList);

    ~CPick();

    void clear();

    bool initialize(std::shared_ptr<CSite> pickSite, double pickTime,
                    std::string pickIdString, std::string source,
                    double backAzimuth, double slowness, std::string phase,
                    double phaseProb, double distance, double distanceProb,
                    double azimuth, double azimuthProb, double depth,
                    double depthProb, double magnitude, double magnitudeProb);

    void addHypoReference(std::shared_ptr<CHypo> hyp, bool force = false);

    void removeHypoReference(std::shared_ptr<CHypo> hyp);

    void removeHypoReference(std::string pid);

    bool nucleate(CPickList* parentThread);

    double getBackAzimuth() const;

    double getSlowness() const;

    const std::shared_ptr<json::Object>& getJSONPick() const;

    const std::shared_ptr<CHypo> getHypoReference() const;

    const std::shared_ptr<CSite> getSite() const;

    const std::string& getPhaseName() const;

    const std::string& getID() const;

    double getTPick() const;

    void setTPick(double tPick);

    double getTSort() const;

    void setTSort(double newTSort);

    double getTInsertion() const;

    double getTFirstAssociation() const;

    double getTNucleation() const;

    const std::string& getClassifiedPhase() const;

    double getClassifiedPhaseProbability() const;

    double getClassifiedDistance() const;

    double getClassifiedDistanceProbability() const;

    double getClassifiedAzimuth() const;

    double getClassifiedAzimuthProbability() const;

    double getClassifiedDepth() const;

    double getClassifiedDepthProbability() const;

    double getClassifiedMagnitude() const;

    double getClassifiedMagnitudeProbability() const;

    const std::string& getSource() const;

 protected:
    void clearHypoReference();

    void setTFirstAssociation();

    void setTNucleation();

 private:
    std::weak_ptr<CSite> m_wpSite;

    std::weak_ptr<CHypo> m_wpHypo;

    std::string m_sPhaseName;

    std::string m_sID;

    std::string m_sSource;

    std::atomic<double> m_dBackAzimuth;

    std::atomic<double> m_dSlowness;

    std::atomic<double> m_tPick;

    std::string m_sClassifiedPhase;

    std::atomic<double> m_dClassifiedPhaseProbability;

    std::atomic<double> m_dClassifiedDistance;

    std::atomic<double> m_dClassifiedDistanceProbability;

    std::atomic<double> m_dClassifiedAzimuth;

    std::atomic<double> m_dClassifiedAzimuthProbability;

    std::atomic<double> m_dClassifiedDepth;

    std::atomic<double> m_dClassifiedDepthProbability;

    std::atomic<double> m_dClassifiedMagnitude;

    std::atomic<double> m_dClassifiedMagnitudeProbability;

    std::shared_ptr<json::Object> m_JSONPick;

    std::atomic<double> m_tSort;

    std::atomic<double> m_tInsertion;

    std::atomic<double> m_tFirstAssociation;

    std::atomic<double> m_tNucleation;

    mutable std::recursive_mutex m_PickMutex;

    // constants
    static const unsigned int k_nNucleateAnnealPasses = 3;

    static const unsigned int k_nNucleateNumberOfAnnealIterations = 20000;

    static constexpr double k_dNucleateInitialAnnealTimeStepSize = 10.0;

    static constexpr double k_dNucleateFinalAnnealTimeStepSize = 0.1;
};
}  // namespace glasscore
#endif  // PICK_H