SourceDBUtil.h

Go to the documentation of this file.

// SourceDBUtil.h: Helper functions to extract patch and source information
// from a SourceDB.
//
// Copyright (C) 2022 ASTRON (Netherlands Institute for Radio Astronomy)
// SPDX-License-Identifier: GPL-3.0-or-later
 
 
#ifndef DP3_BASE_SOURCEDBUTIL_H_
#define DP3_BASE_SOURCEDBUTIL_H_
 
#include <string>
#include <string_view>
#include <variant>
#include <vector>
 
#include "parmdb/SourceDB.h"
#include "parmdb/SourceDBSkymodel.h"
 
#include "Patch.h"
 
namespace dp3 {
namespace model {
 
inline bool HasSkymodelExtension(const std::string &source_db_name) {
  static const std::string_view kSymodelExtension = ".skymodel";
  static const std::string_view kTxtExtension = ".txt";
  return (source_db_name.size() >= kSymodelExtension.size() &&
          std::equal(kSymodelExtension.rbegin(), kSymodelExtension.rend(),
                     source_db_name.rbegin())) ||
         (source_db_name.size() >= kTxtExtension.size() &&
          std::equal(kTxtExtension.rbegin(), kTxtExtension.rend(),
                     source_db_name.rbegin()));
}
 
std::vector<std::shared_ptr<Patch>> makePatches(
    parmdb::SourceDB &sourceDB, const std::vector<std::string> &patchNames,
    unsigned int nModel);
 
std::vector<std::shared_ptr<Patch>> MakePatches(
    const parmdb::SourceDBSkymodel &source_db,
    const std::vector<std::string> &patch_names);
 
std::vector<
    std::pair<std::shared_ptr<base::ModelComponent>, std::shared_ptr<Patch>>>
makeSourceList(std::vector<std::shared_ptr<Patch>> &patchList);
 
void SetPatchIndices(std::vector<std::shared_ptr<Patch>> &patch_list);
 
std::vector<std::shared_ptr<Patch>> makeOnePatchPerComponent(
    const std::vector<std::shared_ptr<Patch>> &);
 
std::vector<std::shared_ptr<Patch>> clusterProximateSources(
    const std::vector<std::shared_ptr<Patch>> &patchList,
    double proximityLimit);
 
std::vector<std::string> makePatchList(parmdb::SourceDB &sourceDB,
                                       std::vector<std::string> patterns);
 
std::vector<std::string> MakePatchList(
    const parmdb::SourceDBSkymodel &source_db,
    const std::vector<std::string> &patterns);
 
std::vector<std::vector<std::string>> MakeDirectionList(
    const std::vector<std::string> &packed_directions,
    const std::string &source_db_filename);
 
bool checkPolarized(parmdb::SourceDB &sourceDB,
                    const std::vector<std::string> &patchNames,
                    unsigned int nModel);
 
bool CheckPolarized(const parmdb::SourceDBSkymodel &source_db,
                    const std::vector<std::string> &patch_names);
 
bool CheckAnyOrientationIsAbsolute(const parmdb::SourceDBSkymodel &source_db,
                                   const std::vector<std::string> &patch_names);
 
bool CheckAnyOrientationIsAbsolute(const parmdb::SourceDBSkymodel &source_db,
                                   const std::vector<std::string> &patch_names);
 
class SourceDBWrapper {
 public:
  enum class FilterMode {
    kPattern,
    kValue
  };
 
  explicit SourceDBWrapper(const std::string &source_db_name);
 
  SourceDBWrapper &Filter(const std::vector<std::string> &filter,
                          FilterMode filter_mode);
 
  std::vector<std::shared_ptr<Patch>> MakePatchList();
 
  bool CheckPolarized();
 
  bool CheckAnyOrientationIsAbsolute();
 
 private:
  std::vector<std::string> patch_names_;
  std::variant<std::monostate, parmdb::SourceDB, parmdb::SourceDBSkymodel>
      source_db_;
 
  template <class T>
  T &Get() {
    return std::get<T>(source_db_);
  }
 
  template <class T>
  bool HoldsAlternative() const {
    return std::holds_alternative<T>(source_db_);
  }
};
 
}  // namespace model
}  // namespace dp3
 
#endif