guideStarHelper.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2020-2025 European Southern Observatory (ESO)
//
// SPDX-License-Identifier: LGPL-3.0-only

#ifndef HLCC_TELIF_ELTPK_GUIDESTARHELPER_HPP
#define HLCC_TELIF_ELTPK_GUIDESTARHELPER_HPP
 
#include <string>
#include <vector>
 
#include <config-ng/ciiConfigApi.hpp>
#include "Ccsinsif.hpp"
 
 
namespace hlcc::eltpk {

class GuideStarHelper {
 public:

    struct ParamMetadata {
        std::string units;
        std::string comment;
    };

    struct GuideStarMetadata {
        ParamMetadata position_ra;
        ParamMetadata position_dec;
        ParamMetadata proper_motion_ra;
        ParamMetadata proper_motion_dec;
        ParamMetadata epoch;
        ParamMetadata parallax;
        ParamMetadata radvel;
        ParamMetadata rshift;
        ParamMetadata magnitude;
        ParamMetadata band;
    };

    struct GuideStarItemData {
        double      position_ra;
        double      position_dec;
        double      proper_motion_ra;
        double      proper_motion_dec;
        std::string epoch;
        double      parallax;
        double      radvel;
        double      rshift;
        double      magnitude;
        std::string band;
    };

    struct GuideStars {
        GuideStarMetadata guide_star_metadata;          /* Metadata*/
        std::vector<GuideStarItemData> guide_star_data; /* Data as vector*/
    };

    GuideStarHelper();

    virtual ~GuideStarHelper();

    void InitGuideStarConfigYaml();

    void AddGuideStar(const ::ccscommonif::GuideStarData &guide_star_data);

     std::string GetGuideStarConfigYaml();

     static GuideStars FromYamlToGuideStars(const std::string &yaml_guide_stars);
 
 private:
 
    std::string m_guide_star_yaml; /* String that holds the Guide Star Yaml configuration */
    int m_guide_star_count;       /* Number of guide start already in the configuration */
};

std::ostream& operator<< (std::ostream& stream, const GuideStarHelper::GuideStars& guide_star);
 
 
}  // namespace hlcc::eltpk
 
#endif  // HLCC_TELIF_ELTPK_GUIDESTARHELPER_HPP