Predict.h

Go to the documentation of this file.

// Copyright (C) 2021 ASTRON (Netherlands Institute for Radio Astronomy)
// SPDX-License-Identifier: GPL-3.0-or-later
 
#ifndef DP3_STEPS_PREDICT_H_
#define DP3_STEPS_PREDICT_H_
 
#include "steps/Step.h"
 
#include <mutex>
 
namespace dp3 {
namespace common {
class ParameterSet;
}
 
namespace steps {
class BdaAverager;
 
class Predict : public ModelDataStep {
 public:
  Predict(const common::ParameterSet& parset, const std::string& prefix,
          MsType input_type = MsType::kRegular);
 
  Predict(const common::ParameterSet& parset, const std::string& prefix,
          const std::vector<std::string>& source_patterns,
          MsType input_type = MsType::kRegular);
 
  ~Predict() override {}
 
  common::Fields getRequiredFields() const override {
    // The actual work occurs in sub-steps, which come after Predict in the
    // step list.
    return {};
  }
 
  common::Fields getProvidedFields() const override {
    // The actual work occurs in sub-steps, which come after Predict in the
    // step list.
    return {};
  }
 
  bool process(std::unique_ptr<base::DPBuffer>) override;
 
  bool process(std::unique_ptr<base::BdaBuffer>) override;
 
  void finish() override;
 
  void show(std::ostream&) const override;
 
  void setNextStep(std::shared_ptr<Step> next_step) override;
 
  base::Direction GetFirstDirection() const override;
 
  void SetOperation(const std::string& operation);
 
  void updateInfo(const base::DPInfo&) override;
 
  bool accepts(MsType dt) const override { return dt == ms_type_; }
 
  MsType outputs() const override { return ms_type_; }
 
  void SetThreadData(std::mutex* mutex);
 
 private:
  void Initialize(const common::ParameterSet& parset, const std::string& prefix,
                  const std::vector<std::string>& source_patterns,
                  MsType input_type);
 
  const MsType ms_type_;
 
  bool use_fast_predict_{false};
 
  std::vector<std::shared_ptr<Step>> internal_steps_;
  std::shared_ptr<BdaAverager> bda_averager_;
  std::shared_ptr<ModelDataStep> predict_step_;
};
 
}  // namespace steps
}  // namespace dp3
 
#endif